blob: 3572f3f631c7f900fd0cc6660107a9c2327cb705 [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,
2740 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2741 mbedtls_ssl_async_resume_t *f_async_resume,
2742 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002744{
2745 conf->f_async_sign_start = f_async_sign;
2746 conf->f_async_decrypt_start = f_async_decrypt;
2747 conf->f_async_resume = f_async_resume;
2748 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002749 conf->p_async_config_data = async_config_data;
2750}
2751
Gilles Peskine449bd832023-01-11 14:50:10 +01002752void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002753{
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002755}
2756
Gilles Peskine449bd832023-01-11 14:50:10 +01002757void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002758{
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 if (ssl->handshake == NULL) {
2760 return NULL;
2761 } else {
2762 return ssl->handshake->user_async_ctx;
2763 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002764}
2765
Gilles Peskine449bd832023-01-11 14:50:10 +01002766void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2767 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002768{
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002770 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002772}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002773#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002774
Paul Bakker5121ce52009-01-03 21:22:43 +00002775/*
2776 * SSL get accessors
2777 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002778uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002779{
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 if (ssl->session != NULL) {
2781 return ssl->session->verify_result;
2782 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002783
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 if (ssl->session_negotiate != NULL) {
2785 return ssl->session_negotiate->verify_result;
2786 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002789}
2790
Gilles Peskine449bd832023-01-11 14:50:10 +01002791int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002792{
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 if (ssl == NULL || ssl->session == NULL) {
2794 return 0;
2795 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002796
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002798}
2799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002801{
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 if (ssl == NULL || ssl->session == NULL) {
2803 return NULL;
2804 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002805
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002807}
2808
Gilles Peskine449bd832023-01-11 14:50:10 +01002809const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002810{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002811#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2813 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002814 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002816 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002818 }
2819 }
2820#endif
2821
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002823 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002825 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002827 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002829 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002830}
2831
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002832#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2833
2834size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2835{
2836 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2837 size_t record_size_limit = max_len;
2838
2839 if (ssl->session != NULL &&
2840 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2841 ssl->session->record_size_limit < max_len) {
2842 record_size_limit = ssl->session->record_size_limit;
2843 }
2844
2845 // TODO: this is currently untested
2846 /* During a handshake, use the value being negotiated */
2847 if (ssl->session_negotiate != NULL &&
2848 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2849 ssl->session_negotiate->record_size_limit < max_len) {
2850 record_size_limit = ssl->session_negotiate->record_size_limit;
2851 }
2852
2853 return record_size_limit;
2854}
2855#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2856
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002857#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002858size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002859{
David Horstmann95d516f2021-05-04 18:36:56 +01002860 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002861 size_t read_mfl;
2862
Jerry Yuddda0502022-12-01 19:43:12 +08002863#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002864 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2866 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2867 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002868 }
Jerry Yuddda0502022-12-01 19:43:12 +08002869#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002870
2871 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 if (ssl->session_out != NULL) {
2873 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2874 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002875 max_len = read_mfl;
2876 }
2877 }
2878
Jerry Yuddda0502022-12-01 19:43:12 +08002879 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 if (ssl->session_negotiate != NULL) {
2881 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2882 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002883 max_len = read_mfl;
2884 }
2885 }
2886
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002888}
2889
Gilles Peskine449bd832023-01-11 14:50:10 +01002890size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002891{
2892 size_t max_len;
2893
2894 /*
2895 * Assume mfl_code is correct since it was checked when set
2896 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002898
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002899 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 if (ssl->session_out != NULL &&
2901 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2902 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002903 }
2904
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002905 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 if (ssl->session_negotiate != NULL &&
2907 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2908 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002909 }
2910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002912}
2913#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2914
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002915#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002916size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002917{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002918 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2920 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2921 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2922 return 0;
2923 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002924
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2926 return ssl->mtu;
2927 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002928
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 if (ssl->mtu == 0) {
2930 return ssl->handshake->mtu;
2931 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002932
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 return ssl->mtu < ssl->handshake->mtu ?
2934 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002935}
2936#endif /* MBEDTLS_SSL_PROTO_DTLS */
2937
Gilles Peskine449bd832023-01-11 14:50:10 +01002938int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002939{
2940 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2941
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002942#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002943 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002944 !defined(MBEDTLS_SSL_PROTO_DTLS)
2945 (void) ssl;
2946#endif
2947
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002948#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002950
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002952 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002954#endif
2955
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002956#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2957 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
2958
2959 if (max_len > record_size_limit) {
2960 max_len = record_size_limit;
2961 }
2962#endif
2963
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002964 if (ssl->transform_out != NULL &&
2965 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00002966 /*
2967 * In TLS 1.3 case, when records are protected, `max_len` as computed
2968 * above is the maximum length of the TLSInnerPlaintext structure that
2969 * along the plaintext payload contains the inner content type (one byte)
2970 * and some zero padding. Given the algorithm used for padding
2971 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
2972 * the plaintext payload. Round down to a multiple of
2973 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
2974 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002975 */
2976 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
2977 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
2978 }
2979
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002980#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
2982 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
2983 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002984 const size_t overhead = (size_t) ret;
2985
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 if (ret < 0) {
2987 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002988 }
2989
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 if (mtu <= overhead) {
2991 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
2992 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2993 }
2994
2995 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002996 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002998 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002999#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003000
Hanno Becker0defedb2018-08-10 12:35:02 +01003001#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003002 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3003 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003004 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003005#endif
3006
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003008}
3009
Gilles Peskine449bd832023-01-11 14:50:10 +01003010int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003011{
3012 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3013
3014#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3015 (void) ssl;
3016#endif
3017
3018#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003020
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003022 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003024#endif
3025
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003027}
3028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003030const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003031{
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 if (ssl == NULL || ssl->session == NULL) {
3033 return NULL;
3034 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003035
Hanno Beckere6824572019-02-07 13:18:46 +00003036#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003038#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003040#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003041}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003043
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003044#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003045int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3046 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003047{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003048 int ret;
3049
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003051 dst == NULL ||
3052 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003055 }
3056
Hanno Beckere810bbc2021-05-14 16:01:05 +01003057 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3058 * idempotent: Each session can only be exported once.
3059 *
3060 * (This is in preparation for TLS 1.3 support where we will
3061 * need the ability to export multiple sessions (aka tickets),
3062 * which will be achieved by calling mbedtls_ssl_get_session()
3063 * multiple times until it fails.)
3064 *
3065 * Check whether we have already exported the current session,
3066 * and fail if so.
3067 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 if (ssl->session->exported == 1) {
3069 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3070 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003071
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3073 if (ret != 0) {
3074 return ret;
3075 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003076
3077 /* Remember that we've exported the session. */
3078 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003080}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003082
David Horstmanncb01b362024-02-29 17:31:46 +00003083#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3084
3085/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003086 *
David Horstmanncb01b362024-02-29 17:31:46 +00003087 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003088 */
3089static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3090 unsigned char *buf,
3091 size_t buf_len)
3092{
3093 unsigned char *p = buf;
3094 size_t used = 0;
3095
3096#if defined(MBEDTLS_HAVE_TIME)
3097 uint64_t start;
3098#endif
3099#if defined(MBEDTLS_X509_CRT_PARSE_C)
3100#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3101 size_t cert_len;
3102#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3103#endif /* MBEDTLS_X509_CRT_PARSE_C */
3104
3105 /*
3106 * Time
3107 */
3108#if defined(MBEDTLS_HAVE_TIME)
3109 used += 8;
3110
3111 if (used <= buf_len) {
3112 start = (uint64_t) session->start;
3113
3114 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3115 p += 8;
3116 }
3117#endif /* MBEDTLS_HAVE_TIME */
3118
3119 /*
3120 * Basic mandatory fields
3121 */
3122 used += 1 /* id_len */
3123 + sizeof(session->id)
3124 + sizeof(session->master)
3125 + 4; /* verify_result */
3126
3127 if (used <= buf_len) {
3128 *p++ = MBEDTLS_BYTE_0(session->id_len);
3129 memcpy(p, session->id, 32);
3130 p += 32;
3131
3132 memcpy(p, session->master, 48);
3133 p += 48;
3134
3135 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3136 p += 4;
3137 }
3138
3139 /*
3140 * Peer's end-entity certificate
3141 */
3142#if defined(MBEDTLS_X509_CRT_PARSE_C)
3143#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3144 if (session->peer_cert == NULL) {
3145 cert_len = 0;
3146 } else {
3147 cert_len = session->peer_cert->raw.len;
3148 }
3149
3150 used += 3 + cert_len;
3151
3152 if (used <= buf_len) {
3153 *p++ = MBEDTLS_BYTE_2(cert_len);
3154 *p++ = MBEDTLS_BYTE_1(cert_len);
3155 *p++ = MBEDTLS_BYTE_0(cert_len);
3156
3157 if (session->peer_cert != NULL) {
3158 memcpy(p, session->peer_cert->raw.p, cert_len);
3159 p += cert_len;
3160 }
3161 }
3162#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3163 if (session->peer_cert_digest != NULL) {
3164 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3165 if (used <= buf_len) {
3166 *p++ = (unsigned char) session->peer_cert_digest_type;
3167 *p++ = (unsigned char) session->peer_cert_digest_len;
3168 memcpy(p, session->peer_cert_digest,
3169 session->peer_cert_digest_len);
3170 p += session->peer_cert_digest_len;
3171 }
3172 } else {
3173 used += 2;
3174 if (used <= buf_len) {
3175 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3176 *p++ = 0;
3177 }
3178 }
3179#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3180#endif /* MBEDTLS_X509_CRT_PARSE_C */
3181
3182 /*
3183 * Session ticket if any, plus associated data
3184 */
3185#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3186#if defined(MBEDTLS_SSL_CLI_C)
3187 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3188 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3189
3190 if (used <= buf_len) {
3191 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3192 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3193 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3194
3195 if (session->ticket != NULL) {
3196 memcpy(p, session->ticket, session->ticket_len);
3197 p += session->ticket_len;
3198 }
3199
3200 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3201 p += 4;
3202 }
3203 }
3204#endif /* MBEDTLS_SSL_CLI_C */
3205#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3206 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3207 used += 8;
3208
3209 if (used <= buf_len) {
3210 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3211 p += 8;
3212 }
3213 }
3214#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3215#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3216
3217 /*
3218 * Misc extension-related info
3219 */
3220#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3221 used += 1;
3222
3223 if (used <= buf_len) {
3224 *p++ = session->mfl_code;
3225 }
3226#endif
3227
3228#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3229 used += 1;
3230
3231 if (used <= buf_len) {
3232 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3233 }
3234#endif
3235
3236 return used;
3237}
3238
3239MBEDTLS_CHECK_RETURN_CRITICAL
3240static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3241 const unsigned char *buf,
3242 size_t len)
3243{
3244#if defined(MBEDTLS_HAVE_TIME)
3245 uint64_t start;
3246#endif
3247#if defined(MBEDTLS_X509_CRT_PARSE_C)
3248#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3249 size_t cert_len;
3250#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3251#endif /* MBEDTLS_X509_CRT_PARSE_C */
3252
3253 const unsigned char *p = buf;
3254 const unsigned char * const end = buf + len;
3255
3256 /*
3257 * Time
3258 */
3259#if defined(MBEDTLS_HAVE_TIME)
3260 if (8 > (size_t) (end - p)) {
3261 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3262 }
3263
3264 start = MBEDTLS_GET_UINT64_BE(p, 0);
3265 p += 8;
3266
3267 session->start = (time_t) start;
3268#endif /* MBEDTLS_HAVE_TIME */
3269
3270 /*
3271 * Basic mandatory fields
3272 */
3273 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3274 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3275 }
3276
3277 session->id_len = *p++;
3278 memcpy(session->id, p, 32);
3279 p += 32;
3280
3281 memcpy(session->master, p, 48);
3282 p += 48;
3283
3284 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3285 p += 4;
3286
3287 /* Immediately clear invalid pointer values that have been read, in case
3288 * we exit early before we replaced them with valid ones. */
3289#if defined(MBEDTLS_X509_CRT_PARSE_C)
3290#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3291 session->peer_cert = NULL;
3292#else
3293 session->peer_cert_digest = NULL;
3294#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3295#endif /* MBEDTLS_X509_CRT_PARSE_C */
3296#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3297 session->ticket = NULL;
3298#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3299
3300 /*
3301 * Peer certificate
3302 */
3303#if defined(MBEDTLS_X509_CRT_PARSE_C)
3304#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3305 /* Deserialize CRT from the end of the ticket. */
3306 if (3 > (size_t) (end - p)) {
3307 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3308 }
3309
3310 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3311 p += 3;
3312
3313 if (cert_len != 0) {
3314 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3315
3316 if (cert_len > (size_t) (end - p)) {
3317 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3318 }
3319
3320 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3321
3322 if (session->peer_cert == NULL) {
3323 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3324 }
3325
3326 mbedtls_x509_crt_init(session->peer_cert);
3327
3328 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3329 p, cert_len)) != 0) {
3330 mbedtls_x509_crt_free(session->peer_cert);
3331 mbedtls_free(session->peer_cert);
3332 session->peer_cert = NULL;
3333 return ret;
3334 }
3335
3336 p += cert_len;
3337 }
3338#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3339 /* Deserialize CRT digest from the end of the ticket. */
3340 if (2 > (size_t) (end - p)) {
3341 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3342 }
3343
3344 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3345 session->peer_cert_digest_len = (size_t) *p++;
3346
3347 if (session->peer_cert_digest_len != 0) {
3348 const mbedtls_md_info_t *md_info =
3349 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3350 if (md_info == NULL) {
3351 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3352 }
3353 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3354 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3355 }
3356
3357 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3358 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3359 }
3360
3361 session->peer_cert_digest =
3362 mbedtls_calloc(1, session->peer_cert_digest_len);
3363 if (session->peer_cert_digest == NULL) {
3364 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3365 }
3366
3367 memcpy(session->peer_cert_digest, p,
3368 session->peer_cert_digest_len);
3369 p += session->peer_cert_digest_len;
3370 }
3371#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3372#endif /* MBEDTLS_X509_CRT_PARSE_C */
3373
3374 /*
3375 * Session ticket and associated data
3376 */
3377#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3378#if defined(MBEDTLS_SSL_CLI_C)
3379 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3380 if (3 > (size_t) (end - p)) {
3381 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3382 }
3383
3384 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3385 p += 3;
3386
3387 if (session->ticket_len != 0) {
3388 if (session->ticket_len > (size_t) (end - p)) {
3389 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3390 }
3391
3392 session->ticket = mbedtls_calloc(1, session->ticket_len);
3393 if (session->ticket == NULL) {
3394 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3395 }
3396
3397 memcpy(session->ticket, p, session->ticket_len);
3398 p += session->ticket_len;
3399 }
3400
3401 if (4 > (size_t) (end - p)) {
3402 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3403 }
3404
3405 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3406 p += 4;
3407 }
3408#endif /* MBEDTLS_SSL_CLI_C */
3409#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3410 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3411 if (8 > (size_t) (end - p)) {
3412 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3413 }
3414 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3415 p += 8;
3416 }
3417#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3418#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3419
3420 /*
3421 * Misc extension-related info
3422 */
3423#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3424 if (1 > (size_t) (end - p)) {
3425 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3426 }
3427
3428 session->mfl_code = *p++;
3429#endif
3430
3431#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3432 if (1 > (size_t) (end - p)) {
3433 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3434 }
3435
3436 session->encrypt_then_mac = *p++;
3437#endif
3438
3439 /* Done, should have consumed entire buffer */
3440 if (p != end) {
3441 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3442 }
3443
3444 return 0;
3445}
3446
3447#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3448
3449#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3450/* Serialization of TLS 1.3 sessions:
3451 *
David Horstmanncb01b362024-02-29 17:31:46 +00003452 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003453 */
3454#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3455MBEDTLS_CHECK_RETURN_CRITICAL
3456static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3457 unsigned char *buf,
3458 size_t buf_len,
3459 size_t *olen)
3460{
3461 unsigned char *p = buf;
3462#if defined(MBEDTLS_SSL_CLI_C) && \
3463 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3464 size_t hostname_len = (session->hostname == NULL) ?
3465 0 : strlen(session->hostname) + 1;
3466#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003467
3468#if defined(MBEDTLS_SSL_SRV_C) && \
3469 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003470 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003471 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003472#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003473 size_t needed = 4 /* ticket_age_add */
3474 + 1 /* ticket_flags */
3475 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003476
David Horstmanne59f9702024-02-29 16:08:57 +00003477 *olen = 0;
3478
3479 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3480 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3481 }
3482 needed += session->resumption_key_len; /* resumption_key */
3483
3484#if defined(MBEDTLS_SSL_EARLY_DATA)
3485 needed += 4; /* max_early_data_size */
3486#endif
3487#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3488 needed += 2; /* record_size_limit */
3489#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3490
3491#if defined(MBEDTLS_HAVE_TIME)
3492 needed += 8; /* ticket_creation_time or ticket_reception_time */
3493#endif
3494
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003495#if defined(MBEDTLS_SSL_SRV_C)
3496 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3497#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003498 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003499 + alpn_len; /* alpn */
3500#endif
3501 }
3502#endif /* MBEDTLS_SSL_SRV_C */
3503
David Horstmanne59f9702024-02-29 16:08:57 +00003504#if defined(MBEDTLS_SSL_CLI_C)
3505 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3506#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3507 needed += 2 /* hostname_len */
3508 + hostname_len; /* hostname */
3509#endif
3510
3511 needed += 4 /* ticket_lifetime */
3512 + 2; /* ticket_len */
3513
3514 /* Check size_t overflow */
3515 if (session->ticket_len > SIZE_MAX - needed) {
3516 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3517 }
3518
3519 needed += session->ticket_len; /* ticket */
3520 }
3521#endif /* MBEDTLS_SSL_CLI_C */
3522
3523 *olen = needed;
3524 if (needed > buf_len) {
3525 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3526 }
3527
3528 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3529 p[4] = session->ticket_flags;
3530
3531 /* save resumption_key */
3532 p[5] = session->resumption_key_len;
3533 p += 6;
3534 memcpy(p, session->resumption_key, session->resumption_key_len);
3535 p += session->resumption_key_len;
3536
3537#if defined(MBEDTLS_SSL_EARLY_DATA)
3538 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3539 p += 4;
3540#endif
3541#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3542 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3543 p += 2;
3544#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3545
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003546#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003547 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003548#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003549 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3550 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003551#endif /* MBEDTLS_HAVE_TIME */
3552
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003553#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003554 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3555 p += 2;
3556
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003557 if (alpn_len > 0) {
3558 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003559 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003560 p += alpn_len;
3561 }
3562#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3563 }
3564#endif /* MBEDTLS_SSL_SRV_C */
3565
David Horstmanne59f9702024-02-29 16:08:57 +00003566#if defined(MBEDTLS_SSL_CLI_C)
3567 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3568#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3569 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3570 p += 2;
3571 if (hostname_len > 0) {
3572 /* save host name */
3573 memcpy(p, session->hostname, hostname_len);
3574 p += hostname_len;
3575 }
3576#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3577
3578#if defined(MBEDTLS_HAVE_TIME)
3579 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3580 p += 8;
3581#endif
3582 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3583 p += 4;
3584
3585 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3586 p += 2;
3587
3588 if (session->ticket != NULL && session->ticket_len > 0) {
3589 memcpy(p, session->ticket, session->ticket_len);
3590 p += session->ticket_len;
3591 }
3592 }
3593#endif /* MBEDTLS_SSL_CLI_C */
3594 return 0;
3595}
3596
3597MBEDTLS_CHECK_RETURN_CRITICAL
3598static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3599 const unsigned char *buf,
3600 size_t len)
3601{
3602 const unsigned char *p = buf;
3603 const unsigned char *end = buf + len;
3604
3605 if (end - p < 6) {
3606 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3607 }
3608 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3609 session->ticket_flags = p[4];
3610
3611 /* load resumption_key */
3612 session->resumption_key_len = p[5];
3613 p += 6;
3614
3615 if (end - p < session->resumption_key_len) {
3616 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3617 }
3618
3619 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3620 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3621 }
3622 memcpy(session->resumption_key, p, session->resumption_key_len);
3623 p += session->resumption_key_len;
3624
3625#if defined(MBEDTLS_SSL_EARLY_DATA)
3626 if (end - p < 4) {
3627 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3628 }
3629 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3630 p += 4;
3631#endif
3632#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3633 if (end - p < 2) {
3634 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3635 }
3636 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3637 p += 2;
3638#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3639
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003640#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003641 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003642#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003643 if (end - p < 8) {
3644 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3645 }
3646 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3647 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003648#endif /* MBEDTLS_HAVE_TIME */
3649
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003650#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003651 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003652
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003653 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003654 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3655 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003656
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003657 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3658 p += 2;
3659
3660 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003661 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3662 }
3663
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003664 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003665 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3666 if (ret != 0) {
3667 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003668 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003669 p += alpn_len;
3670 }
3671#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3672 }
3673#endif /* MBEDTLS_SSL_SRV_C */
3674
David Horstmanne59f9702024-02-29 16:08:57 +00003675#if defined(MBEDTLS_SSL_CLI_C)
3676 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3677#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3678 size_t hostname_len;
3679 /* load host name */
3680 if (end - p < 2) {
3681 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3682 }
3683 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3684 p += 2;
3685
3686 if (end - p < (long int) hostname_len) {
3687 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3688 }
3689 if (hostname_len > 0) {
3690 session->hostname = mbedtls_calloc(1, hostname_len);
3691 if (session->hostname == NULL) {
3692 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3693 }
3694 memcpy(session->hostname, p, hostname_len);
3695 p += hostname_len;
3696 }
3697#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3698
3699#if defined(MBEDTLS_HAVE_TIME)
3700 if (end - p < 8) {
3701 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3702 }
3703 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3704 p += 8;
3705#endif
3706 if (end - p < 4) {
3707 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3708 }
3709 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3710 p += 4;
3711
3712 if (end - p < 2) {
3713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3714 }
3715 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3716 p += 2;
3717
3718 if (end - p < (long int) session->ticket_len) {
3719 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3720 }
3721 if (session->ticket_len > 0) {
3722 session->ticket = mbedtls_calloc(1, session->ticket_len);
3723 if (session->ticket == NULL) {
3724 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3725 }
3726 memcpy(session->ticket, p, session->ticket_len);
3727 p += session->ticket_len;
3728 }
3729 }
3730#endif /* MBEDTLS_SSL_CLI_C */
3731
3732 return 0;
3733
3734}
3735#else /* MBEDTLS_SSL_SESSION_TICKETS */
3736MBEDTLS_CHECK_RETURN_CRITICAL
3737static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3738 unsigned char *buf,
3739 size_t buf_len,
3740 size_t *olen)
3741{
3742 ((void) session);
3743 ((void) buf);
3744 ((void) buf_len);
3745 *olen = 0;
3746 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3747}
3748
3749static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003750 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003751 size_t buf_len)
3752{
3753 ((void) session);
3754 ((void) buf);
3755 ((void) buf_len);
3756 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3757}
3758#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3759#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3760
Paul Bakker5121ce52009-01-03 21:22:43 +00003761/*
Hanno Beckera835da52019-05-16 12:39:07 +01003762 * Define ticket header determining Mbed TLS version
3763 * and structure of the ticket.
3764 */
3765
Hanno Becker94ef3b32019-05-16 12:50:45 +01003766/*
Hanno Becker50b59662019-05-28 14:30:45 +01003767 * Define bitflag determining compile-time settings influencing
3768 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003769 */
3770
Hanno Becker50b59662019-05-28 14:30:45 +01003771#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003772#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003773#else
Hanno Becker3e088662019-05-29 11:10:18 +01003774#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003775#endif /* MBEDTLS_HAVE_TIME */
3776
3777#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003778#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003779#else
Hanno Becker3e088662019-05-29 11:10:18 +01003780#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003781#endif /* MBEDTLS_X509_CRT_PARSE_C */
3782
David Horstmann5c5a32f2024-02-13 17:53:35 +00003783#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003784#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003785#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003786#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003787#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3788
Hanno Becker94ef3b32019-05-16 12:50:45 +01003789#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003790#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003791#else
Hanno Becker3e088662019-05-29 11:10:18 +01003792#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003793#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3794
3795#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003796#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003797#else
Hanno Becker3e088662019-05-29 11:10:18 +01003798#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003799#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3800
Hanno Becker94ef3b32019-05-16 12:50:45 +01003801#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003802#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003803#else
Hanno Becker3e088662019-05-29 11:10:18 +01003804#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003805#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3806
Hanno Becker94ef3b32019-05-16 12:50:45 +01003807#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3808#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3809#else
3810#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3811#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3812
David Horstmann92b258b2024-02-13 17:23:34 +00003813#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3814#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3815#else
3816#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3817#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3818
3819#if defined(MBEDTLS_SSL_EARLY_DATA)
3820#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3821#else
3822#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3823#endif /* MBEDTLS_SSL_EARLY_DATA */
3824
3825#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3826#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3827#else
3828#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3829#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3830
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003831#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3832 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003833#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3834#else
3835#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3836#endif /* MBEDTLS_SSL_ALPN */
3837
Hanno Becker3e088662019-05-29 11:10:18 +01003838#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3839#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3840#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3841#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003842#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3843#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003844#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003845#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3846#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3847#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003848#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003849
Hanno Becker50b59662019-05-28 14:30:45 +01003850#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003851 ((uint16_t) ( \
3852 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3853 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3854 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3855 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3856 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3857 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003858 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003859 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3860 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003861 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3862 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3863 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3864 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003865 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003866 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003867 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003868
Chien Wong4e9683e2023-12-28 17:07:43 +08003869static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003870 MBEDTLS_VERSION_MAJOR,
3871 MBEDTLS_VERSION_MINOR,
3872 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003873 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3874 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003875};
Hanno Beckera835da52019-05-16 12:39:07 +01003876
3877/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003878 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003879 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003880 *
David Horstmanncb01b362024-02-29 17:31:46 +00003881 * TLS 1.2 session:
3882 *
3883 * struct {
3884 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3885 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3886 * uint32 ticket_lifetime;
3887 * #endif
3888 * } ClientOnlyData;
3889 *
3890 * struct {
3891 * #if defined(MBEDTLS_HAVE_TIME)
3892 * uint64 start_time;
3893 * #endif
3894 * uint8 session_id_len; // at most 32
3895 * opaque session_id[32];
3896 * opaque master[48]; // fixed length in the standard
3897 * uint32 verify_result;
3898 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3899 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3900 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003901 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003902 * opaque peer_cert_digest<0..2^8-1>
3903 * #endif
3904 * select (endpoint) {
3905 * case client: ClientOnlyData;
3906 * case server: uint64 ticket_creation_time;
3907 * };
3908 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3909 * uint8 mfl_code; // up to 255 according to standard
3910 * #endif
3911 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3912 * uint8 encrypt_then_mac; // 0 or 1
3913 * #endif
3914 * } serialized_session_tls12;
3915 *
3916 *
3917 * TLS 1.3 Session:
3918 *
3919 * struct {
3920 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3921 * opaque hostname<0..2^16-1>;
3922 * #endif
3923 * #if defined(MBEDTLS_HAVE_TIME)
3924 * uint64 ticket_reception_time;
3925 * #endif
3926 * uint32 ticket_lifetime;
3927 * opaque ticket<1..2^16-1>;
3928 * } ClientOnlyData;
3929 *
3930 * struct {
3931 * uint32 ticket_age_add;
3932 * uint8 ticket_flags;
3933 * opaque resumption_key<0..255>;
3934 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3935 * uint32 max_early_data_size;
3936 * #endif
3937 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3938 * uint16 record_size_limit;
3939 * #endif
3940 * select ( endpoint ) {
3941 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003942 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003943 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003944 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003945 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003946 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003947 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003948 * #endif
3949 * };
3950 * } serialized_session_tls13;
3951 *
3952 *
3953 * SSL session:
3954 *
3955 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003956 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003957 * opaque mbedtls_version[3]; // library version: major, minor, patch
3958 * opaque session_format[2]; // library-version specific 16-bit field
3959 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003960 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003961 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003962 * Note: When updating the format, remember to keep
3963 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003964 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003965 * // In this version, `session_format` determines
3966 * // the setting of those compile-time
3967 * // configuration options which influence
3968 * // the structure of mbedtls_ssl_session.
3969 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003970 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003971 * // - TLS 1.2 (0x0303)
3972 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00003973 * uint8_t endpoint;
3974 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003975 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003976 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003977 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003978 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003979 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003980 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003981 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003982 *
3983 * };
3984 *
3985 * } serialized_session;
3986 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003987 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003988
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003989MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003990static int ssl_session_save(const mbedtls_ssl_session *session,
3991 unsigned char omit_header,
3992 unsigned char *buf,
3993 size_t buf_len,
3994 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003995{
3996 unsigned char *p = buf;
3997 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003998 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003999#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4000 size_t out_len;
4001 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4002#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 if (session == NULL) {
4004 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4005 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004006
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004008 /*
4009 * Add Mbed TLS version identifier
4010 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004011 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004012
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 if (used <= buf_len) {
4014 memcpy(p, ssl_serialized_session_header,
4015 sizeof(ssl_serialized_session_header));
4016 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004017 }
4018 }
4019
4020 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004021 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004022 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004023 used += 1 /* TLS version */
4024 + 1 /* endpoint */
4025 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004026 if (used <= buf_len) {
4027 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004028 *p++ = session->endpoint;
4029 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4030 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004031 }
4032
4033 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004034 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004035 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004036#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 case MBEDTLS_SSL_VERSION_TLS1_2:
4038 used += ssl_tls12_session_save(session, p, remaining_len);
4039 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004040#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4041
Jerry Yu251a12e2022-07-13 15:15:48 +08004042#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 case MBEDTLS_SSL_VERSION_TLS1_3:
4044 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4045 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4046 return ret;
4047 }
4048 used += out_len;
4049 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004050#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4051
Gilles Peskine449bd832023-01-11 14:50:10 +01004052 default:
4053 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004054 }
4055
4056 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 if (used > buf_len) {
4058 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4059 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004060
Gilles Peskine449bd832023-01-11 14:50:10 +01004061 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004062}
4063
4064/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004065 * Public wrapper for ssl_session_save()
4066 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004067int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4068 unsigned char *buf,
4069 size_t buf_len,
4070 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004071{
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004073}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004074
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004075/*
4076 * Deserialize session, see mbedtls_ssl_session_save() for format.
4077 *
4078 * This internal version is wrapped by a public function that cleans up in
4079 * case of error, and has an extra option omit_header.
4080 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004081MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004082static int ssl_session_load(mbedtls_ssl_session *session,
4083 unsigned char omit_header,
4084 const unsigned char *buf,
4085 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004086{
4087 const unsigned char *p = buf;
4088 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004089 size_t remaining_len;
4090
4091
Gilles Peskine449bd832023-01-11 14:50:10 +01004092 if (session == NULL) {
4093 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4094 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004095
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004097 /*
4098 * Check Mbed TLS version identifier
4099 */
4100
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4102 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004103 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004104
4105 if (memcmp(p, ssl_serialized_session_header,
4106 sizeof(ssl_serialized_session_header)) != 0) {
4107 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4108 }
4109 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004110 }
4111
4112 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004113 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004114 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004115 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004116 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4117 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004118 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004119 session->endpoint = *p++;
4120 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4121 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004122
4123 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004124 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004125 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004126#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 case MBEDTLS_SSL_VERSION_TLS1_2:
4128 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004129#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4130
Jerry Yu438ddd82022-07-07 06:55:50 +00004131#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004132 case MBEDTLS_SSL_VERSION_TLS1_3:
4133 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004134#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4135
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 default:
4137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004138 }
4139}
4140
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004141/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004142 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004143 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004144int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4145 const unsigned char *buf,
4146 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004147{
Gilles Peskine449bd832023-01-11 14:50:10 +01004148 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004149
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 if (ret != 0) {
4151 mbedtls_ssl_session_free(session);
4152 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004153
Gilles Peskine449bd832023-01-11 14:50:10 +01004154 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004155}
4156
4157/*
Paul Bakker1961b702013-01-25 14:49:24 +01004158 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004159 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004160MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004161static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004162{
4163 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4164
Ronald Cron66dbf912022-02-02 15:33:46 +01004165 /*
4166 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004167 * that were written into the output buffer by the previous handshake step,
4168 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004169 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4170 * We proceed to the next handshake step only when all data from the
4171 * previous one have been sent to the peer, thus we make sure that this is
4172 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4173 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4174 * we have to wait before to go ahead.
4175 * In the case of TLS 1.3, handshake step handlers do not send data to the
4176 * peer. Data are only sent here and through
4177 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004178 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004179 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4181 return ret;
4182 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004183
4184#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4186 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4187 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4188 return ret;
4189 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004190 }
4191#endif /* MBEDTLS_SSL_PROTO_DTLS */
4192
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004194}
4195
Gilles Peskine449bd832023-01-11 14:50:10 +01004196int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004197{
Hanno Becker41934dd2021-08-07 19:13:43 +01004198 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004199
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004201 ssl->conf == NULL ||
4202 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4204 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004205 }
4206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 ret = ssl_prepare_handshake_step(ssl);
4208 if (ret != 0) {
4209 return ret;
4210 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004211
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 ret = mbedtls_ssl_handle_pending_alert(ssl);
4213 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004214 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 }
Jerry Yue7047812021-09-13 19:26:39 +08004216
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004217 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4218 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4219 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4220
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004221#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4223 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004224 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004225
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004227 case MBEDTLS_SSL_HELLO_REQUEST:
4228 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004229 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004230 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004231
Ronald Cron9f0fba32022-02-10 16:45:15 +01004232 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004234 break;
4235
4236 default:
4237#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4239 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4240 } else {
4241 ret = mbedtls_ssl_handshake_client_step(ssl);
4242 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004243#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004245#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004247#endif
4248 }
Jerry Yub9930e72021-08-06 17:11:51 +08004249 }
Ronald Cron6291b232023-03-08 15:51:25 +01004250#endif /* MBEDTLS_SSL_CLI_C */
4251
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004252#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004254#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4255 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004257 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 ret = mbedtls_ssl_handshake_server_step(ssl);
4259 }
Ronald Cron6291b232023-03-08 15:51:25 +01004260#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4261 ret = mbedtls_ssl_handshake_server_step(ssl);
4262#else
4263 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004264#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004265 }
4266#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004267
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004269 /* handshake_step return error. And it is same
4270 * with alert_reason.
4271 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 if (ssl->send_alert) {
4273 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004274 goto cleanup;
4275 }
4276 }
4277
4278cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004280}
4281
4282/*
4283 * Perform the SSL handshake
4284 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004285int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004286{
4287 int ret = 0;
4288
Hanno Beckera817ea42020-10-20 15:20:23 +01004289 /* Sanity checks */
4290
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 if (ssl == NULL || ssl->conf == NULL) {
4292 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4293 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004294
Hanno Beckera817ea42020-10-20 15:20:23 +01004295#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4297 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4298 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4299 "mbedtls_ssl_set_timer_cb() for DTLS"));
4300 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004301 }
4302#endif /* MBEDTLS_SSL_PROTO_DTLS */
4303
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004305
Hanno Beckera817ea42020-10-20 15:20:23 +01004306 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4308 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004309
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004311 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 }
Paul Bakker1961b702013-01-25 14:49:24 +01004313 }
4314
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004316
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004318}
4319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004320#if defined(MBEDTLS_SSL_RENEGOTIATION)
4321#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004322/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004323 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004324 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004325MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004326static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004327{
Janos Follath865b3eb2019-12-16 11:46:15 +00004328 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004329
Gilles Peskine449bd832023-01-11 14:50:10 +01004330 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004331
4332 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004333 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4334 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004335
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4337 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4338 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004339 }
4340
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004342
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004344}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004345#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004346
4347/*
4348 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004349 * - any side: calling mbedtls_ssl_renegotiate(),
4350 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4351 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004352 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004353 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004354 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004355 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004356int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004357{
Janos Follath865b3eb2019-12-16 11:46:15 +00004358 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004359
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004361
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 if ((ret = ssl_handshake_init(ssl)) != 0) {
4363 return ret;
4364 }
Paul Bakker48916f92012-09-16 19:57:18 +00004365
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004366 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4367 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004368#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4370 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4371 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004372 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004374 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004376 }
4377#endif
4378
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004379 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4380 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004381
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4383 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4384 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004385 }
4386
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004390}
4391
4392/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004393 * Renegotiate current connection on client,
4394 * or request renegotiation on server
4395 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004396int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004397{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004398 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 if (ssl == NULL || ssl->conf == NULL) {
4401 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4402 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004403
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004404#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004405 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4407 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4408 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4409 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004410
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004411 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004412
4413 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 if (ssl->out_left != 0) {
4415 return mbedtls_ssl_flush_output(ssl);
4416 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004417
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004419 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004420#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004421
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004422#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004423 /*
4424 * On client, either start the renegotiation process or,
4425 * if already in progress, continue the handshake
4426 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4428 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4429 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004430 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004431
4432 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4433 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4434 return ret;
4435 }
4436 } else {
4437 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4438 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4439 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004440 }
4441 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004442#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004443
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004445}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004446#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004449{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004450 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4451
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004453 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004455
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004456#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004457#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 if (ssl->handshake->group_list_heap_allocated) {
4459 mbedtls_free((void *) handshake->group_list);
4460 }
Brett Warrene0edc842021-08-17 09:53:13 +01004461 handshake->group_list = NULL;
4462#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004463#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004464
Ronald Crone68ab4f2022-10-05 12:46:29 +02004465#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004466#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 if (ssl->handshake->sig_algs_heap_allocated) {
4468 mbedtls_free((void *) handshake->sig_algs);
4469 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004470 handshake->sig_algs = NULL;
4471#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004472#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 if (ssl->handshake->certificate_request_context) {
4474 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004475 }
4476#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004477#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004478
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004479#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4481 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004482 handshake->async_in_progress = 0;
4483 }
4484#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4485
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004486#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004488#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004489#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004491#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004492
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004493#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004495 /*
4496 * Opaque keys are not stored in the handshake's data and it's the user
4497 * responsibility to destroy them. Clear ones, instead, are created by
4498 * the TLS library and should be destroyed at the same level
4499 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4501 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004502 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004503 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004504#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004506 handshake->ecjpake_cache = NULL;
4507 handshake->ecjpake_cache_len = 0;
4508#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004509#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004510
Valerio Setti7aeec542023-07-05 18:57:21 +02004511#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004512 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004513 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004514 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004516#endif
4517
Ronald Cron73fe8df2022-10-05 14:31:43 +02004518#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004520 /* The maintenance of the external PSK key slot is the
4521 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 if (ssl->handshake->psk_opaque_is_internal) {
4523 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004524 ssl->handshake->psk_opaque_is_internal = 0;
4525 }
4526 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4527 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004528#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004529
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004530#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4531 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004532 /*
4533 * Free only the linked list wrapper, not the keys themselves
4534 * since the belong to the SNI callback
4535 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004537#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004538
Gilles Peskineeccd8882020-03-10 12:19:08 +01004539#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4541 if (handshake->ecrs_peer_cert != NULL) {
4542 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4543 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004544 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004545#endif
4546
Hanno Becker75173122019-02-06 16:18:31 +00004547#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4548 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004550#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4551
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004552#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4554 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004555#endif /* MBEDTLS_SSL_CLI_C &&
4556 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004557
4558#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 mbedtls_ssl_flight_free(handshake->flight);
4560 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004561#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004562
Valerio Settiea59c432023-07-25 11:14:03 +02004563#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004564 if (handshake->xxdh_psa_privkey_is_external == 0) {
4565 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 }
Valerio Settiea59c432023-07-25 11:14:03 +02004567#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004568
Ronald Cron6f135e12021-12-08 16:57:54 +01004569#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 mbedtls_ssl_transform_free(handshake->transform_handshake);
4571 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004572#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4574 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004575#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004576#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004577
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004578
4579#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4580 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4581 * processes datagrams and the fact that a datagram is allowed to have
4582 * several records in it, it is possible that the I/O buffers are not
4583 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4585 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004586#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004587
Jerry Yuba9c7272021-10-30 11:54:10 +08004588 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 mbedtls_platform_zeroize(handshake,
4590 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004591}
4592
Gilles Peskine449bd832023-01-11 14:50:10 +01004593void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004594{
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004596 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004598
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004599#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004601#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004602
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004603#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004604#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4605 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004607#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004609#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004610
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004611#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4612 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004613 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004614#endif
4615
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004617}
4618
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004619#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004620
4621#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4622#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4623#else
4624#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4625#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4626
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004627#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004628
4629#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4630#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4631#else
4632#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4633#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4634
4635#if defined(MBEDTLS_SSL_ALPN)
4636#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4637#else
4638#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4639#endif /* MBEDTLS_SSL_ALPN */
4640
4641#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4642#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4643#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4644#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4645
4646#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 ((uint32_t) ( \
4648 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4649 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4650 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4651 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4652 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4653 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4654 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4655 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004656
Chien Wong4e9683e2023-12-28 17:07:43 +08004657static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004658 MBEDTLS_VERSION_MAJOR,
4659 MBEDTLS_VERSION_MINOR,
4660 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4662 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4663 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4664 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4665 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004666};
4667
Paul Bakker5121ce52009-01-03 21:22:43 +00004668/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004669 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004670 *
4671 * The format of the serialized data is:
4672 * (in the presentation language of TLS, RFC 8446 section 3)
4673 *
4674 * // header
4675 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004676 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004677 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004678 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004679 * Note: When updating the format, remember to keep these
4680 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004681 *
4682 * // session sub-structure
4683 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4684 * // transform sub-structure
4685 * uint8 random[64]; // ServerHello.random+ClientHello.random
4686 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4687 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4688 * // fields from ssl_context
4689 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4690 * uint64 in_window_top; // DTLS: last validated record seq_num
4691 * uint64 in_window; // DTLS: bitmask for replay protection
4692 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4693 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4694 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4695 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4696 *
4697 * Note that many fields of the ssl_context or sub-structures are not
4698 * serialized, as they fall in one of the following categories:
4699 *
4700 * 1. forced value (eg in_left must be 0)
4701 * 2. pointer to dynamically-allocated memory (eg session, transform)
4702 * 3. value can be re-derived from other data (eg session keys from MS)
4703 * 4. value was temporary (eg content of input buffer)
4704 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004705 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004706int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4707 unsigned char *buf,
4708 size_t buf_len,
4709 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004710{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004711 unsigned char *p = buf;
4712 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004713 size_t session_len;
4714 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004715
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004716 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004717 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4718 * this function's documentation.
4719 *
4720 * These are due to assumptions/limitations in the implementation. Some of
4721 * them are likely to stay (no handshake in progress) some might go away
4722 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004723 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004724 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4726 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4727 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004728 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 if (ssl->handshake != NULL) {
4730 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004732 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004733 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 if (ssl->transform == NULL || ssl->session == NULL) {
4735 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4736 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004737 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004738 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 if (mbedtls_ssl_check_pending(ssl) != 0) {
4740 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4741 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004742 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 if (ssl->out_left != 0) {
4744 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4745 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004746 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004747 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4749 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4750 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004751 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004752 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4754 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004756 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004757 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4759 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4760 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004761 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004762 /* Renegotiation must not be enabled */
4763#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4765 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4766 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004767 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004768#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004769
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004770 /*
4771 * Version and format identifier
4772 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004774
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 if (used <= buf_len) {
4776 memcpy(p, ssl_serialized_context_header,
4777 sizeof(ssl_serialized_context_header));
4778 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004779 }
4780
4781 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004782 * Session (length + data)
4783 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4785 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4786 return ret;
4787 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004788
4789 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 if (used <= buf_len) {
4791 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004792 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004793
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 ret = ssl_session_save(ssl->session, 1,
4795 p, session_len, &session_len);
4796 if (ret != 0) {
4797 return ret;
4798 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004799
4800 p += session_len;
4801 }
4802
4803 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004804 * Transform
4805 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 used += sizeof(ssl->transform->randbytes);
4807 if (used <= buf_len) {
4808 memcpy(p, ssl->transform->randbytes,
4809 sizeof(ssl->transform->randbytes));
4810 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004811 }
4812
4813#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004814 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004816 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004818 p += ssl->transform->in_cid_len;
4819
4820 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004822 p += ssl->transform->out_cid_len;
4823 }
4824#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4825
4826 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004827 * Saved fields from top-level ssl_context structure
4828 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004829 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 if (used <= buf_len) {
4831 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004832 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004833 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004834
4835#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4836 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 if (used <= buf_len) {
4838 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004839 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004840
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004842 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004843 }
4844#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4845
4846#if defined(MBEDTLS_SSL_PROTO_DTLS)
4847 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004849 *p++ = ssl->disable_datagram_packing;
4850 }
4851#endif /* MBEDTLS_SSL_PROTO_DTLS */
4852
Jerry Yuae0b2e22021-10-08 15:21:19 +08004853 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 if (used <= buf_len) {
4855 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004856 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004857 }
4858
4859#if defined(MBEDTLS_SSL_PROTO_DTLS)
4860 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 if (used <= buf_len) {
4862 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004863 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004864 }
4865#endif /* MBEDTLS_SSL_PROTO_DTLS */
4866
4867#if defined(MBEDTLS_SSL_ALPN)
4868 {
4869 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004871 : 0;
4872
4873 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004875 *p++ = alpn_len;
4876
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 if (ssl->alpn_chosen != NULL) {
4878 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004879 p += alpn_len;
4880 }
4881 }
4882 }
4883#endif /* MBEDTLS_SSL_ALPN */
4884
4885 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004886 * Done
4887 */
4888 *olen = used;
4889
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 if (used > buf_len) {
4891 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4892 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004893
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004897}
4898
4899/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004900 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004901 *
4902 * This internal version is wrapped by a public function that cleans up in
4903 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004904 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004905MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004906static int ssl_context_load(mbedtls_ssl_context *ssl,
4907 const unsigned char *buf,
4908 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004909{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004910 const unsigned char *p = buf;
4911 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004912 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004913 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004914#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004915 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004916#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004917
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004918 /*
4919 * The context should have been freshly setup or reset.
4920 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004921 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004922 * renegotiating, or if the user mistakenly loaded a session first.)
4923 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4925 ssl->session != NULL) {
4926 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004927 }
4928
4929 /*
4930 * We can't check that the config matches the initial one, but we can at
4931 * least check it matches the requirements for serializing.
4932 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004933 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004934#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004935 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004936#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004937 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4938 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4939 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4940 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004942 }
4943
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004945
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004946 /*
4947 * Check version identifier
4948 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4950 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004951 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004952
4953 if (memcmp(p, ssl_serialized_context_header,
4954 sizeof(ssl_serialized_context_header)) != 0) {
4955 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4956 }
4957 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004958
4959 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004960 * Session
4961 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 if ((size_t) (end - p) < 4) {
4963 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4964 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004965
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004966 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004967 p += 4;
4968
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004969 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004970 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004971 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004972 ssl->session_in = ssl->session;
4973 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004974 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004975
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 if ((size_t) (end - p) < session_len) {
4977 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4978 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004979
Gilles Peskine449bd832023-01-11 14:50:10 +01004980 ret = ssl_session_load(ssl->session, 1, p, session_len);
4981 if (ret != 0) {
4982 mbedtls_ssl_session_free(ssl->session);
4983 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004984 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004985
4986 p += session_len;
4987
4988 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004989 * Transform
4990 */
4991
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004992 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004993 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004994#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004995 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004996 ssl->transform_in = ssl->transform;
4997 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004998 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004999#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005000
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005001#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005002 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5003 if (prf_func == NULL) {
5004 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5005 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005006
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005007 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005008 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5009 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5010 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005011
Gilles Peskine449bd832023-01-11 14:50:10 +01005012 ret = ssl_tls12_populate_transform(ssl->transform,
5013 ssl->session->ciphersuite,
5014 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005015#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005017#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005018 prf_func,
5019 p, /* currently pointing to randbytes */
5020 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5021 ssl->conf->endpoint,
5022 ssl);
5023 if (ret != 0) {
5024 return ret;
5025 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005026#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005028
5029#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5030 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005031 if ((size_t) (end - p) < 1) {
5032 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5033 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005034
5035 ssl->transform->in_cid_len = *p++;
5036
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5038 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5039 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005040
Gilles Peskine449bd832023-01-11 14:50:10 +01005041 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005042 p += ssl->transform->in_cid_len;
5043
5044 ssl->transform->out_cid_len = *p++;
5045
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5047 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5048 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005049
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005051 p += ssl->transform->out_cid_len;
5052#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5053
5054 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005055 * Saved fields from top-level ssl_context structure
5056 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 if ((size_t) (end - p) < 4) {
5058 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5059 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005060
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005061 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005062 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005063
5064#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 if ((size_t) (end - p) < 16) {
5066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5067 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005068
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005069 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005070 p += 8;
5071
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005072 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005073 p += 8;
5074#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5075
5076#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 if ((size_t) (end - p) < 1) {
5078 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5079 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005080
5081 ssl->disable_datagram_packing = *p++;
5082#endif /* MBEDTLS_SSL_PROTO_DTLS */
5083
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5085 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5086 }
5087 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5088 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005089
5090#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 if ((size_t) (end - p) < 2) {
5092 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5093 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005094
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005095 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005096 p += 2;
5097#endif /* MBEDTLS_SSL_PROTO_DTLS */
5098
5099#if defined(MBEDTLS_SSL_ALPN)
5100 {
5101 uint8_t alpn_len;
5102 const char **cur;
5103
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 if ((size_t) (end - p) < 1) {
5105 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5106 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005107
5108 alpn_len = *p++;
5109
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005111 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5113 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005114 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005115 ssl->alpn_chosen = *cur;
5116 break;
5117 }
5118 }
5119 }
5120
5121 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5123 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5124 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005125
5126 p += alpn_len;
5127 }
5128#endif /* MBEDTLS_SSL_ALPN */
5129
5130 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005131 * Forced fields from top-level ssl_context structure
5132 *
5133 * Most of them already set to the correct value by mbedtls_ssl_init() and
5134 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5135 */
5136 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005137 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005138
Hanno Becker361b10d2019-08-30 10:42:49 +01005139 /* Adjust pointers for header fields of outgoing records to
5140 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005142
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005143#if defined(MBEDTLS_SSL_PROTO_DTLS)
5144 ssl->in_epoch = 1;
5145#endif
5146
5147 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5148 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005149 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5150 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 if (ssl->handshake != NULL) {
5152 mbedtls_ssl_handshake_free(ssl);
5153 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005154 ssl->handshake = NULL;
5155 }
5156
5157 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005158 * Done - should have consumed entire buffer
5159 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 if (p != end) {
5161 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5162 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005163
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005165}
5166
5167/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005168 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005169 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005170int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5171 const unsigned char *buf,
5172 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005173{
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005175
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 if (ret != 0) {
5177 mbedtls_ssl_free(context);
5178 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005179
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005181}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005182#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005183
5184/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005185 * Free an SSL context
5186 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005187void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005188{
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005190 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005192
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005194
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005196#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5197 size_t out_buf_len = ssl->out_buf_len;
5198#else
5199 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5200#endif
5201
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005202 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005203 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005204 }
5205
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005207#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5208 size_t in_buf_len = ssl->in_buf_len;
5209#else
5210 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5211#endif
5212
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005213 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005214 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005215 }
5216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 if (ssl->transform) {
5218 mbedtls_ssl_transform_free(ssl->transform);
5219 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005220 }
5221
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 if (ssl->handshake) {
5223 mbedtls_ssl_handshake_free(ssl);
5224 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005225
5226#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5228 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005229#endif
5230
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 mbedtls_ssl_session_free(ssl->session_negotiate);
5232 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005233 }
5234
Ronald Cron6f135e12021-12-08 16:57:54 +01005235#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 mbedtls_ssl_transform_free(ssl->transform_application);
5237 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005238#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005239
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 if (ssl->session) {
5241 mbedtls_ssl_session_free(ssl->session);
5242 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005243 }
5244
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005245#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005247 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005248 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005249#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005250
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005251#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005253#endif
5254
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005256
Paul Bakker86f04f42013-02-14 11:20:09 +01005257 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005259}
5260
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005261/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005262 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005263 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005264void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005265{
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005267}
5268
Gilles Peskineae270bf2021-06-02 00:05:29 +02005269/* The selection should be the same as mbedtls_x509_crt_profile_default in
5270 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005271 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005272 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005273 * about this list.
5274 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005275static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005276#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005277 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005278#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005279#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005280 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005281#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005282#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005283 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005284#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005285#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005286 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005287#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005288#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005289 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005290#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005291#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005292 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005293#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005294#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005295 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005296#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005297#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005298 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005299#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005300#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005301 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5302 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5303 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5304 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5305 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5306#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005307 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005308};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005309
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005310static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005311 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5312 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5313 0
5314};
5315
Ronald Crone68ab4f2022-10-05 12:46:29 +02005316#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005317
Jerry Yu909df7b2022-01-22 11:56:27 +08005318/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005319 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005320 * rules SHOULD be upheld.
5321 * - No duplicate entries.
5322 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005323 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005324 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005325 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005326static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005327
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005328#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005329 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005330 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005331 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005332 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5333#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005334
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005335#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005336 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005337 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005338 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005339 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5340#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005341
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005342#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005343 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005344 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005345 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005346 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5347#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005348
Gabor Mezeic15ef932024-06-13 12:53:54 +02005349#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005350 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005351#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005352
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005353#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005354 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005355#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005356
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005357#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005358 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005359#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005360
Gabor Mezeic15ef932024-06-13 12:53:54 +02005361#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005362 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005363#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005364
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005365#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005366 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005367#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005368
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005369#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005370 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005371#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005372
Gabor Mezei15b95a62022-05-09 16:37:58 +02005373 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005374};
5375
5376/* NOTICE: see above */
5377#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5378static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005379
Gabor Mezeic15ef932024-06-13 12:53:54 +02005380#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005381#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005383#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005384#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5385 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005386#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005387#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005389#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005390#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005391
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005392#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005393#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005395#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005396#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5397 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005398#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005399#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005401#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005402#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005403
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005404#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005405#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005407#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005408#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5409 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005410#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005411#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005413#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005414#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005415
Gabor Mezei15b95a62022-05-09 16:37:58 +02005416 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005417};
5418#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005419
Jerry Yu909df7b2022-01-22 11:56:27 +08005420/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005421static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005422
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005423#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005424 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005425 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005426 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005427 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5428#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005429
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005430#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005431 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005432 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005433 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005434 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5435#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005436
Gabor Mezei15b95a62022-05-09 16:37:58 +02005437 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005438};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005439
Jerry Yu909df7b2022-01-22 11:56:27 +08005440/* NOTICE: see above */
5441#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5442static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005443
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005444#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005445#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005447#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005448#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005449
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005450#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005451#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005453#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005454#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005455
Gabor Mezei15b95a62022-05-09 16:37:58 +02005456 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005457};
Jerry Yu909df7b2022-01-22 11:56:27 +08005458#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5459
Ronald Crone68ab4f2022-10-05 12:46:29 +02005460#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005461
Chien Wong4e9683e2023-12-28 17:07:43 +08005462static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005463#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005464 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005465#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005466#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005467 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005468#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005469 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005470};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005471
Ronald Crone68ab4f2022-10-05 12:46:29 +02005472#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005473/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005474 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005475MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005476static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005477{
5478 size_t i, j;
5479 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005480
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5482 for (j = 0; j < i; j++) {
5483 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005484 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 }
5486 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5487 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5488 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005489 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005490 }
5491 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005493}
5494
Ronald Crone68ab4f2022-10-05 12:46:29 +02005495#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005496
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005497/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005498 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005499 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005500int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5501 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005502{
Ronald Crone68ab4f2022-10-05 12:46:29 +02005503#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5505 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5506 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005507 }
5508
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5510 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5511 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005512 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005513
5514#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5516 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5517 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005518 }
5519
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5521 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5522 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005523 }
5524#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005525#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005526
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005527 /* Use the functions here so that they are covered in tests,
5528 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 mbedtls_ssl_conf_endpoint(conf, endpoint);
5530 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005531
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005532 /*
5533 * Things that are common to all presets
5534 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005535#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005537 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5538#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5539 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5540#endif
5541 }
5542#endif
5543
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005544#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5545 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5546#endif
5547
5548#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5549 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5550#endif
5551
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005552#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005553 conf->f_cookie_write = ssl_cookie_write_dummy;
5554 conf->f_cookie_check = ssl_cookie_check_dummy;
5555#endif
5556
5557#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5558 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5559#endif
5560
Janos Follath088ce432017-04-10 12:42:31 +01005561#if defined(MBEDTLS_SSL_SRV_C)
5562 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005563 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005564#endif
5565
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005566#if defined(MBEDTLS_SSL_PROTO_DTLS)
5567 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5568 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5569#endif
5570
5571#if defined(MBEDTLS_SSL_RENEGOTIATION)
5572 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 memset(conf->renego_period, 0x00, 2);
5574 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005575#endif
5576
Ronald Cron6f135e12021-12-08 16:57:54 +01005577#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005578
5579#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005580 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005581#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005582 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005583#endif
5584#endif /* MBEDTLS_SSL_EARLY_DATA */
5585
Jerry Yud0766ec2022-09-22 10:46:57 +08005586#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005587 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005589#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005590 /*
5591 * Allow all TLS 1.3 key exchange modes by default.
5592 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005593 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005594#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005595
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005597#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005598 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005599 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005600#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005602#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005604#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005605 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5606 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005607#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5608 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5609 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5610#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5611 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5612 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5613#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005615#endif
5616 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005617
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005618 /*
5619 * Preset-specific defaults
5620 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005622 /*
5623 * NSA Suite B
5624 */
5625 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005626
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005627 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005628
5629#if defined(MBEDTLS_X509_CRT_PARSE_C)
5630 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005631#endif
5632
Ronald Crone68ab4f2022-10-05 12:46:29 +02005633#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005634#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005636 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005638#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005639 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005640#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005641
Brett Warrene0edc842021-08-17 09:53:13 +01005642 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005643 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005644
5645 /*
5646 * Default
5647 */
5648 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005649
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005650 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005651
5652#if defined(MBEDTLS_X509_CRT_PARSE_C)
5653 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5654#endif
5655
Ronald Crone68ab4f2022-10-05 12:46:29 +02005656#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005657#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005659 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005660 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005661#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005663#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005664
Brett Warrene0edc842021-08-17 09:53:13 +01005665 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005666 }
5667
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005669}
5670
5671/*
5672 * Free mbedtls_ssl_config
5673 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005674void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005675{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005676 if (conf == NULL) {
5677 return;
5678 }
5679
Ronald Cron73fe8df2022-10-05 14:31:43 +02005680#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005681 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005682 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5683 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005685 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005686 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005687 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005688 }
5689
Gilles Peskine449bd832023-01-11 14:50:10 +01005690 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005691 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005692 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005693 conf->psk_identity_len = 0;
5694 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005695#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005696
5697#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005699#endif
5700
Gilles Peskine449bd832023-01-11 14:50:10 +01005701 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005702}
5703
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005704#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005705 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005706/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005707 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005708 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005709unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005710{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005711#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5713 return MBEDTLS_SSL_SIG_RSA;
5714 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005715#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005716#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5718 return MBEDTLS_SSL_SIG_ECDSA;
5719 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005720#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005722}
5723
Gilles Peskine449bd832023-01-11 14:50:10 +01005724unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005725{
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005727 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005729 case MBEDTLS_PK_ECDSA:
5730 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005732 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005734 }
5735}
5736
Gilles Peskine449bd832023-01-11 14:50:10 +01005737mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005738{
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005740#if defined(MBEDTLS_RSA_C)
5741 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005743#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005744#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005745 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005746 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005747#endif
5748 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005750 }
5751}
Valerio Settie9646ec2023-08-02 20:02:28 +02005752#endif /* MBEDTLS_PK_C &&
5753 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005754
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005755/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005756 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005757 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005758mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005759{
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005761#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005762 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005763 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005764#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005765#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005766 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005768#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005769#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005770 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005771 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005772#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005773#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005774 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005775 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005776#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005777#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005778 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005779 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005780#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005781#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005782 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005783 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005784#endif
5785 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005787 }
5788}
5789
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005790/*
5791 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5792 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005793unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005794{
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005796#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005797 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005799#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005800#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005801 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005803#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005804#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005805 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005807#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005808#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005809 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005811#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005812#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005813 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005815#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005816#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005817 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005818 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005819#endif
5820 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005822 }
5823}
5824
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005825/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005826 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005827 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005828 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005829int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005830{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005831 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005832
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 if (group_list == NULL) {
5834 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005835 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005836
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 for (; *group_list != 0; group_list++) {
5838 if (*group_list == tls_id) {
5839 return 0;
5840 }
5841 }
5842
5843 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005844}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005845
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005846#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005847/*
5848 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5849 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005850int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005851{
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005853
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005855 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005856 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005857
Gilles Peskine449bd832023-01-11 14:50:10 +01005858 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005859}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005860#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005861
Valerio Setti18c9fed2022-12-30 17:44:24 +01005862static const struct {
5863 uint16_t tls_id;
5864 mbedtls_ecp_group_id ecp_group_id;
5865 psa_ecc_family_t psa_family;
5866 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005867} tls_id_match_table[] =
5868{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005869#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005870 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005871#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005872#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005873 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005874#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005875#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005876 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005877#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005878#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005879 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005880#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005881#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005882 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005883#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005884#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005885 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005886#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005887#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005888 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005889#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005890#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005891 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005892#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005893#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005894 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005895#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005896#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005897 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005898#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005899#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005900 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005901#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005902#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005903 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005904#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005905 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005906};
5907
Gilles Peskine449bd832023-01-11 14:50:10 +01005908int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005909 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005910 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005911{
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5913 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005914 if (type != NULL) {
5915 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 }
5917 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005918 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005920 return PSA_SUCCESS;
5921 }
5922 }
5923
5924 return PSA_ERROR_NOT_SUPPORTED;
5925}
5926
Gilles Peskine449bd832023-01-11 14:50:10 +01005927mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005928{
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5930 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005931 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005932 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005933 }
5934
5935 return MBEDTLS_ECP_DP_NONE;
5936}
5937
Gilles Peskine449bd832023-01-11 14:50:10 +01005938uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005939{
Gilles Peskine449bd832023-01-11 14:50:10 +01005940 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5941 i++) {
5942 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005943 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005945 }
5946
5947 return 0;
5948}
5949
Valerio Setti67419f02023-01-04 16:12:42 +01005950#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005951static const struct {
5952 uint16_t tls_id;
5953 const char *name;
5954} tls_id_curve_name_table[] =
5955{
Valerio Setti54e23792023-07-07 10:49:27 +02005956 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5957 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5958 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5959 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5960 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5961 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5962 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5963 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5964 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5965 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5966 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5967 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5968 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005969 { 0, NULL },
5970};
5971
Gilles Peskine449bd832023-01-11 14:50:10 +01005972const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005973{
Valerio Settiacd32c02023-06-29 18:06:29 +02005974 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5975 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5976 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005978 }
5979
5980 return NULL;
5981}
Valerio Setti67419f02023-01-04 16:12:42 +01005982#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005983
Gilles Peskine449bd832023-01-11 14:50:10 +01005984int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5985 const mbedtls_md_type_t md,
5986 unsigned char *dst,
5987 size_t dst_len,
5988 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005989{
Ronald Cronf6893e12022-01-07 22:09:01 +01005990 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5991 psa_hash_operation_t *hash_operation_to_clone;
5992 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5993
Jerry Yu148165c2021-09-24 23:20:59 +08005994 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005995
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005997#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 case MBEDTLS_MD_SHA384:
5999 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6000 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006001#endif
6002
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006003#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 case MBEDTLS_MD_SHA256:
6005 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6006 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006007#endif
6008
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 default:
6010 goto exit;
6011 }
6012
6013 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6014 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006015 goto exit;
6016 }
6017
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6019 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006020 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006022
6023exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006024#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006025 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006026 (void) ssl;
6027#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006028 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006029}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006030
Ronald Crone68ab4f2022-10-05 12:46:29 +02006031#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006032/* mbedtls_ssl_parse_sig_alg_ext()
6033 *
6034 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6035 * value (TLS 1.3 RFC8446):
6036 * enum {
6037 * ....
6038 * ecdsa_secp256r1_sha256( 0x0403 ),
6039 * ecdsa_secp384r1_sha384( 0x0503 ),
6040 * ecdsa_secp521r1_sha512( 0x0603 ),
6041 * ....
6042 * } SignatureScheme;
6043 *
6044 * struct {
6045 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6046 * } SignatureSchemeList;
6047 *
6048 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6049 * value (TLS 1.2 RFC5246):
6050 * enum {
6051 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6052 * sha512(6), (255)
6053 * } HashAlgorithm;
6054 *
6055 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6056 * SignatureAlgorithm;
6057 *
6058 * struct {
6059 * HashAlgorithm hash;
6060 * SignatureAlgorithm signature;
6061 * } SignatureAndHashAlgorithm;
6062 *
6063 * SignatureAndHashAlgorithm
6064 * supported_signature_algorithms<2..2^16-2>;
6065 *
6066 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6067 * generalization of the TLS 1.2 signature algorithm extension.
6068 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6069 * `SignatureScheme` field of TLS 1.3
6070 *
6071 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006072int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6073 const unsigned char *buf,
6074 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006075{
6076 const unsigned char *p = buf;
6077 size_t supported_sig_algs_len = 0;
6078 const unsigned char *supported_sig_algs_end;
6079 uint16_t sig_alg;
6080 uint32_t common_idx = 0;
6081
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6083 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006084 p += 2;
6085
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 memset(ssl->handshake->received_sig_algs, 0,
6087 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006088
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006090 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 while (p < supported_sig_algs_end) {
6092 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6093 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006094 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6096 sig_alg,
6097 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006098#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6100 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6101 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006102 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006103 }
6104#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006105
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6107 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006108
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006110 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6111 common_idx += 1;
6112 }
6113 }
6114 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 if (p != end) {
6116 MBEDTLS_SSL_DEBUG_MSG(1,
6117 ("Signature algorithms extension length misaligned"));
6118 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6119 MBEDTLS_ERR_SSL_DECODE_ERROR);
6120 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006121 }
6122
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 if (common_idx == 0) {
6124 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6125 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6126 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6127 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006128 }
6129
Gabor Mezei15b95a62022-05-09 16:37:58 +02006130 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006131 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006132}
6133
Ronald Crone68ab4f2022-10-05 12:46:29 +02006134#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006135
Jerry Yudc7bd172022-02-17 13:44:15 +08006136#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6137
Jerry Yudc7bd172022-02-17 13:44:15 +08006138
Gilles Peskine449bd832023-01-11 14:50:10 +01006139static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6140 mbedtls_svc_key_id_t key,
6141 psa_algorithm_t alg,
6142 const unsigned char *raw_psk, size_t raw_psk_length,
6143 const unsigned char *seed, size_t seed_length,
6144 const unsigned char *label, size_t label_length,
6145 const unsigned char *other_secret,
6146 size_t other_secret_length,
6147 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006148{
6149 psa_status_t status;
6150
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 status = psa_key_derivation_setup(derivation, alg);
6152 if (status != PSA_SUCCESS) {
6153 return status;
6154 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006155
Gilles Peskine449bd832023-01-11 14:50:10 +01006156 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6157 status = psa_key_derivation_input_bytes(derivation,
6158 PSA_KEY_DERIVATION_INPUT_SEED,
6159 seed, seed_length);
6160 if (status != PSA_SUCCESS) {
6161 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006162 }
6163
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 if (other_secret != NULL) {
6165 status = psa_key_derivation_input_bytes(derivation,
6166 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6167 other_secret, other_secret_length);
6168 if (status != PSA_SUCCESS) {
6169 return status;
6170 }
6171 }
6172
6173 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006174 status = psa_key_derivation_input_bytes(
6175 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 raw_psk, raw_psk_length);
6177 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006178 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006180 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006181 if (status != PSA_SUCCESS) {
6182 return status;
6183 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006184
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 status = psa_key_derivation_input_bytes(derivation,
6186 PSA_KEY_DERIVATION_INPUT_LABEL,
6187 label, label_length);
6188 if (status != PSA_SUCCESS) {
6189 return status;
6190 }
6191 } else {
6192 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006193 }
6194
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 status = psa_key_derivation_set_capacity(derivation, capacity);
6196 if (status != PSA_SUCCESS) {
6197 return status;
6198 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006199
Gilles Peskine449bd832023-01-11 14:50:10 +01006200 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006201}
6202
Andrzej Kurek57d10632022-10-24 10:32:01 -04006203#if defined(PSA_WANT_ALG_SHA_384) || \
6204 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006205MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006206static int tls_prf_generic(mbedtls_md_type_t md_type,
6207 const unsigned char *secret, size_t slen,
6208 const char *label,
6209 const unsigned char *random, size_t rlen,
6210 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006211{
6212 psa_status_t status;
6213 psa_algorithm_t alg;
6214 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6215 psa_key_derivation_operation_t derivation =
6216 PSA_KEY_DERIVATION_OPERATION_INIT;
6217
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006219 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006221 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006223
6224 /* Normally a "secret" should be long enough to be impossible to
6225 * find by brute force, and in particular should not be empty. But
6226 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6227 * and for this use case it makes sense to have a 0-length "secret".
6228 * Since the key API doesn't allow importing a key of length 0,
6229 * keep master_key=0, which setup_psa_key_derivation() understands
6230 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006232 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6234 psa_set_key_algorithm(&key_attributes, alg);
6235 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006236
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6238 if (status != PSA_SUCCESS) {
6239 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6240 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006241 }
6242
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 status = setup_psa_key_derivation(&derivation,
6244 master_key, alg,
6245 NULL, 0,
6246 random, rlen,
6247 (unsigned char const *) label,
6248 (size_t) strlen(label),
6249 NULL, 0,
6250 dlen);
6251 if (status != PSA_SUCCESS) {
6252 psa_key_derivation_abort(&derivation);
6253 psa_destroy_key(master_key);
6254 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006255 }
6256
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6258 if (status != PSA_SUCCESS) {
6259 psa_key_derivation_abort(&derivation);
6260 psa_destroy_key(master_key);
6261 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006262 }
6263
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 status = psa_key_derivation_abort(&derivation);
6265 if (status != PSA_SUCCESS) {
6266 psa_destroy_key(master_key);
6267 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006268 }
6269
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 if (!mbedtls_svc_key_id_is_null(master_key)) {
6271 status = psa_destroy_key(master_key);
6272 }
6273 if (status != PSA_SUCCESS) {
6274 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6275 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006276
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006278}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006279#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006280
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006281#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006282MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006283static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6284 const char *label,
6285 const unsigned char *random, size_t rlen,
6286 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006287{
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6289 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006290}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006291#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006292
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006293#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006294MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006295static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6296 const char *label,
6297 const unsigned char *random, size_t rlen,
6298 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006299{
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6301 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006302}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006303#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006304
Jerry Yuf009d862022-02-17 14:01:37 +08006305/*
6306 * Set appropriate PRF function and other SSL / TLS1.2 functions
6307 *
6308 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006309 * - hash associated with the ciphersuite (only used by TLS 1.2)
6310 *
6311 * Outputs:
6312 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6313 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006314MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006315static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6316 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006317{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006318#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006319 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006320 handshake->tls_prf = tls_prf_sha384;
6321 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6322 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006324#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006325#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006326 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006327 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006328 handshake->tls_prf = tls_prf_sha256;
6329 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6330 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6331 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006332#else
Jerry Yuf009d862022-02-17 14:01:37 +08006333 {
Jerry Yuf009d862022-02-17 14:01:37 +08006334 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006335 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006337 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006338#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006339
Gilles Peskine449bd832023-01-11 14:50:10 +01006340 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006341}
Jerry Yud6ab2352022-02-17 14:03:43 +08006342
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006343/*
6344 * Compute master secret if needed
6345 *
6346 * Parameters:
6347 * [in/out] handshake
6348 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6349 * (PSA-PSK) ciphersuite_info, psk_opaque
6350 * [out] premaster (cleared)
6351 * [out] master
6352 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6353 * debug: conf->f_dbg, conf->p_dbg
6354 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006355 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006356 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006357MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006358static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6359 unsigned char *master,
6360 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006361{
6362 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6363
6364 /* cf. RFC 5246, Section 8.1:
6365 * "The master secret is always exactly 48 bytes in length." */
6366 size_t const master_secret_len = 48;
6367
6368#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6369 unsigned char session_hash[48];
6370#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6371
6372 /* The label for the KDF used for key expansion.
6373 * This is either "master secret" or "extended master secret"
6374 * depending on whether the Extended Master Secret extension
6375 * is used. */
6376 char const *lbl = "master secret";
6377
Przemek Stekielae4ed302022-04-05 17:15:55 +02006378 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006379 * - If the Extended Master Secret extension is not used,
6380 * this is ClientHello.Random + ServerHello.Random
6381 * (see Sect. 8.1 in RFC 5246).
6382 * - If the Extended Master Secret extension is used,
6383 * this is the transcript of the handshake so far.
6384 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006385 unsigned char const *seed = handshake->randbytes;
6386 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006387
6388#if !defined(MBEDTLS_DEBUG_C) && \
6389 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006390 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006391 ssl = NULL; /* make sure we don't use it except for those cases */
6392 (void) ssl;
6393#endif
6394
Gilles Peskine449bd832023-01-11 14:50:10 +01006395 if (handshake->resume != 0) {
6396 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6397 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006398 }
6399
6400#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006401 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006402 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006403 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006404 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6405 if (ret != 0) {
6406 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6407 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006408
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6410 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006411 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006412#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006413
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006414#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006416 /* Perform PSK-to-MS expansion in a single step. */
6417 psa_status_t status;
6418 psa_algorithm_t alg;
6419 mbedtls_svc_key_id_t psk;
6420 psa_key_derivation_operation_t derivation =
6421 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006422 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006423
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006427
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006429 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006431 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006432 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006433
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006434 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006436
Gilles Peskine449bd832023-01-11 14:50:10 +01006437 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006438 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006439 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006440 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006441 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006442 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6443 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6444 other_secret = handshake->premaster + 2;
6445 break;
6446 default:
6447 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006448 }
6449
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 status = setup_psa_key_derivation(&derivation, psk, alg,
6451 ssl->conf->psk, ssl->conf->psk_len,
6452 seed, seed_len,
6453 (unsigned char const *) lbl,
6454 (size_t) strlen(lbl),
6455 other_secret, other_secret_len,
6456 master_secret_len);
6457 if (status != PSA_SUCCESS) {
6458 psa_key_derivation_abort(&derivation);
6459 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006460 }
6461
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 status = psa_key_derivation_output_bytes(&derivation,
6463 master,
6464 master_secret_len);
6465 if (status != PSA_SUCCESS) {
6466 psa_key_derivation_abort(&derivation);
6467 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006468 }
6469
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 status = psa_key_derivation_abort(&derivation);
6471 if (status != PSA_SUCCESS) {
6472 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6473 }
6474 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006475#endif
6476 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006477#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006479 psa_status_t status;
6480 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6481 psa_key_derivation_operation_t derivation =
6482 PSA_KEY_DERIVATION_OPERATION_INIT;
6483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006485
6486 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6487
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 status = psa_key_derivation_setup(&derivation, alg);
6489 if (status != PSA_SUCCESS) {
6490 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006491 }
6492
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 status = psa_key_derivation_set_capacity(&derivation,
6494 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6495 if (status != PSA_SUCCESS) {
6496 psa_key_derivation_abort(&derivation);
6497 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006498 }
6499
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6501 &derivation);
6502 if (status != PSA_SUCCESS) {
6503 psa_key_derivation_abort(&derivation);
6504 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006505 }
6506
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 status = psa_key_derivation_output_bytes(&derivation,
6508 handshake->premaster,
6509 handshake->pmslen);
6510 if (status != PSA_SUCCESS) {
6511 psa_key_derivation_abort(&derivation);
6512 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6513 }
6514
6515 status = psa_key_derivation_abort(&derivation);
6516 if (status != PSA_SUCCESS) {
6517 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006518 }
6519 }
6520#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6522 lbl, seed, seed_len,
6523 master,
6524 master_secret_len);
6525 if (ret != 0) {
6526 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6527 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006528 }
6529
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6531 handshake->premaster,
6532 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 mbedtls_platform_zeroize(handshake->premaster,
6535 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006536 }
6537
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006539}
6540
Gilles Peskine449bd832023-01-11 14:50:10 +01006541int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006542{
6543 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6544 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6545 ssl->handshake->ciphersuite_info;
6546
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006548
6549 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006551 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 if (ret != 0) {
6553 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6554 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006555 }
6556
6557 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 ret = ssl_compute_master(ssl->handshake,
6559 ssl->session_negotiate->master,
6560 ssl);
6561 if (ret != 0) {
6562 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6563 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006564 }
6565
6566 /* Swap the client and server random values:
6567 * - MS derivation wanted client+server (RFC 5246 8.1)
6568 * - key derivation wants server+client (RFC 5246 6.3) */
6569 {
6570 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 memcpy(tmp, ssl->handshake->randbytes, 64);
6572 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6573 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6574 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006575 }
6576
6577 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006578 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6579 ssl->session_negotiate->ciphersuite,
6580 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006581#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006583#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 ssl->handshake->tls_prf,
6585 ssl->handshake->randbytes,
6586 ssl->tls_version,
6587 ssl->conf->endpoint,
6588 ssl);
6589 if (ret != 0) {
6590 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6591 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006592 }
6593
6594 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6596 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006597
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006599
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006601}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006602
Gilles Peskine449bd832023-01-11 14:50:10 +01006603int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006604{
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006606#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006607 case MBEDTLS_SSL_HASH_SHA384:
6608 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6609 break;
6610#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006611#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006612 case MBEDTLS_SSL_HASH_SHA256:
6613 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6614 break;
6615#endif
6616 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006617 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006618 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006619#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006620 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006621 (void) ssl;
6622#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006624}
6625
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006626static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6627 const psa_hash_operation_t *hs_op,
6628 size_t buffer_size,
6629 unsigned char *hash,
6630 size_t *hlen)
6631{
6632 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006633 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006634
6635#if !defined(MBEDTLS_DEBUG_C)
6636 (void) ssl;
6637#endif
6638 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006639 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006640 if (status != PSA_SUCCESS) {
6641 goto exit;
6642 }
6643
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006644 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006645 if (status != PSA_SUCCESS) {
6646 goto exit;
6647 }
6648
6649 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6650 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6651
6652exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006653 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006654 return mbedtls_md_error_from_psa(status);
6655}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006656
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006657#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006658int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6659 unsigned char *hash,
6660 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006661{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006662 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6663 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006664}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006665#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006666
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006667#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006668int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6669 unsigned char *hash,
6670 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006671{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006672 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6673 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006674}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006675#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006676
Jerry Yuc2c673d2022-02-17 14:20:39 +08006677#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006678MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006679static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006680
6681#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006682int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006683{
6684 /* If renegotiation is not enforced, retransmit until we would reach max
6685 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006686 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006687 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6688 unsigned char doublings = 1;
6689
Gilles Peskine449bd832023-01-11 14:50:10 +01006690 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006691 ++doublings;
6692 ratio >>= 1;
6693 }
6694
Gilles Peskine449bd832023-01-11 14:50:10 +01006695 if (++ssl->renego_records_seen > doublings) {
6696 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6697 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006698 }
6699 }
6700
Gilles Peskine449bd832023-01-11 14:50:10 +01006701 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006702}
6703#endif
6704#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006705
Jerry Yud9526692022-02-17 14:23:47 +08006706/*
6707 * Handshake functions
6708 */
6709#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6710/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006711int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006712{
6713 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6714 ssl->handshake->ciphersuite_info;
6715
Gilles Peskine449bd832023-01-11 14:50:10 +01006716 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006717
Gilles Peskine449bd832023-01-11 14:50:10 +01006718 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6719 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006720 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006721 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006722 }
6723
Gilles Peskine449bd832023-01-11 14:50:10 +01006724 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6725 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006726}
6727
Gilles Peskine449bd832023-01-11 14:50:10 +01006728int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006729{
6730 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6731 ssl->handshake->ciphersuite_info;
6732
Gilles Peskine449bd832023-01-11 14:50:10 +01006733 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006734
Gilles Peskine449bd832023-01-11 14:50:10 +01006735 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6736 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006737 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006738 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006739 }
6740
Gilles Peskine449bd832023-01-11 14:50:10 +01006741 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6742 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006743}
6744
6745#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6746/* Some certificate support -> implement write and parse */
6747
Gilles Peskine449bd832023-01-11 14:50:10 +01006748int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006749{
6750 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6751 size_t i, n;
6752 const mbedtls_x509_crt *crt;
6753 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6754 ssl->handshake->ciphersuite_info;
6755
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006757
Gilles Peskine449bd832023-01-11 14:50:10 +01006758 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6759 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006760 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006761 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006762 }
6763
6764#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6766 if (ssl->handshake->client_auth == 0) {
6767 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006768 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006770 }
6771 }
6772#endif /* MBEDTLS_SSL_CLI_C */
6773#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6775 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006776 /* Should never happen because we shouldn't have picked the
6777 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006779 }
6780 }
6781#endif
6782
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006784
6785 /*
6786 * 0 . 0 handshake type
6787 * 1 . 3 handshake length
6788 * 4 . 6 length of all certs
6789 * 7 . 9 length of cert. 1
6790 * 10 . n-1 peer certificate
6791 * n . n+2 length of cert. 2
6792 * n+3 . ... upper level cert, etc.
6793 */
6794 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006795 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006796
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006798 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006799 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6800 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6801 " > %" MBEDTLS_PRINTF_SIZET,
6802 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6803 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006804 }
6805
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6807 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6808 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006809
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006811 i += n; crt = crt->next;
6812 }
6813
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6815 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6816 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006817
6818 ssl->out_msglen = i;
6819 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6820 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6821
6822 ssl->state++;
6823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6825 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6826 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006827 }
6828
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006830
Gilles Peskine449bd832023-01-11 14:50:10 +01006831 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006832}
6833
6834#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6835
6836#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006837MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006838static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6839 unsigned char *crt_buf,
6840 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006841{
6842 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6843
Gilles Peskine449bd832023-01-11 14:50:10 +01006844 if (peer_crt == NULL) {
6845 return -1;
6846 }
Jerry Yud9526692022-02-17 14:23:47 +08006847
Gilles Peskine449bd832023-01-11 14:50:10 +01006848 if (peer_crt->raw.len != crt_buf_len) {
6849 return -1;
6850 }
Jerry Yud9526692022-02-17 14:23:47 +08006851
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006853}
6854#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006855MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006856static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6857 unsigned char *crt_buf,
6858 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006859{
6860 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6861 unsigned char const * const peer_cert_digest =
6862 ssl->session->peer_cert_digest;
6863 mbedtls_md_type_t const peer_cert_digest_type =
6864 ssl->session->peer_cert_digest_type;
6865 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006866 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006867 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6868 size_t digest_len;
6869
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 if (peer_cert_digest == NULL || digest_info == NULL) {
6871 return -1;
6872 }
Jerry Yud9526692022-02-17 14:23:47 +08006873
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 digest_len = mbedtls_md_get_size(digest_info);
6875 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6876 return -1;
6877 }
Jerry Yud9526692022-02-17 14:23:47 +08006878
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6880 if (ret != 0) {
6881 return -1;
6882 }
Jerry Yud9526692022-02-17 14:23:47 +08006883
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006885}
6886#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6887#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6888
6889/*
6890 * Once the certificate message is read, parse it into a cert chain and
6891 * perform basic checks, but leave actual verification to the caller
6892 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006893MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006894static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6895 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006896{
6897 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6898#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006900#endif
6901 size_t i, n;
6902 uint8_t alert;
6903
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6905 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6906 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6907 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6908 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006909 }
6910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6912 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6913 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6914 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006915 }
6916
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6918 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6919 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6920 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6921 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006922 }
6923
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006925
6926 /*
6927 * Same message structure as in mbedtls_ssl_write_certificate()
6928 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006929 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006930
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 if (ssl->in_msg[i] != 0 ||
6932 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
6933 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6934 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6935 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6936 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006937 }
6938
6939 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6940 i += 3;
6941
6942 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006943 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08006944 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 if (i + 3 > ssl->in_hslen) {
6946 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6947 mbedtls_ssl_send_alert_message(ssl,
6948 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6949 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6950 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006951 }
6952 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6953 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 if (ssl->in_msg[i] != 0) {
6955 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6956 mbedtls_ssl_send_alert_message(ssl,
6957 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6958 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
6959 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006960 }
6961
6962 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006963 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006964 i += 3;
6965
Gilles Peskine449bd832023-01-11 14:50:10 +01006966 if (n < 128 || i + n > ssl->in_hslen) {
6967 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6968 mbedtls_ssl_send_alert_message(ssl,
6969 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6970 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6971 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006972 }
6973
6974 /* Check if we're handling the first CRT in the chain. */
6975#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08006977 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006978 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08006979 /* During client-side renegotiation, check that the server's
6980 * end-CRTs hasn't changed compared to the initial handshake,
6981 * mitigating the triple handshake attack. On success, reuse
6982 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006983 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
6984 if (ssl_check_peer_crt_unchanged(ssl,
6985 &ssl->in_msg[i],
6986 n) != 0) {
6987 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
6988 mbedtls_ssl_send_alert_message(ssl,
6989 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6990 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
6991 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006992 }
6993
6994 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006995 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08006996 }
6997#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6998
6999 /* Parse the next certificate in the chain. */
7000#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007002#else
7003 /* If we don't need to store the CRT chain permanently, parse
7004 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007005 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007006#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007007 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007008 case 0: /*ok*/
7009 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7010 /* Ignore certificate with an unknown algorithm: maybe a
7011 prior certificate was already trusted. */
7012 break;
7013
7014 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7015 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7016 goto crt_parse_der_failed;
7017
7018 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7019 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7020 goto crt_parse_der_failed;
7021
7022 default:
7023 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007024crt_parse_der_failed:
7025 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7026 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7027 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007028 }
7029
7030 i += n;
7031 }
7032
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7034 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007035}
7036
7037#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007038MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007039static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007040{
Gilles Peskine449bd832023-01-11 14:50:10 +01007041 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7042 return -1;
7043 }
Jerry Yud9526692022-02-17 14:23:47 +08007044
Gilles Peskine449bd832023-01-11 14:50:10 +01007045 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007046 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7047 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7049 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7050 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007051 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007053}
7054#endif /* MBEDTLS_SSL_SRV_C */
7055
7056/* Check if a certificate message is expected.
7057 * Return either
7058 * - SSL_CERTIFICATE_EXPECTED, or
7059 * - SSL_CERTIFICATE_SKIP
7060 * indicating whether a Certificate message is expected or not.
7061 */
7062#define SSL_CERTIFICATE_EXPECTED 0
7063#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007064MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007065static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7066 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007067{
7068 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7069 ssl->handshake->ciphersuite_info;
7070
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7072 return SSL_CERTIFICATE_SKIP;
7073 }
Jerry Yud9526692022-02-17 14:23:47 +08007074
7075#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007078 ssl->session_negotiate->verify_result =
7079 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007081 }
7082 }
7083#else
7084 ((void) authmode);
7085#endif /* MBEDTLS_SSL_SRV_C */
7086
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007088}
7089
Jerry Yud9526692022-02-17 14:23:47 +08007090#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007091MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007092static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7093 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007094{
7095 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7096 /* Remember digest of the peer's end-CRT. */
7097 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007098 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7099 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7100 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7101 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7102 mbedtls_ssl_send_alert_message(ssl,
7103 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7104 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007105
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007107 }
7108
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 ret = mbedtls_md(mbedtls_md_info_from_type(
7110 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7111 start, len,
7112 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007113
7114 ssl->session_negotiate->peer_cert_digest_type =
7115 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7116 ssl->session_negotiate->peer_cert_digest_len =
7117 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7118
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007120}
7121
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007122MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007123static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7124 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007125{
7126 unsigned char *end = start + len;
7127 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7128
7129 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7131 ret = mbedtls_pk_parse_subpubkey(&start, end,
7132 &ssl->handshake->peer_pubkey);
7133 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007134 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007136 }
7137
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007139}
7140#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7141
Gilles Peskine449bd832023-01-11 14:50:10 +01007142int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007143{
7144 int ret = 0;
7145 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007146 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007147#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7148 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7149 ? ssl->handshake->sni_authmode
7150 : ssl->conf->authmode;
7151#else
7152 const int authmode = ssl->conf->authmode;
7153#endif
7154 void *rs_ctx = NULL;
7155 mbedtls_x509_crt *chain = NULL;
7156
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007158
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7160 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7161 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007162 goto exit;
7163 }
7164
7165#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 if (ssl->handshake->ecrs_enabled &&
7167 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007168 chain = ssl->handshake->ecrs_peer_cert;
7169 ssl->handshake->ecrs_peer_cert = NULL;
7170 goto crt_verify;
7171 }
7172#endif
7173
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007175 /* mbedtls_ssl_read_record may have sent an alert already. We
7176 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007177 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007178 goto exit;
7179 }
7180
7181#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007183 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7184
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007186 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007187 }
Jerry Yud9526692022-02-17 14:23:47 +08007188
7189 goto exit;
7190 }
7191#endif /* MBEDTLS_SSL_SRV_C */
7192
7193 /* Clear existing peer CRT structure in case we tried to
7194 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007196
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7198 if (chain == NULL) {
7199 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7200 sizeof(mbedtls_x509_crt)));
7201 mbedtls_ssl_send_alert_message(ssl,
7202 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7203 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007204
7205 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7206 goto exit;
7207 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007209
Gilles Peskine449bd832023-01-11 14:50:10 +01007210 ret = ssl_parse_certificate_chain(ssl, chain);
7211 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007212 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 }
Jerry Yud9526692022-02-17 14:23:47 +08007214
7215#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007217 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 }
Jerry Yud9526692022-02-17 14:23:47 +08007219
7220crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007221 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007222 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 }
Jerry Yud9526692022-02-17 14:23:47 +08007224#endif
7225
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007226 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7227 ssl->handshake->ciphersuite_info,
7228 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007230 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007231 }
Jerry Yud9526692022-02-17 14:23:47 +08007232
7233#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7234 {
7235 unsigned char *crt_start, *pk_start;
7236 size_t crt_len, pk_len;
7237
7238 /* We parse the CRT chain without copying, so
7239 * these pointers point into the input buffer,
7240 * and are hence still valid after freeing the
7241 * CRT chain. */
7242
7243 crt_start = chain->raw.p;
7244 crt_len = chain->raw.len;
7245
7246 pk_start = chain->pk_raw.p;
7247 pk_len = chain->pk_raw.len;
7248
7249 /* Free the CRT structures before computing
7250 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007251 mbedtls_x509_crt_free(chain);
7252 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007253 chain = NULL;
7254
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7256 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007257 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 }
Jerry Yud9526692022-02-17 14:23:47 +08007259
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7261 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007262 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 }
Jerry Yud9526692022-02-17 14:23:47 +08007264 }
7265#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7266 /* Pass ownership to session structure. */
7267 ssl->session_negotiate->peer_cert = chain;
7268 chain = NULL;
7269#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7270
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007272
7273exit:
7274
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007276 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 }
Jerry Yud9526692022-02-17 14:23:47 +08007278
7279#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007281 ssl->handshake->ecrs_peer_cert = chain;
7282 chain = NULL;
7283 }
7284#endif
7285
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 if (chain != NULL) {
7287 mbedtls_x509_crt_free(chain);
7288 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007289 }
7290
Gilles Peskine449bd832023-01-11 14:50:10 +01007291 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007292}
7293#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7294
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007295static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7296 unsigned char *padbuf, size_t hlen,
7297 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007298{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007299 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007300 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007301 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007302 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007303 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007304 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007305
7306 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007308 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007310
Gilles Peskine449bd832023-01-11 14:50:10 +01007311 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007312 ? "client finished"
7313 : "server finished";
7314
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007315 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007316
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007317 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007318 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007319 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007320 }
7321
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007322 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007324 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007325 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007326 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007327
7328 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7329
Jerry Yu615bd6f2022-02-17 14:25:15 +08007330 /*
7331 * TLSv1.2:
7332 * hash = PRF( master, finished_label,
7333 * Hash( handshake ) )[0.11]
7334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007336 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007337
Gilles Peskine449bd832023-01-11 14:50:10 +01007338 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007339
Paul Elliottecb95be2023-08-11 16:41:04 +01007340 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007341
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007342 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007343
7344exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007345 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007346 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007347}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007348
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007349#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007350static int ssl_calc_finished_tls_sha256(
7351 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7352{
7353 unsigned char padbuf[32];
7354 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007355 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007356 padbuf, sizeof(padbuf),
7357 buf, from);
7358}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007359#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007360
Jerry Yub7ba49e2022-02-17 14:25:53 +08007361
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007362#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007363static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007364 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007365{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007366 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007367 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007368 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007369 padbuf, sizeof(padbuf),
7370 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007371}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007372#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007373
Gilles Peskine449bd832023-01-11 14:50:10 +01007374void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007375{
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007377
7378 /*
7379 * Free our handshake params
7380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 mbedtls_ssl_handshake_free(ssl);
7382 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007383 ssl->handshake = NULL;
7384
7385 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007386 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007387 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 if (ssl->transform) {
7389 mbedtls_ssl_transform_free(ssl->transform);
7390 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007391 }
7392 ssl->transform = ssl->transform_negotiate;
7393 ssl->transform_negotiate = NULL;
7394
Gilles Peskine449bd832023-01-11 14:50:10 +01007395 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007396}
7397
Gilles Peskine449bd832023-01-11 14:50:10 +01007398void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007399{
7400 int resume = ssl->handshake->resume;
7401
Gilles Peskine449bd832023-01-11 14:50:10 +01007402 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007403
7404#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007406 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7407 ssl->renego_records_seen = 0;
7408 }
7409#endif
7410
7411 /*
7412 * Free the previous session and switch in the current one
7413 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007415#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7416 /* RFC 7366 3.1: keep the EtM state */
7417 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007419#endif
7420
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 mbedtls_ssl_session_free(ssl->session);
7422 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007423 }
7424 ssl->session = ssl->session_negotiate;
7425 ssl->session_negotiate = NULL;
7426
7427 /*
7428 * Add cache entry
7429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007431 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 resume == 0) {
7433 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7434 ssl->session->id,
7435 ssl->session->id_len,
7436 ssl->session) != 0) {
7437 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7438 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007439 }
7440
7441#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7443 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007444 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007446
7447 /* Keep last flight around in case we need to resend it:
7448 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7450 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007451#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007453
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007454 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007455
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007457}
7458
Gilles Peskine449bd832023-01-11 14:50:10 +01007459int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007460{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007461 int ret;
7462 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007465
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007467
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007468 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7469 if (ret != 0) {
7470 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7471 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007472
7473 /*
7474 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7475 * may define some other value. Currently (early 2016), no defined
7476 * ciphersuite does this (and this is unlikely to change as activity has
7477 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7478 */
7479 hash_len = 12;
7480
7481#if defined(MBEDTLS_SSL_RENEGOTIATION)
7482 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007484#endif
7485
7486 ssl->out_msglen = 4 + hash_len;
7487 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7488 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7489
7490 /*
7491 * In case of session resuming, invert the client and server
7492 * ChangeCipherSpec messages order.
7493 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007495#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007497 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007499#endif
7500#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007502 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007504#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007506 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007508
7509 /*
7510 * Switch to our negotiated transform and session parameters for outbound
7511 * data.
7512 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007514
7515#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007517 unsigned char i;
7518
7519 /* Remember current epoch settings for resending */
7520 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7522 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007523
7524 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007526
7527
7528 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 for (i = 2; i > 0; i--) {
7530 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007531 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 }
7533 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007534
7535 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 if (i == 0) {
7537 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7538 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007539 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007541#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007542 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007543
7544 ssl->transform_out = ssl->transform_negotiate;
7545 ssl->session_out = ssl->session_negotiate;
7546
7547#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7549 mbedtls_ssl_send_flight_completed(ssl);
7550 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007551#endif
7552
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7554 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7555 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007556 }
7557
7558#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7560 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7561 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7562 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007563 }
7564#endif
7565
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007567
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007569}
7570
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007571#define SSL_MAX_HASH_LEN 12
7572
Gilles Peskine449bd832023-01-11 14:50:10 +01007573int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007574{
7575 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7576 unsigned int hash_len = 12;
7577 unsigned char buf[SSL_MAX_HASH_LEN];
7578
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007580
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007581 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7582 if (ret != 0) {
7583 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7584 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007585
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7587 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007588 goto exit;
7589 }
7590
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7592 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7593 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7594 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007595 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7596 goto exit;
7597 }
7598
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7600 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7601 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007602 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7603 goto exit;
7604 }
7605
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7607 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7608 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7609 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007610 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7611 goto exit;
7612 }
7613
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7615 buf, hash_len) != 0) {
7616 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7617 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7618 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007619 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7620 goto exit;
7621 }
7622
7623#if defined(MBEDTLS_SSL_RENEGOTIATION)
7624 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007626#endif
7627
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007629#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007631 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007633#endif
7634#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007636 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007638#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007640 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007642
7643#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7645 mbedtls_ssl_recv_flight_completed(ssl);
7646 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007647#endif
7648
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007650
7651exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 mbedtls_platform_zeroize(buf, hash_len);
7653 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007654}
7655
Jerry Yu392112c2022-02-17 14:34:10 +08007656#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7657/*
7658 * Helper to get TLS 1.2 PRF from ciphersuite
7659 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7660 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007661static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007662{
Jerry Yu392112c2022-02-17 14:34:10 +08007663 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007665#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7667 return tls_prf_sha384;
7668 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007669#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007670#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007671 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007672 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7673 return tls_prf_sha256;
7674 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007675 }
7676#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007677#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007678 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007679 (void) ciphersuite_info;
7680#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007681
Gilles Peskine449bd832023-01-11 14:50:10 +01007682 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007683}
7684#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007685
Gilles Peskine449bd832023-01-11 14:50:10 +01007686static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007687{
7688 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007689#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007690 if (tls_prf == tls_prf_sha384) {
7691 return MBEDTLS_SSL_TLS_PRF_SHA384;
7692 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007693#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007694#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 if (tls_prf == tls_prf_sha256) {
7696 return MBEDTLS_SSL_TLS_PRF_SHA256;
7697 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007698#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007700}
7701
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007702/*
7703 * Populate a transform structure with session keys and all the other
7704 * necessary information.
7705 *
7706 * Parameters:
7707 * - [in/out]: transform: structure to populate
7708 * [in] must be just initialised with mbedtls_ssl_transform_init()
7709 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7710 * - [in] ciphersuite
7711 * - [in] master
7712 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007713 * - [in] tls_prf: pointer to PRF to use for key derivation
7714 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007715 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007716 * - [in] endpoint: client or server
7717 * - [in] ssl: used for:
7718 * - ssl->conf->{f,p}_export_keys
7719 * [in] optionally used for:
7720 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7721 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007722MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007723static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7724 int ciphersuite,
7725 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007726#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007727 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007728#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 ssl_tls_prf_t tls_prf,
7730 const unsigned char randbytes[64],
7731 mbedtls_ssl_protocol_version tls_version,
7732 unsigned endpoint,
7733 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007734{
7735 int ret = 0;
7736 unsigned char keyblk[256];
7737 unsigned char *key1;
7738 unsigned char *key2;
7739 unsigned char *mac_enc;
7740 unsigned char *mac_dec;
7741 size_t mac_key_len = 0;
7742 size_t iv_copy_len;
7743 size_t keylen;
7744 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007745 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007746
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007747 psa_key_type_t key_type;
7748 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7749 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007750 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007751 size_t key_bits;
7752 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007753
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007754 /*
7755 * Some data just needs copying into the structure
7756 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007757#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007758 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007759#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007760 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007761
7762#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007763 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007764#endif
7765
7766#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007767 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007768 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7769 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007770 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007771 }
7772#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7773
7774 /*
7775 * Get various info structures
7776 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007777 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7778 if (ciphersuite_info == NULL) {
7779 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7780 ciphersuite));
7781 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007782 }
7783
Neil Armstrongab555e02022-04-04 11:07:59 +02007784 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007785#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007787#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007789
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007791 transform->taglen =
7792 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007794
Dave Rodgman2eab4622023-10-05 13:30:37 +01007795 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 transform->taglen,
7797 &alg,
7798 &key_type,
7799 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007800 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007802 goto end;
7803 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007804
Dave Rodgman2eab4622023-10-05 13:30:37 +01007805 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007807 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 (unsigned) ciphersuite_info->mac));
7809 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007810 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007811
7812#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7813 /* Copy own and peer's CID if the use of the CID
7814 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7816 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007817
7818 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007819 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7820 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7821 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007822
7823 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007824 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7825 ssl->handshake->peer_cid_len);
7826 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7827 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007828 }
7829#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7830
7831 /*
7832 * Compute key block using the PRF
7833 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007834 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7835 if (ret != 0) {
7836 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7837 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007838 }
7839
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7841 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7842 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7843 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7844 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007845
7846 /*
7847 * Determine the appropriate key, IV and MAC length.
7848 */
7849
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007850 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007851
Valerio Settie5707042023-10-11 11:54:42 +02007852#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007854 size_t explicit_ivlen;
7855
7856 transform->maclen = 0;
7857 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007858
7859 /* All modes haves 96-bit IVs, but the length of the static parts vary
7860 * with mode and version:
7861 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7862 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7863 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7864 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7865 * sequence number).
7866 */
7867 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007868
7869 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007871
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007873 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007874 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007875 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007876 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007877
7878 /* Minimum length of encrypted record */
7879 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7880 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007881 } else
Valerio Settie5707042023-10-11 11:54:42 +02007882#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007883#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007885 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007888
Neil Armstronge4512952022-03-08 09:08:22 +01007889 /* Get MAC length */
7890 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007891 transform->maclen = mac_key_len;
7892
7893 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007894 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007895
7896 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007898 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007899 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007900 /*
7901 * GenericBlockCipher:
7902 * 1. if EtM is in use: one block plus MAC
7903 * otherwise: * first multiple of blocklen greater than maclen
7904 * 2. IV
7905 */
7906#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007908 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 + block_size;
7910 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007911#endif
7912 {
7913 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 + block_size
7915 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007916 }
7917
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007919 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 } else {
7921 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007922 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7923 goto end;
7924 }
7925 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007927#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7928 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7930 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007931 }
7932
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7934 (unsigned) keylen,
7935 (unsigned) transform->minlen,
7936 (unsigned) transform->ivlen,
7937 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007938
7939 /*
7940 * Finally setup the cipher contexts, IVs and MAC secrets.
7941 */
7942#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007943 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007944 key1 = keyblk + mac_key_len * 2;
7945 key2 = keyblk + mac_key_len * 2 + keylen;
7946
7947 mac_enc = keyblk;
7948 mac_dec = keyblk + mac_key_len;
7949
Gilles Peskine449bd832023-01-11 14:50:10 +01007950 iv_copy_len = (transform->fixed_ivlen) ?
7951 transform->fixed_ivlen : transform->ivlen;
7952 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
7953 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
7954 iv_copy_len);
7955 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007956#endif /* MBEDTLS_SSL_CLI_C */
7957#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007959 key1 = keyblk + mac_key_len * 2 + keylen;
7960 key2 = keyblk + mac_key_len * 2;
7961
7962 mac_enc = keyblk + mac_key_len;
7963 mac_dec = keyblk;
7964
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 iv_copy_len = (transform->fixed_ivlen) ?
7966 transform->fixed_ivlen : transform->ivlen;
7967 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
7968 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
7969 iv_copy_len);
7970 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007971#endif /* MBEDTLS_SSL_SRV_C */
7972 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007974 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7975 goto end;
7976 }
7977
Paul Elliott4fb19552023-10-18 12:15:30 +01007978 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007979 ssl->f_export_keys(ssl->p_export_keys,
7980 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7981 master, 48,
7982 randbytes + 32,
7983 randbytes,
7984 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007985 }
7986
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007987 transform->psa_alg = alg;
7988
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
7990 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
7991 psa_set_key_algorithm(&attributes, alg);
7992 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007993
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 if ((status = psa_import_key(&attributes,
7995 key1,
7996 PSA_BITS_TO_BYTES(key_bits),
7997 &transform->psa_key_enc)) != PSA_SUCCESS) {
7998 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007999 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008001 goto end;
8002 }
8003
Gilles Peskine449bd832023-01-11 14:50:10 +01008004 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008005
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 if ((status = psa_import_key(&attributes,
8007 key2,
8008 PSA_BITS_TO_BYTES(key_bits),
8009 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008010 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008012 goto end;
8013 }
8014 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008015
Neil Armstrong29c0c042022-03-17 17:47:28 +01008016#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8017 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8018 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008020 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008021
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8023 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8024 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008025
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 if ((status = psa_import_key(&attributes,
8027 mac_enc, mac_key_len,
8028 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008029 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008031 goto end;
8032 }
8033
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8035 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008036#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008038#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008039 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008040 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008041 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8042 PSA_KEY_USAGE_VERIFY_HASH);
8043 } else {
8044 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8045 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008046
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 if ((status = psa_import_key(&attributes,
8048 mac_dec, mac_key_len,
8049 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008050 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008052 goto end;
8053 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008054 }
8055#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8056
8057 ((void) mac_dec);
8058 ((void) mac_enc);
8059
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008060end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008061 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8062 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008063}
8064
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008065#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008066int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008067 psa_pake_operation_t *pake_ctx,
8068 const unsigned char *buf,
8069 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008070{
8071 psa_status_t status;
8072 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008073 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008074 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8075 * At round two perform a single cycle
8076 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008078
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 for (; remaining_steps > 0; remaining_steps--) {
8080 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008081 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008082 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008083 /* Length is stored at the first byte */
8084 size_t length = buf[input_offset];
8085 input_offset += 1;
8086
Gilles Peskine449bd832023-01-11 14:50:10 +01008087 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008088 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8089 }
8090
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 status = psa_pake_input(pake_ctx, step,
8092 buf + input_offset, length);
8093 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008094 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008095 }
8096
8097 input_offset += length;
8098 }
8099 }
8100
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008102 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008104
Gilles Peskine449bd832023-01-11 14:50:10 +01008105 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008106}
8107
Valerio Setti6b3dab02022-11-17 17:14:54 +01008108int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 psa_pake_operation_t *pake_ctx,
8110 unsigned char *buf,
8111 size_t len, size_t *olen,
8112 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008113{
8114 psa_status_t status;
8115 size_t output_offset = 0;
8116 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008117 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008118 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8119 * At round two perform a single cycle
8120 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008121 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008122
Gilles Peskine449bd832023-01-11 14:50:10 +01008123 for (; remaining_steps > 0; remaining_steps--) {
8124 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8125 step <= PSA_PAKE_STEP_ZK_PROOF;
8126 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008127 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008128 * For each step, prepend 1 byte with the length of the data as
8129 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008130 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008131 status = psa_pake_output(pake_ctx, step,
8132 buf + output_offset + 1,
8133 len - output_offset - 1,
8134 &output_len);
8135 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008136 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008137 }
8138
Valerio Setti99d88c12022-11-22 16:03:43 +01008139 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008140
8141 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008142 }
8143 }
8144
8145 *olen = output_offset;
8146
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008148}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008149#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008150
Gilles Peskine449bd832023-01-11 14:50:10 +01008151int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8152 unsigned char *hash, size_t *hashlen,
8153 unsigned char *data, size_t data_len,
8154 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008155{
8156 psa_status_t status;
8157 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008158 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008159
Gilles Peskine449bd832023-01-11 14:50:10 +01008160 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008161
Gilles Peskine449bd832023-01-11 14:50:10 +01008162 if ((status = psa_hash_setup(&hash_operation,
8163 hash_alg)) != PSA_SUCCESS) {
8164 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008165 goto exit;
8166 }
8167
Gilles Peskine449bd832023-01-11 14:50:10 +01008168 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8169 64)) != PSA_SUCCESS) {
8170 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008171 goto exit;
8172 }
8173
Gilles Peskine449bd832023-01-11 14:50:10 +01008174 if ((status = psa_hash_update(&hash_operation,
8175 data, data_len)) != PSA_SUCCESS) {
8176 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008177 goto exit;
8178 }
8179
Gilles Peskine449bd832023-01-11 14:50:10 +01008180 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8181 hashlen)) != PSA_SUCCESS) {
8182 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8183 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008184 }
8185
8186exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008187 if (status != PSA_SUCCESS) {
8188 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8189 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8190 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008191 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008193 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8194 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008195 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008196 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008197 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008198 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008199 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008200 }
8201 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008202 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008203}
8204
Jerry Yuee40f9d2022-02-17 14:55:16 +08008205
Jerry Yud9d91da2022-02-17 14:57:06 +08008206#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8207
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008208/* Find the preferred hash for a given signature algorithm. */
8209unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 mbedtls_ssl_context *ssl,
8211 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008212{
Gabor Mezei078e8032022-04-27 21:17:56 +02008213 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008214 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008215
Gilles Peskine449bd832023-01-11 14:50:10 +01008216 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8217 return MBEDTLS_SSL_HASH_NONE;
8218 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008219
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008221 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008222 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8223 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008224 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008225 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8226 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008227
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008228 mbedtls_md_type_t md_alg =
8229 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8230 if (md_alg == MBEDTLS_MD_NONE) {
8231 continue;
8232 }
8233
Gilles Peskine449bd832023-01-11 14:50:10 +01008234 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008235 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008236 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008237 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008238
Gilles Peskine449bd832023-01-11 14:50:10 +01008239 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8240 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8241 PSA_ALG_ECDSA(psa_hash_alg),
8242 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008243 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008244 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008245
Gilles Peskine449bd832023-01-11 14:50:10 +01008246 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8247 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8248 PSA_ALG_RSA_PKCS1V15_SIGN(
8249 psa_hash_alg),
8250 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008251 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008252 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008253 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008254
Gilles Peskine449bd832023-01-11 14:50:10 +01008255 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008256 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008257 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008258
Gilles Peskine449bd832023-01-11 14:50:10 +01008259 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008260}
8261
8262#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8263
Jerry Yudc7bd172022-02-17 13:44:15 +08008264#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8265
XiaokangQian75d40ef2022-04-20 11:05:24 +00008266int mbedtls_ssl_validate_ciphersuite(
8267 const mbedtls_ssl_context *ssl,
8268 const mbedtls_ssl_ciphersuite_t *suite_info,
8269 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008270 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008271{
8272 (void) ssl;
8273
Gilles Peskine449bd832023-01-11 14:50:10 +01008274 if (suite_info == NULL) {
8275 return -1;
8276 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008277
Gilles Peskine449bd832023-01-11 14:50:10 +01008278 if ((suite_info->min_tls_version > max_tls_version) ||
8279 (suite_info->max_tls_version < min_tls_version)) {
8280 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008281 }
8282
XiaokangQian060d8672022-04-21 09:24:56 +00008283#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008284#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008285 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008286 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008287 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008288 }
8289#endif
8290
8291 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8292#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008293 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8294 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8295 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008296 }
8297#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8298#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8299
Gilles Peskine449bd832023-01-11 14:50:10 +01008300 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008301}
8302
Ronald Crone68ab4f2022-10-05 12:46:29 +02008303#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008304/*
8305 * Function for writing a signature algorithm extension.
8306 *
8307 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8308 * value (TLS 1.3 RFC8446):
8309 * enum {
8310 * ....
8311 * ecdsa_secp256r1_sha256( 0x0403 ),
8312 * ecdsa_secp384r1_sha384( 0x0503 ),
8313 * ecdsa_secp521r1_sha512( 0x0603 ),
8314 * ....
8315 * } SignatureScheme;
8316 *
8317 * struct {
8318 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8319 * } SignatureSchemeList;
8320 *
8321 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8322 * value (TLS 1.2 RFC5246):
8323 * enum {
8324 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8325 * sha512(6), (255)
8326 * } HashAlgorithm;
8327 *
8328 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8329 * SignatureAlgorithm;
8330 *
8331 * struct {
8332 * HashAlgorithm hash;
8333 * SignatureAlgorithm signature;
8334 * } SignatureAndHashAlgorithm;
8335 *
8336 * SignatureAndHashAlgorithm
8337 * supported_signature_algorithms<2..2^16-2>;
8338 *
8339 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8340 * generalization of the TLS 1.2 signature algorithm extension.
8341 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8342 * `SignatureScheme` field of TLS 1.3
8343 *
8344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008345int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8346 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008347{
8348 unsigned char *p = buf;
8349 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8350 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8351
8352 *out_len = 0;
8353
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008355
8356 /* Check if we have space for header and length field:
8357 * - extension_type (2 bytes)
8358 * - extension_data_length (2 bytes)
8359 * - supported_signature_algorithms_length (2 bytes)
8360 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008361 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008362 p += 6;
8363
8364 /*
8365 * Write supported_signature_algorithms
8366 */
8367 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008368 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8369 if (sig_alg == NULL) {
8370 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8371 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008372
Gilles Peskine449bd832023-01-11 14:50:10 +01008373 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8374 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8375 *sig_alg,
8376 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8377 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008378 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008379 }
8380 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8381 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008382 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008383 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8384 *sig_alg,
8385 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008386 }
8387
8388 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008389 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008390 if (supported_sig_alg_len == 0) {
8391 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8392 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008393 }
8394
Gilles Peskine449bd832023-01-11 14:50:10 +01008395 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8396 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8397 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008398
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008399 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008400
8401#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008402 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008403#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008404
Gilles Peskine449bd832023-01-11 14:50:10 +01008405 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008406}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008407#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008408
XiaokangQian40a35232022-05-07 09:02:40 +00008409#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008410/*
8411 * mbedtls_ssl_parse_server_name_ext
8412 *
8413 * Structure of server_name extension:
8414 *
8415 * enum {
8416 * host_name(0), (255)
8417 * } NameType;
8418 * opaque HostName<1..2^16-1>;
8419 *
8420 * struct {
8421 * NameType name_type;
8422 * select (name_type) {
8423 * case host_name: HostName;
8424 * } name;
8425 * } ServerName;
8426 * struct {
8427 * ServerName server_name_list<1..2^16-1>
8428 * } ServerNameList;
8429 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008430MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008431int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8432 const unsigned char *buf,
8433 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008434{
8435 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8436 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008437 size_t server_name_list_len, hostname_len;
8438 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008439
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008441
Gilles Peskine449bd832023-01-11 14:50:10 +01008442 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8443 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008444 p += 2;
8445
Gilles Peskine449bd832023-01-11 14:50:10 +01008446 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008447 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008448 while (p < server_name_list_end) {
8449 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8450 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8451 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8452 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008453
Gilles Peskine449bd832023-01-11 14:50:10 +01008454 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008455 /* sni_name is intended to be used only during the parsing of the
8456 * ClientHello message (it is reset to NULL before the end of
8457 * the message parsing). Thus it is ok to just point to the
8458 * reception buffer and not make a copy of it.
8459 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008460 ssl->handshake->sni_name = p + 3;
8461 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008462 if (ssl->conf->f_sni == NULL) {
8463 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008464 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8466 ssl, p + 3, hostname_len);
8467 if (ret != 0) {
8468 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8469 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8470 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8471 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8472 }
8473 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008474 }
8475
8476 p += hostname_len + 3;
8477 }
8478
Gilles Peskine449bd832023-01-11 14:50:10 +01008479 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008480}
8481#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8482
XiaokangQianacb39922022-06-17 10:18:48 +00008483#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008484MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008485int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8486 const unsigned char *buf,
8487 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008488{
8489 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008490 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008491 const unsigned char *protocol_name_list;
8492 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008493 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008494
8495 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008496 if (ssl->conf->alpn_list == NULL) {
8497 return 0;
8498 }
XiaokangQianacb39922022-06-17 10:18:48 +00008499
8500 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008501 * RFC7301, section 3.1
8502 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008503 *
XiaokangQianc7403452022-06-23 03:24:12 +00008504 * struct {
8505 * ProtocolName protocol_name_list<2..2^16-1>
8506 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008507 */
8508
XiaokangQianc7403452022-06-23 03:24:12 +00008509 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008510 * protocol_name_list_len 2 bytes
8511 * protocol_name_len 1 bytes
8512 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008513 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008515
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008517 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008518 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008519 protocol_name_list = p;
8520 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008521
8522 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008524 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008525 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8526 protocol_name_len);
8527 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008528 MBEDTLS_SSL_PEND_FATAL_ALERT(
8529 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008530 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8531 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008532 }
8533
8534 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008535 }
8536
8537 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01008538 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
8539 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008540 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008541 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008542 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008543 if (protocol_name_len == alpn_len &&
8544 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008545 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008547 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008548
8549 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008550 }
8551 }
8552
XiaokangQian95d5f542022-06-24 02:29:26 +00008553 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008554 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8556 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8557 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008558}
8559
Gilles Peskine449bd832023-01-11 14:50:10 +01008560int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8561 unsigned char *buf,
8562 unsigned char *end,
8563 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008564{
8565 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008566 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008567 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008568
Gilles Peskine449bd832023-01-11 14:50:10 +01008569 if (ssl->alpn_chosen == NULL) {
8570 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008571 }
8572
Gilles Peskine449bd832023-01-11 14:50:10 +01008573 protocol_name_len = strlen(ssl->alpn_chosen);
8574 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008575
Gilles Peskine449bd832023-01-11 14:50:10 +01008576 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008577 /*
8578 * 0 . 1 ext identifier
8579 * 2 . 3 ext length
8580 * 4 . 5 protocol list length
8581 * 6 . 6 protocol name length
8582 * 7 . 7+n protocol name
8583 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008585
XiaokangQian95d5f542022-06-24 02:29:26 +00008586 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008587
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8589 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008590 /* Note: the length of the chosen protocol has been checked to be less
8591 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008593 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008594
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008596
8597#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008598 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008599#endif
8600
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008602}
8603#endif /* MBEDTLS_SSL_ALPN */
8604
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008605#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008606 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008607 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008608 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008609int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8610 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008611{
8612 /* Initialize to suppress unnecessary compiler warning */
8613 size_t hostname_len = 0;
8614
8615 /* Check if new hostname is valid before
8616 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008617 if (hostname != NULL) {
8618 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008619
Gilles Peskine449bd832023-01-11 14:50:10 +01008620 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8621 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8622 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008623 }
8624
8625 /* Now it's clear that we will overwrite the old hostname,
8626 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008628 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008630 }
8631
8632 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008633 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008634 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008635 } else {
8636 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8637 if (session->hostname == NULL) {
8638 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8639 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008640
Gilles Peskine449bd832023-01-11 14:50:10 +01008641 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008642 }
8643
Gilles Peskine449bd832023-01-11 14:50:10 +01008644 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008645}
Xiaokang Qian03409292022-10-12 02:49:52 +00008646#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8647 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008648 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008649 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008650
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008651#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8652 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008653int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8654 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008655{
8656 size_t alpn_len = 0;
8657
8658 if (alpn != NULL) {
8659 alpn_len = strlen(alpn);
8660
8661 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8662 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8663 }
8664 }
8665
8666 if (session->ticket_alpn != NULL) {
8667 mbedtls_zeroize_and_free(session->ticket_alpn,
8668 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008669 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008670 }
8671
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008672 if (alpn != NULL) {
8673 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008674 if (session->ticket_alpn == NULL) {
8675 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8676 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008677 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008678 }
8679
8680 return 0;
8681}
8682#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008683
8684/*
8685 * The following functions are used by 1.2 and 1.3, client and server.
8686 */
8687#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8688int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8689 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8690 int recv_endpoint,
8691 mbedtls_ssl_protocol_version tls_version,
8692 uint32_t *flags)
8693{
8694 int ret = 0;
8695 unsigned int usage = 0;
8696 const char *ext_oid;
8697 size_t ext_len;
8698
8699 /*
8700 * keyUsage
8701 */
8702
8703 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8704 * to check what a compliant client will think while choosing which cert
8705 * to send to the client. */
8706#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8707 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8708 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8709 /* TLS 1.2 server part of the key exchange */
8710 switch (ciphersuite->key_exchange) {
8711 case MBEDTLS_KEY_EXCHANGE_RSA:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008712 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
8713 break;
8714
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008715 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8716 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8717 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8718 break;
8719
8720 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8721 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8722 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8723 break;
8724
8725 /* Don't use default: we want warnings when adding new values */
8726 case MBEDTLS_KEY_EXCHANGE_NONE:
8727 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008728 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8729 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8730 usage = 0;
8731 }
8732 } else
8733#endif
8734 {
8735 /* This is either TLS 1.3 authentication, which always uses signatures,
8736 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8737 * options we implement, both using signatures. */
8738 (void) tls_version;
8739 (void) ciphersuite;
8740 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8741 }
8742
8743 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8744 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8745 ret = -1;
8746 }
8747
8748 /*
8749 * extKeyUsage
8750 */
8751
8752 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8753 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8754 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8755 } else {
8756 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8757 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8758 }
8759
8760 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8761 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8762 ret = -1;
8763 }
8764
8765 return ret;
8766}
8767
8768int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8769 int authmode,
8770 mbedtls_x509_crt *chain,
8771 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8772 void *rs_ctx)
8773{
8774 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8775 return 0;
8776 }
8777
8778 /*
8779 * Primary check: use the appropriate X.509 verification function
8780 */
8781 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8782 void *p_vrfy;
8783 if (ssl->f_vrfy != NULL) {
8784 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8785 f_vrfy = ssl->f_vrfy;
8786 p_vrfy = ssl->p_vrfy;
8787 } else {
8788 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8789 f_vrfy = ssl->conf->f_vrfy;
8790 p_vrfy = ssl->conf->p_vrfy;
8791 }
8792
8793 int ret = 0;
8794 int have_ca_chain_or_callback = 0;
8795#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8796 if (ssl->conf->f_ca_cb != NULL) {
8797 ((void) rs_ctx);
8798 have_ca_chain_or_callback = 1;
8799
8800 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8801 ret = mbedtls_x509_crt_verify_with_ca_cb(
8802 chain,
8803 ssl->conf->f_ca_cb,
8804 ssl->conf->p_ca_cb,
8805 ssl->conf->cert_profile,
8806 ssl->hostname,
8807 &ssl->session_negotiate->verify_result,
8808 f_vrfy, p_vrfy);
8809 } else
8810#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8811 {
8812 mbedtls_x509_crt *ca_chain;
8813 mbedtls_x509_crl *ca_crl;
8814#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8815 if (ssl->handshake->sni_ca_chain != NULL) {
8816 ca_chain = ssl->handshake->sni_ca_chain;
8817 ca_crl = ssl->handshake->sni_ca_crl;
8818 } else
8819#endif
8820 {
8821 ca_chain = ssl->conf->ca_chain;
8822 ca_crl = ssl->conf->ca_crl;
8823 }
8824
8825 if (ca_chain != NULL) {
8826 have_ca_chain_or_callback = 1;
8827 }
8828
8829 ret = mbedtls_x509_crt_verify_restartable(
8830 chain,
8831 ca_chain, ca_crl,
8832 ssl->conf->cert_profile,
8833 ssl->hostname,
8834 &ssl->session_negotiate->verify_result,
8835 f_vrfy, p_vrfy, rs_ctx);
8836 }
8837
8838 if (ret != 0) {
8839 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8840 }
8841
8842#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8843 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8844 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8845 }
8846#endif
8847
8848 /*
8849 * Secondary checks: always done, but change 'ret' only if it was 0
8850 */
8851
8852 /* With TLS 1.2 and ECC certs, check that the curve used by the
8853 * certificate is on our list of acceptable curves.
8854 *
8855 * With TLS 1.3 this is not needed because the curve is part of the
8856 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8857 * we validate the signature made with the key associated to this cert.
8858 */
8859#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8860 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8861 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8862 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8863 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8864 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8865 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8866 if (ret == 0) {
8867 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8868 }
8869 }
8870 }
8871#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8872
8873 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8874 if (mbedtls_ssl_check_cert_usage(chain,
8875 ciphersuite_info,
8876 ssl->conf->endpoint,
8877 ssl->tls_version,
8878 &ssl->session_negotiate->verify_result) != 0) {
8879 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8880 if (ret == 0) {
8881 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8882 }
8883 }
8884
8885 /* With authmode optional, we want to keep going if the certificate was
8886 * unacceptable, but still fail on other errors (out of memory etc),
8887 * including fatal errors from the f_vrfy callback.
8888 *
8889 * The only acceptable errors are:
8890 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8891 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8892 * Anything else is a fatal error. */
8893 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8894 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8895 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8896 ret = 0;
8897 }
8898
8899 /* Return a specific error as this is a user error: inconsistent
8900 * configuration - can't verify without trust anchors. */
8901 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8902 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8903 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8904 }
8905
8906 if (ret != 0) {
8907 uint8_t alert;
8908
8909 /* The certificate may have been rejected for several reasons.
8910 Pick one and send the corresponding alert. Which alert to send
8911 may be a subject of debate in some cases. */
8912 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8913 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8914 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8915 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8916 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8917 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8918 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8919 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8920 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
8921 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8922 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
8923 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8924 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
8925 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
8926 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
8927 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
8928 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
8929 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
8930 } else {
8931 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
8932 }
8933 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8934 alert);
8935 }
8936
8937#if defined(MBEDTLS_DEBUG_C)
8938 if (ssl->session_negotiate->verify_result != 0) {
8939 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8940 (unsigned int) ssl->session_negotiate->verify_result));
8941 } else {
8942 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
8943 }
8944#endif /* MBEDTLS_DEBUG_C */
8945
8946 return ret;
8947}
8948#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
8949
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008950#endif /* MBEDTLS_SSL_TLS_C */