blob: b740358c133a47e274596d4309fa3b31d6cd2875 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Harry Ramsey0f6bc412024-10-04 10:36:54 +010012#include "ssl_misc.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040021
Valerio Settib4f50762024-01-17 10:24:52 +010022#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000023#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050024#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010025#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020026#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020027
Rich Evans00ab4702015-02-06 13:43:58 +000028#include <string.h>
29
Valerio Setti384fbde2024-01-02 13:26:40 +010030#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020031#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020032#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050033#include "psa/crypto.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034
Janos Follath23bdca02016-10-07 14:47:14 +010035#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000036#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020037#endif
38
Andrzej Kurek00644842023-05-30 05:45:00 -040039/* Define local translating functions to save code size by not using too many
40 * arguments in each translating place. */
41static int local_err_translation(psa_status_t status)
42{
43 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040044 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040045 psa_generic_status_to_mbedtls);
46}
47#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050048
Ronald Cronad8c17b2022-06-10 17:18:09 +020049#if defined(MBEDTLS_TEST_HOOKS)
50static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
51
52void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010053 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020054{
55 chk_buf_ptr_fail_args.cur = cur;
56 chk_buf_ptr_fail_args.end = end;
57 chk_buf_ptr_fail_args.need = need;
58}
59
Gilles Peskine449bd832023-01-11 14:50:10 +010060void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020061{
Gilles Peskine449bd832023-01-11 14:50:10 +010062 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020063}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 return (chk_buf_ptr_fail_args.cur != args->cur) ||
68 (chk_buf_ptr_fail_args.end != args->end) ||
69 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020070}
71#endif /* MBEDTLS_TEST_HOOKS */
72
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020073#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010074
Hanno Beckera0e20d02019-05-15 14:03:01 +010075#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010076/* Top-level Connection ID API */
77
Gilles Peskine449bd832023-01-11 14:50:10 +010078int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
79 size_t len,
80 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010081{
Gilles Peskine449bd832023-01-11 14:50:10 +010082 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
83 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
84 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010085
Gilles Peskine449bd832023-01-11 14:50:10 +010086 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
87 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010089 }
90
91 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010092 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010093 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010094}
95
Gilles Peskine449bd832023-01-11 14:50:10 +010096int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
97 int enable,
98 unsigned char const *own_cid,
99 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100100{
Gilles Peskine449bd832023-01-11 14:50:10 +0100101 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
102 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
103 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100104
Hanno Beckerca092242019-04-25 16:01:49 +0100105 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (enable == MBEDTLS_SSL_CID_DISABLED) {
107 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
108 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100109 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
111 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100112
Gilles Peskine449bd832023-01-11 14:50:10 +0100113 if (own_cid_len != ssl->conf->cid_len) {
114 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
115 (unsigned) own_cid_len,
116 (unsigned) ssl->conf->cid_len));
117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100118 }
119
Gilles Peskine449bd832023-01-11 14:50:10 +0100120 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100121 /* Truncation is not an issue here because
122 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
123 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100126}
127
Gilles Peskine449bd832023-01-11 14:50:10 +0100128int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
129 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +0100130 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100131 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000132{
133 *enabled = MBEDTLS_SSL_CID_DISABLED;
134
Gilles Peskine449bd832023-01-11 14:50:10 +0100135 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
136 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
137 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000138
139 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
140 * zero as this is indistinguishable from not requesting to use
141 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100142 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
143 return 0;
144 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000145
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000147 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100148 if (own_cid != NULL) {
149 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
150 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000151 }
152
153 *enabled = MBEDTLS_SSL_CID_ENABLED;
154
Gilles Peskine449bd832023-01-11 14:50:10 +0100155 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000156}
157
Gilles Peskine449bd832023-01-11 14:50:10 +0100158int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
159 int *enabled,
160 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
161 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100162{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100163 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100164
Gilles Peskine449bd832023-01-11 14:50:10 +0100165 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
166 mbedtls_ssl_is_handshake_over(ssl) == 0) {
167 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100168 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Hanno Beckerc5f24222019-05-03 12:54:52 +0100170 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
171 * were used, but client and server requested the empty CID.
172 * This is indistinguishable from not using the CID extension
173 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 if (ssl->transform_in->in_cid_len == 0 &&
175 ssl->transform_in->out_cid_len == 0) {
176 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177 }
178
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100180 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100181 if (peer_cid != NULL) {
182 memcpy(peer_cid, ssl->transform_in->out_cid,
183 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100184 }
185 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100186
187 *enabled = MBEDTLS_SSL_CID_ENABLED;
188
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100190}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100191#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200193#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200195#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200196/*
197 * Convert max_fragment_length codes to length.
198 * RFC 6066 says:
199 * enum{
200 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
201 * } MaxFragmentLength;
202 * and we add 0 -> extension unused
203 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100204static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200205{
Gilles Peskine449bd832023-01-11 14:50:10 +0100206 switch (mfl) {
207 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
208 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
209 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
210 return 512;
211 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
212 return 1024;
213 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
214 return 2048;
215 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
216 return 4096;
217 default:
218 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000219 }
220}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200221#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200222
Gilles Peskine449bd832023-01-11 14:50:10 +0100223int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
224 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200225{
Gilles Peskine449bd832023-01-11 14:50:10 +0100226 mbedtls_ssl_session_free(dst);
227 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800228#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
229 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000230#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
231 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000232 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800233#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000234#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800235
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000236#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
237 defined(MBEDTLS_SSL_EARLY_DATA)
238 dst->ticket_alpn = NULL;
239#endif
240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000242
243#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
248 if (dst->peer_cert == NULL) {
249 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
250 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200253
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
255 src->peer_cert->raw.len)) != 0) {
256 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200257 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259 }
260 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000261#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000263 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 mbedtls_calloc(1, src->peer_cert_digest_len);
265 if (dst->peer_cert_digest == NULL) {
266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
267 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000268
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
270 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000272 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 }
274#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200277
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000278#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
279 defined(MBEDTLS_SSL_EARLY_DATA)
280 {
281 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
282 if (ret != 0) {
283 return ret;
284 }
285 }
286#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
287
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200288#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (src->ticket != NULL) {
290 dst->ticket = mbedtls_calloc(1, src->ticket_len);
291 if (dst->ticket == NULL) {
292 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
293 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200294
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200296 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000297
298#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
299 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000301 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
303 if (ret != 0) {
304 return ret;
305 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000306 }
307#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
308 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200309#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200310
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200312}
313
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500314#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200315MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100316static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500317{
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
319 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800320 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500322
323 /* We want to copy len_new bytes when downsizing the buffer, and
324 * len_old bytes when upsizing, so we choose the smaller of two sizes,
325 * to fit one buffer into another. Size checks, ensuring that no data is
326 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 memcpy(resized_buffer, *buffer,
328 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100329 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500330
331 *buffer = resized_buffer;
332 *len_old = len_new;
333
334 return 0;
335}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200336
Gilles Peskine449bd832023-01-11 14:50:10 +0100337static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
338 size_t in_buf_new_len,
339 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200340{
341 int modified = 0;
342 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
343 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 written_in = ssl->in_msg - ssl->in_buf;
346 iv_offset_in = ssl->in_iv - ssl->in_buf;
347 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200349 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 ssl->in_buf_len < in_buf_new_len) {
351 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
352 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
353 } else {
354 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
355 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200356 modified = 1;
357 }
358 }
359 }
360
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200362 written_out = ssl->out_msg - ssl->out_buf;
363 iv_offset_out = ssl->out_iv - ssl->out_buf;
364 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200366 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 ssl->out_buf_len < out_buf_new_len) {
368 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
369 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
370 } else {
371 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
372 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200373 modified = 1;
374 }
375 }
376 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200378 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200380 /* Fields below might not be properly updated with record
381 * splitting or with CID, so they are manually updated here. */
382 ssl->out_msg = ssl->out_buf + written_out;
383 ssl->out_len = ssl->out_buf + len_offset_out;
384 ssl->out_iv = ssl->out_buf + iv_offset_out;
385
386 ssl->in_msg = ssl->in_buf + written_in;
387 ssl->in_len = ssl->in_buf + len_offset_in;
388 ssl->in_iv = ssl->in_buf + iv_offset_in;
389 }
390}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500391#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
392
Jerry Yudb8c48a2022-01-27 14:54:54 +0800393#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800394
395#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100396typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
397 const char *label,
398 const unsigned char *random, size_t rlen,
399 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800400
Gilles Peskine449bd832023-01-11 14:50:10 +0100401static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800402
403#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
404
405/* Type for the TLS PRF */
406typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
407 const unsigned char *, size_t,
408 unsigned char *, size_t);
409
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200410MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100411static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
412 int ciphersuite,
413 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200414#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200416#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 ssl_tls_prf_t tls_prf,
418 const unsigned char randbytes[64],
419 mbedtls_ssl_protocol_version tls_version,
420 unsigned endpoint,
421 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800422
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100423#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200424MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100425static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300426 const char *label,
427 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100429static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
430static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100431
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100432#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100433
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100434#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100435MBEDTLS_CHECK_RETURN_CRITICAL
436static int tls_prf_sha384(const unsigned char *secret, size_t slen,
437 const char *label,
438 const unsigned char *random, size_t rlen,
439 unsigned char *dstbuf, size_t dlen);
440
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100441static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
442static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100443#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100444
Gilles Peskine449bd832023-01-11 14:50:10 +0100445MBEDTLS_CHECK_RETURN_CRITICAL
446static int ssl_tls12_session_load(mbedtls_ssl_session *session,
447 const unsigned char *buf,
448 size_t len);
449#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
450
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100451static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100452
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100453#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100454static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100455#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100456
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100457#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100458static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100459#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100460
461int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
462 const unsigned char *secret, size_t slen,
463 const char *label,
464 const unsigned char *random, size_t rlen,
465 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300466{
467 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
468
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300470#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100471#if defined(PSA_WANT_ALG_SHA_384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300472 case MBEDTLS_SSL_TLS_PRF_SHA384:
473 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 break;
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100475#endif /* PSA_WANT_ALG_SHA_384*/
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100476#if defined(PSA_WANT_ALG_SHA_256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 case MBEDTLS_SSL_TLS_PRF_SHA256:
478 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 break;
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100480#endif /* PSA_WANT_ALG_SHA_256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300481#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100482 default:
483 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300484 }
485
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300487}
488
Jerry Yuc73c6182022-02-08 20:29:25 +0800489#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100490static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800491{
492#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100493 if (session->peer_cert != NULL) {
494 mbedtls_x509_crt_free(session->peer_cert);
495 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800496 session->peer_cert = NULL;
497 }
498#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100499 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800500 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100501 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800502 session->peer_cert_digest = NULL;
503 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
504 session->peer_cert_digest_len = 0;
505 }
506#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
507}
508#endif /* MBEDTLS_X509_CRT_PARSE_C */
509
Gilles Peskine449bd832023-01-11 14:50:10 +0100510uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800511{
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800513 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800515
516 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800518
519 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800521
522 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100523 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800524
525 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100526 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800527
528 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100529 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800530
531 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800533
534 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800536
537 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800539
540 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800542
543 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800545
546 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800548
549 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800551
552 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800554
555 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800557
558 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800560
561 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800563
564 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800566
567 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800569
570 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800572
573 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800575
576 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800578
579 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800581
582 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800584
585 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800587
588 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800590
Jan Bruckner151f6422023-02-10 12:45:19 +0100591 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
592 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
593
Jerry Yu7a485c12022-10-31 13:08:18 +0800594 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100595 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800596
597 }
598
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800600}
601
Gilles Peskine449bd832023-01-11 14:50:10 +0100602uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800603{
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800605}
606
Jerry Yud25cab02022-10-31 12:48:30 +0800607#if defined(MBEDTLS_DEBUG_C)
608static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800609 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800610 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
611 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
612 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
613 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
614 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
615 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
616 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
617 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
618 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
619 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
620 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
621 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
622 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
623 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
624 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
625 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
626 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
627 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
628 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
629 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
630 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
631 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
632 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
633 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
634 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
635 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100636 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
637 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800638};
639
Chien Wong4e9683e2023-12-28 17:07:43 +0800640static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800641 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
642 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
643 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
644 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
645 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
646 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
647 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
648 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
649 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
650 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
651 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
652 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
653 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
654 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
655 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
656 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
657 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
658 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
659 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
660 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
661 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
662 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
663 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
664 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
665 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
666 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
667 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100668 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
669 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800670};
671
Gilles Peskine449bd832023-01-11 14:50:10 +0100672const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800673{
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 return extension_name_table[
675 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800676}
677
Gilles Peskine449bd832023-01-11 14:50:10 +0100678static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800679{
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800681 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800683 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800685 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800687 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800689 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800691 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800693 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800695 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800697}
698
Gilles Peskine449bd832023-01-11 14:50:10 +0100699void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
700 int level, const char *file, int line,
701 int hs_msg_type, unsigned int extension_type,
702 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800703{
704 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800706 mbedtls_debug_print_msg(
707 ssl, level, file, line,
708 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 ssl_tls13_get_hs_msg_name(hs_msg_type),
710 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800711 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100712 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800713 return;
714 }
715
716 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800718 mbedtls_debug_print_msg(
719 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
721 mbedtls_ssl_get_extension_name(extension_type), extension_type,
722 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800723 return;
724 }
725
726 mbedtls_debug_print_msg(
727 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
729 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800730}
731
Gilles Peskine449bd832023-01-11 14:50:10 +0100732void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
733 int level, const char *file, int line,
734 int hs_msg_type, uint32_t extensions_mask,
735 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800736{
737
Gilles Peskine449bd832023-01-11 14:50:10 +0100738 for (unsigned i = 0;
739 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
740 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800741 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800742 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800744 }
745}
746
Pengyu Lvee455c02023-01-12 14:37:24 +0800747#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800748static const char *ticket_flag_name_table[] =
749{
750 [0] = "ALLOW_PSK_RESUMPTION",
751 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
752 [3] = "ALLOW_EARLY_DATA",
753};
754
Pengyu Lv4938a562023-01-16 11:28:49 +0800755void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
756 int level, const char *file, int line,
757 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800758{
759 size_t i;
760
761 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800762 "print ticket_flags (0x%02x)", flags);
763
764 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800765
766 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800768 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
769 ticket_flag_name_table[i]);
770 }
771 }
772}
773#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
774
Jerry Yud25cab02022-10-31 12:48:30 +0800775#endif /* MBEDTLS_DEBUG_C */
776
Gilles Peskine449bd832023-01-11 14:50:10 +0100777void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
778 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800779{
780 ((void) ciphersuite_info);
781
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100782#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800784 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800786#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100787#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800789 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
792 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 return;
795 }
796}
797
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100798int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100799 unsigned hs_type,
800 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100801{
802 unsigned char hs_hdr[4];
803
804 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100805 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
806 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
807 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
808 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100809
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100810 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100811}
812
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100813int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100814 unsigned hs_type,
815 unsigned char const *msg,
816 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100817{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818 int ret;
819 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100820 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100821 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100822 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100824}
825
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100826int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800827{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100828#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100829 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100830 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100831#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800832 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100833#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100834#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
836 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200837 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100838 }
839 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
840 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200841 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100842 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800843#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100844#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100845 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
846 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200847 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 }
849 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
850 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200851 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100852 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800853#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100854 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800855}
856
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100857static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100858 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800859{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100860#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100861 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100862 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100863#else /* SHA-256 or SHA-384 */
864 ((void) ssl);
865 (void) buf;
866 (void) len;
867#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100868#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100869 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
870 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200871 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100872 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800873#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100874#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100875 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
876 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200877 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100878 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800879#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800881}
882
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100883#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100884static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100885 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800886{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200887 return mbedtls_md_error_from_psa(psa_hash_update(
888 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800889}
890#endif
891
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100892#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100893static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100894 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800895{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200896 return mbedtls_md_error_from_psa(psa_hash_update(
897 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800898}
899#endif
900
Gilles Peskine449bd832023-01-11 14:50:10 +0100901static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200902{
Gilles Peskine449bd832023-01-11 14:50:10 +0100903 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200904
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100905#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500906 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500907#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100908#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500909 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500910#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200911
912 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100913
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200914#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100915 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200916#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200917#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200918 handshake->psa_pake_ctx = psa_pake_operation_init();
919 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200920#if defined(MBEDTLS_SSL_CLI_C)
921 handshake->ecjpake_cache = NULL;
922 handshake->ecjpake_cache_len = 0;
923#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200924#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200925
Gilles Peskineeccd8882020-03-10 12:19:08 +0100926#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200928#endif
929
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200930#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
931 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
932#endif
Hanno Becker75173122019-02-06 16:18:31 +0000933
934#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
935 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100936 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +0000937#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200938}
939
Gilles Peskine449bd832023-01-11 14:50:10 +0100940void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200941{
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +0200943
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100944 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
945 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100946
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000947#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100948 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
949 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100950#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200951}
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956}
957
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200958MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100959static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +0000960{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100961 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
962
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200963 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +0800964#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +0100965 if (ssl->transform_negotiate) {
966 mbedtls_ssl_transform_free(ssl->transform_negotiate);
967 }
Jerry Yu2e199812022-12-01 18:57:19 +0800968#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 if (ssl->session_negotiate) {
970 mbedtls_ssl_session_free(ssl->session_negotiate);
971 }
972 if (ssl->handshake) {
973 mbedtls_ssl_handshake_free(ssl);
974 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200975
Jerry Yu2e199812022-12-01 18:57:19 +0800976#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977 /*
978 * Either the pointers are now NULL or cleared properly and can be freed.
979 * Now allocate missing structures.
980 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 if (ssl->transform_negotiate == NULL) {
982 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200983 }
Jerry Yu2e199812022-12-01 18:57:19 +0800984#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000985
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 if (ssl->session_negotiate == NULL) {
987 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200988 }
Paul Bakker48916f92012-09-16 19:57:18 +0000989
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 if (ssl->handshake == NULL) {
991 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200992 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500993#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
994 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400995
Gilles Peskine449bd832023-01-11 14:50:10 +0100996 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
997 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500998#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000999
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001000 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001002#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001003 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001004#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001005 ssl->session_negotiate == NULL) {
1006 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001010
1011#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001012 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001013 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001014#endif
1015
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001017 ssl->session_negotiate = NULL;
1018
Gilles Peskine449bd832023-01-11 14:50:10 +01001019 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001020 }
1021
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001022#if defined(MBEDTLS_SSL_EARLY_DATA)
1023#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001024 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001025#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001026#if defined(MBEDTLS_SSL_SRV_C)
1027 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1028#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001029 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001030#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001031
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001032 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 mbedtls_ssl_session_init(ssl->session_negotiate);
1034 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001035
Jerry Yu2e199812022-12-01 18:57:19 +08001036#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001038#endif
1039
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001040 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001041 ret = mbedtls_ssl_reset_checksum(ssl);
1042 if (ret != 0) {
1043 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1044 return ret;
1045 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001046
Jerry Yud0766ec2022-09-22 10:46:57 +08001047#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1048 defined(MBEDTLS_SSL_SRV_C) && \
1049 defined(MBEDTLS_SSL_SESSION_TICKETS)
1050 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001051 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001052#endif
1053
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001056 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001057
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001059 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001061 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001065 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001066#endif
1067
Ronald Crone68ab4f2022-10-05 12:46:29 +02001068#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001069#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001070#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001071 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1072 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001073 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1074 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001075 const int *md;
1076 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001077 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001078 uint16_t *p;
1079
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001080 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1081 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1082 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001083
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1085 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001086 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001088#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001090#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001091
Jerry Yub476a442022-01-21 18:14:45 +08001092#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001094#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1096 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1097 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001098 }
1099
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1101 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1102 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001103
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1105 sizeof(uint16_t));
1106 if (ssl->handshake->sig_algs == NULL) {
1107 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1108 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001109
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 p = (uint16_t *) ssl->handshake->sig_algs;
1111 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1112 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1113 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001114 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001116#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001118 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001119#endif
1120#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001122 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001123#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001124 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001125 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001126 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001128#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001129 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001130 ssl->handshake->sig_algs_heap_allocated = 0;
1131 }
Jerry Yucc539102022-06-27 16:27:35 +08001132#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001133#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001135}
1136
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001137#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001138/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001139MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001140static int ssl_cookie_write_dummy(void *ctx,
1141 unsigned char **p, unsigned char *end,
1142 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001143{
1144 ((void) ctx);
1145 ((void) p);
1146 ((void) end);
1147 ((void) cli_id);
1148 ((void) cli_id_len);
1149
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001151}
1152
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001153MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001154static int ssl_cookie_check_dummy(void *ctx,
1155 const unsigned char *cookie, size_t cookie_len,
1156 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001157{
1158 ((void) ctx);
1159 ((void) cookie);
1160 ((void) cookie_len);
1161 ((void) cli_id);
1162 ((void) cli_id_len);
1163
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001165}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001166#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001167
Paul Bakker5121ce52009-01-03 21:22:43 +00001168/*
1169 * Initialize an SSL context
1170 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001171void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001172{
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001174}
1175
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001176MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001177static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001178{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001179 const mbedtls_ssl_config *conf = ssl->conf;
1180
Ronald Cron6f135e12021-12-08 16:57:54 +01001181#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1183 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1184 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1185 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001186 }
1187
Gilles Peskine449bd832023-01-11 14:50:10 +01001188 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1189 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001190 }
1191#endif
1192
1193#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1195 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1196 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001197 }
1198#endif
1199
Ronald Cron6f135e12021-12-08 16:57:54 +01001200#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1202 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1203 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1204 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001205 }
1206
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1208 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001209 }
1210#endif
1211
Gilles Peskine449bd832023-01-11 14:50:10 +01001212 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1213 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001214}
1215
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001216MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001217static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1218{
1219 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 ret = ssl_conf_version_check(ssl);
1221 if (ret != 0) {
1222 return ret;
1223 }
Jerry Yu60835a82021-08-04 10:13:52 +08001224
Yanray Wangb422cab2023-12-01 16:18:10 +08001225 if (ssl->conf->f_rng == NULL) {
1226 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1227 return MBEDTLS_ERR_SSL_NO_RNG;
1228 }
1229
Jerry Yu60835a82021-08-04 10:13:52 +08001230 /* Space for further checks */
1231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001233}
1234
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001235/*
1236 * Setup an SSL context
1237 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001238
Gilles Peskine449bd832023-01-11 14:50:10 +01001239int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1240 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001241{
Janos Follath865b3eb2019-12-16 11:46:15 +00001242 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001243 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1244 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001245
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001246 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001247
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 if ((ret = ssl_conf_check(ssl)) != 0) {
1249 return ret;
1250 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001251 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001252
Paul Bakker62f2dee2012-09-28 07:31:51 +00001253 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001254 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001255 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001256
1257 /* Set to NULL in case of an error condition */
1258 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001259
Darryl Greenb33cc762019-11-28 14:29:44 +00001260#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1261 ssl->in_buf_len = in_buf_len;
1262#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1264 if (ssl->in_buf == NULL) {
1265 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001266 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001267 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001268 }
1269
Darryl Greenb33cc762019-11-28 14:29:44 +00001270#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1271 ssl->out_buf_len = out_buf_len;
1272#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001273 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1274 if (ssl->out_buf == NULL) {
1275 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001276 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001277 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001278 }
1279
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001281
Johan Pascalb62bb512015-12-03 21:56:45 +01001282#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001284#endif
1285
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001287 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001289
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001291
1292error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 mbedtls_free(ssl->in_buf);
1294 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001295
1296 ssl->conf = NULL;
1297
Darryl Greenb33cc762019-11-28 14:29:44 +00001298#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1299 ssl->in_buf_len = 0;
1300 ssl->out_buf_len = 0;
1301#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001302 ssl->in_buf = NULL;
1303 ssl->out_buf = NULL;
1304
1305 ssl->in_hdr = NULL;
1306 ssl->in_ctr = NULL;
1307 ssl->in_len = NULL;
1308 ssl->in_iv = NULL;
1309 ssl->in_msg = NULL;
1310
1311 ssl->out_hdr = NULL;
1312 ssl->out_ctr = NULL;
1313 ssl->out_len = NULL;
1314 ssl->out_iv = NULL;
1315 ssl->out_msg = NULL;
1316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001318}
1319
1320/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001321 * Reset an initialized and used SSL context for re-use while retaining
1322 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001323 *
1324 * If partial is non-zero, keep data in the input buffer and client ID.
1325 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001326 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001327void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1328 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001329{
Darryl Greenb33cc762019-11-28 14:29:44 +00001330#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1331 size_t in_buf_len = ssl->in_buf_len;
1332 size_t out_buf_len = ssl->out_buf_len;
1333#else
1334 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1335 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1336#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001337
Hanno Beckerb0302c42021-08-03 09:39:42 +01001338#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1339 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001340#endif
1341
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001342 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001344
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001346
1347 /* Reset incoming message parsing */
1348 ssl->in_offt = NULL;
1349 ssl->nb_zero = 0;
1350 ssl->in_msgtype = 0;
1351 ssl->in_msglen = 0;
1352 ssl->in_hslen = 0;
1353 ssl->keep_current_message = 0;
1354 ssl->transform_in = NULL;
1355
1356#if defined(MBEDTLS_SSL_PROTO_DTLS)
1357 ssl->next_record_offset = 0;
1358 ssl->in_epoch = 0;
1359#endif
1360
1361 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001363 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001365 }
1366
Ronald Cronad8c17b2022-06-10 17:18:09 +02001367 ssl->send_alert = 0;
1368
Hanno Beckerb0302c42021-08-03 09:39:42 +01001369 /* Reset outgoing message writing */
1370 ssl->out_msgtype = 0;
1371 ssl->out_msglen = 0;
1372 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001373 memset(ssl->out_buf, 0, out_buf_len);
1374 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001375 ssl->transform_out = NULL;
1376
1377#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001379#endif
1380
XiaokangQian2b01dc32022-01-21 02:53:13 +00001381#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 if (ssl->transform) {
1383 mbedtls_ssl_transform_free(ssl->transform);
1384 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001385 ssl->transform = NULL;
1386 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001387#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1388
XiaokangQian2b01dc32022-01-21 02:53:13 +00001389#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 mbedtls_ssl_transform_free(ssl->transform_application);
1391 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001392 ssl->transform_application = NULL;
1393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001395#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1397 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001398 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001399#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001400
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1402 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001403 ssl->handshake->transform_handshake = NULL;
1404 }
1405
XiaokangQian2b01dc32022-01-21 02:53:13 +00001406#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001407}
1408
Gilles Peskine449bd832023-01-11 14:50:10 +01001409int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001410{
1411 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1412
1413 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Gilles Peskinefd89acc2025-02-24 18:45:49 +01001414 ssl->flags &= MBEDTLS_SSL_CONTEXT_FLAGS_KEEP_AT_SESSION;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001415 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001416
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001418
1419 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001420#if defined(MBEDTLS_SSL_RENEGOTIATION)
1421 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001422 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001423
1424 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1426 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001427#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001429
Hanno Beckerb0302c42021-08-03 09:39:42 +01001430 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001431 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 if (ssl->session) {
1433 mbedtls_ssl_session_free(ssl->session);
1434 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001435 ssl->session = NULL;
1436 }
1437
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001438#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001439 ssl->alpn_chosen = NULL;
1440#endif
1441
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001442#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001443 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001444#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001446#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 if (free_cli_id) {
1448 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001449 ssl->cli_id = NULL;
1450 ssl->cli_id_len = 0;
1451 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001452#endif
1453
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 if ((ret = ssl_handshake_init(ssl)) != 0) {
1455 return ret;
1456 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001459}
1460
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001461/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001462 * Reset an initialized and used SSL context for re-use while retaining
1463 * all application-set variables, function pointers and data.
1464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001465int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001466{
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001468}
1469
1470/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001471 * SSL set accessors
1472 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001473void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001474{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001475 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001476}
1477
Gilles Peskine449bd832023-01-11 14:50:10 +01001478void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001479{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001480 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001481}
1482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001484void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001485{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001486 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001487}
1488#endif
1489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001491{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001492 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001493}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001494
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001496
Gilles Peskine449bd832023-01-11 14:50:10 +01001497void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1498 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001499{
1500 ssl->disable_datagram_packing = !allow_packing;
1501}
1502
Gilles Peskine449bd832023-01-11 14:50:10 +01001503void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1504 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001505{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001506 conf->hs_timeout_min = min;
1507 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001508}
1509#endif
1510
Gilles Peskine449bd832023-01-11 14:50:10 +01001511void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001512{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001513 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001514}
1515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001516#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001517void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1518 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1519 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001520{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001521 conf->f_vrfy = f_vrfy;
1522 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001523}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001524#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1527 int (*f_rng)(void *, unsigned char *, size_t),
1528 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001529{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001530 conf->f_rng = f_rng;
1531 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001532}
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1535 void (*f_dbg)(void *, int, const char *, int, const char *),
1536 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001537{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001538 conf->f_dbg = f_dbg;
1539 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001540}
1541
Gilles Peskine449bd832023-01-11 14:50:10 +01001542void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1543 void *p_bio,
1544 mbedtls_ssl_send_t *f_send,
1545 mbedtls_ssl_recv_t *f_recv,
1546 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001547{
1548 ssl->p_bio = p_bio;
1549 ssl->f_send = f_send;
1550 ssl->f_recv = f_recv;
1551 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001552}
1553
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001554#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001555void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001556{
1557 ssl->mtu = mtu;
1558}
1559#endif
1560
Gilles Peskine449bd832023-01-11 14:50:10 +01001561void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001562{
1563 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001564}
1565
Gilles Peskine449bd832023-01-11 14:50:10 +01001566void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1567 void *p_timer,
1568 mbedtls_ssl_set_timer_t *f_set_timer,
1569 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001570{
1571 ssl->p_timer = p_timer;
1572 ssl->f_set_timer = f_set_timer;
1573 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001574
1575 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001577}
1578
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001579#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001580void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1581 void *p_cache,
1582 mbedtls_ssl_cache_get_t *f_get_cache,
1583 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001584{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001585 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001586 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001587 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001588}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001590
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001591#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001592int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001593{
Janos Follath865b3eb2019-12-16 11:46:15 +00001594 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001597 session == NULL ||
1598 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1600 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001601 }
1602
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 if (ssl->handshake->resume == 1) {
1604 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1605 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001606
Jerry Yu21092062022-10-10 21:21:31 +08001607#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001608 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001609#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001610 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001612
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001614 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1616 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1617 session->ciphersuite));
1618 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001619 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001620#else
1621 /*
1622 * If session tickets are not enabled, it is not possible to resume a
1623 * TLS 1.3 session, thus do not make any change to the SSL context in
1624 * the first place.
1625 */
1626 return 0;
1627#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001628 }
Jerry Yu21092062022-10-10 21:21:31 +08001629#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1632 session)) != 0) {
1633 return ret;
1634 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001635
Paul Bakker0a597072012-09-25 21:55:46 +00001636 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001637
Gilles Peskine449bd832023-01-11 14:50:10 +01001638 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001639}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001640#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001641
Gilles Peskine449bd832023-01-11 14:50:10 +01001642void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1643 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001644{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001645 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001646}
1647
Ronald Cron6f135e12021-12-08 16:57:54 +01001648#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001649void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1650 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001651{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001652 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001653}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001654
1655#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001656void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1657 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001658{
1659 conf->early_data_enabled = early_data_enabled;
1660}
Jerry Yucc4e0072022-11-22 17:22:22 +08001661
1662#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001663void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001665{
Jerry Yu39da9852022-12-06 16:58:36 +08001666 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001667}
1668#endif /* MBEDTLS_SSL_SRV_C */
1669
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001670#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001671#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001673#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001674void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1675 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001676{
1677 conf->cert_profile = profile;
1678}
1679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001681{
1682 mbedtls_ssl_key_cert *cur = key_cert, *next;
1683
Gilles Peskine449bd832023-01-11 14:50:10 +01001684 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001685 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001686 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001687 cur = next;
1688 }
1689}
1690
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001691/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001692MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001693static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1694 mbedtls_x509_crt *cert,
1695 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001696{
niisato8ee24222018-06-25 19:05:48 +09001697 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001698
Gilles Peskine449bd832023-01-11 14:50:10 +01001699 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001700 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001701 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001702 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001704 }
1705
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1707 if (new_cert == NULL) {
1708 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1709 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001710
niisato8ee24222018-06-25 19:05:48 +09001711 new_cert->cert = cert;
1712 new_cert->key = key;
1713 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001714
Glenn Strauss36872db2022-01-22 05:06:31 -05001715 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001717 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001719 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001721 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 }
niisato8ee24222018-06-25 19:05:48 +09001723 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001724 }
1725
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001727}
1728
Gilles Peskine449bd832023-01-11 14:50:10 +01001729int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001730 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001731 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001732{
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001734}
1735
Gilles Peskine449bd832023-01-11 14:50:10 +01001736void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001737 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001739{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001740 conf->ca_chain = ca_chain;
1741 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001742
1743#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1744 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1745 * cannot be used together. */
1746 conf->f_ca_cb = NULL;
1747 conf->p_ca_cb = NULL;
1748#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001749}
Hanno Becker5adaad92019-03-27 16:54:37 +00001750
1751#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001752void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1753 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1754 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001755{
1756 conf->f_ca_cb = f_ca_cb;
1757 conf->p_ca_cb = p_ca_cb;
1758
1759 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1760 * cannot be used together. */
1761 conf->ca_chain = NULL;
1762 conf->ca_crl = NULL;
1763}
1764#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001766
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001767#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001768const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1769 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001770{
1771 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001773}
1774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1776 mbedtls_x509_crt *own_cert,
1777 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001778{
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1780 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001781}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001782
Gilles Peskine449bd832023-01-11 14:50:10 +01001783void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1784 mbedtls_x509_crt *ca_chain,
1785 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001786{
1787 ssl->handshake->sni_ca_chain = ca_chain;
1788 ssl->handshake->sni_ca_crl = ca_crl;
1789}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001790
Glenn Strauss999ef702022-03-11 01:37:23 -05001791#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001792void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1793 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001794{
1795 ssl->handshake->dn_hints = crt;
1796}
1797#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1798
Gilles Peskine449bd832023-01-11 14:50:10 +01001799void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1800 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001801{
1802 ssl->handshake->sni_authmode = authmode;
1803}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001804#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1805
Hanno Becker8927c832019-04-03 12:52:50 +01001806#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001807void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1808 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1809 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001810{
1811 ssl->f_vrfy = f_vrfy;
1812 ssl->p_vrfy = p_vrfy;
1813}
1814#endif
1815
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001816#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001817
Przemek Stekielfde11282023-03-13 16:06:09 +01001818static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1819static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1820
Valerio Setti016f6822022-12-09 14:17:50 +01001821static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 mbedtls_ssl_context *ssl,
1823 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001824{
1825 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001826 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001827 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001828 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001829 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001830 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1832 psa_pake_cs_set_primitive(&cipher_suite,
1833 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1834 PSA_ECC_FAMILY_SECP_R1,
1835 256));
1836 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001837
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1839 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001840 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001844 user = jpake_server_id;
1845 user_len = sizeof(jpake_server_id);
1846 peer = jpake_client_id;
1847 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001849 user = jpake_client_id;
1850 user_len = sizeof(jpake_client_id);
1851 peer = jpake_server_id;
1852 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001854
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001855 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1856 if (status != PSA_SUCCESS) {
1857 return status;
1858 }
1859
1860 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001862 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 }
Valerio Setti016f6822022-12-09 14:17:50 +01001864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1866 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001867 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 }
Valerio Setti016f6822022-12-09 14:17:50 +01001869
1870 ssl->handshake->psa_pake_ctx_is_ok = 1;
1871
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001873}
1874
Gilles Peskine449bd832023-01-11 14:50:10 +01001875int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1876 const unsigned char *pw,
1877 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001878{
1879 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1880 psa_status_t status;
1881
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 if (ssl->handshake == NULL || ssl->conf == NULL) {
1883 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001884 }
1885
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 /* Empty password is not valid */
1887 if ((pw == NULL) || (pw_len == 0)) {
1888 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1889 }
1890
1891 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1892 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1893 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1894
1895 status = psa_import_key(&attributes, pw, pw_len,
1896 &ssl->handshake->psa_pake_password);
1897 if (status != PSA_SUCCESS) {
1898 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1899 }
1900
1901 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1902 ssl->handshake->psa_pake_password);
1903 if (status != PSA_SUCCESS) {
1904 psa_destroy_key(ssl->handshake->psa_pake_password);
1905 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1906 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1907 }
1908
1909 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001910}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1913 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001914{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001915 psa_status_t status;
1916
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 if (ssl->handshake == NULL || ssl->conf == NULL) {
1918 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001919 }
1920
Gilles Peskine449bd832023-01-11 14:50:10 +01001921 if (mbedtls_svc_key_id_is_null(pwd)) {
1922 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1923 }
1924
1925 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1926 if (status != PSA_SUCCESS) {
1927 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1928 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1929 }
1930
1931 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001932}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001933#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001934
Ronald Cron73fe8df2022-10-05 14:31:43 +02001935#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001936int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001937{
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 if (conf->psk_identity == NULL ||
1939 conf->psk_identity_len == 0) {
1940 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001941 }
1942
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1944 return 1;
1945 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001946
Gilles Peskine449bd832023-01-11 14:50:10 +01001947 if (conf->psk != NULL && conf->psk_len != 0) {
1948 return 1;
1949 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001950
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001952}
1953
Gilles Peskine449bd832023-01-11 14:50:10 +01001954static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001955{
1956 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001958 /* The maintenance of the PSK key slot is the
1959 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001960 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001961 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001963 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001964 conf->psk = NULL;
1965 conf->psk_len = 0;
1966 }
1967
1968 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 if (conf->psk_identity != NULL) {
1970 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001971 conf->psk_identity = NULL;
1972 conf->psk_identity_len = 0;
1973 }
1974}
1975
Hanno Becker7390c712018-11-15 13:33:04 +00001976/* This function assumes that PSK identity in the SSL config is unset.
1977 * It checks that the provided identity is well-formed and attempts
1978 * to make a copy of it in the SSL config.
1979 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001980MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001981static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1982 unsigned char const *psk_identity,
1983 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001984{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001985 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001987 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 (psk_identity_len >> 16) != 0 ||
1989 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1990 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001991 }
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1994 if (conf->psk_identity == NULL) {
1995 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1996 }
Paul Bakker6db455e2013-09-18 17:29:31 +02001997
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001998 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002000
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002002}
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2005 const unsigned char *psk, size_t psk_len,
2006 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002007{
Janos Follath865b3eb2019-12-16 11:46:15 +00002008 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002009
2010 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2012 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2013 }
Hanno Becker7390c712018-11-15 13:33:04 +00002014
2015 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 if (psk == NULL) {
2017 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2018 }
2019 if (psk_len == 0) {
2020 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2021 }
2022 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2023 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2024 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002025
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2027 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2028 }
Hanno Becker7390c712018-11-15 13:33:04 +00002029 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002031
2032 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2034 if (ret != 0) {
2035 ssl_conf_remove_psk(conf);
2036 }
Hanno Becker7390c712018-11-15 13:33:04 +00002037
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002039}
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002042{
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002044 /* The maintenance of the external PSK key slot is the
2045 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 if (ssl->handshake->psk_opaque_is_internal) {
2047 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002048 ssl->handshake->psk_opaque_is_internal = 0;
2049 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002050 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002051 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002052}
2053
Gilles Peskine449bd832023-01-11 14:50:10 +01002054int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2055 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002056{
Neil Armstrong501c9322022-05-03 09:35:09 +02002057 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002058 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002059 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002060 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002061
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 if (psk == NULL || ssl->handshake == NULL) {
2063 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2064 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002065
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2067 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2068 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002071
Jerry Yuccc68a42022-07-26 16:39:20 +08002072#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2074 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2075 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2076 } else {
2077 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2078 }
2079 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002080 }
2081#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002082
Jerry Yu568ec252022-07-22 21:27:34 +08002083#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2085 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2086 psa_set_key_usage_flags(&key_attributes,
2087 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002088 }
2089#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2090
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 psa_set_key_algorithm(&key_attributes, alg);
2092 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002093
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2095 if (status != PSA_SUCCESS) {
2096 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2097 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002098
2099 /* Allow calling psa_destroy_key() on psk remove */
2100 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002102}
2103
Gilles Peskine449bd832023-01-11 14:50:10 +01002104int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2105 mbedtls_svc_key_id_t psk,
2106 const unsigned char *psk_identity,
2107 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002108{
Janos Follath865b3eb2019-12-16 11:46:15 +00002109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002110
2111 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2113 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2114 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002115
Hanno Becker7390c712018-11-15 13:33:04 +00002116 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 if (mbedtls_svc_key_id_is_null(psk)) {
2118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2119 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002120 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002121
2122 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2124 psk_identity_len);
2125 if (ret != 0) {
2126 ssl_conf_remove_psk(conf);
2127 }
Hanno Becker7390c712018-11-15 13:33:04 +00002128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002130}
2131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2133 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002134{
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 if ((mbedtls_svc_key_id_is_null(psk)) ||
2136 (ssl->handshake == NULL)) {
2137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2138 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002141 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002143}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002144
Jerry Yu8897c072022-08-12 13:56:53 +08002145#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002146void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2147 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2148 size_t),
2149 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002150{
2151 conf->f_psk = f_psk;
2152 conf->p_psk = p_psk;
2153}
Jerry Yu8897c072022-08-12 13:56:53 +08002154#endif /* MBEDTLS_SSL_SRV_C */
2155
Ronald Cron73fe8df2022-10-05 14:31:43 +02002156#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002157
Gilles Peskine301711e2022-04-26 16:57:05 +02002158static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002160{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002161#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (alg == PSA_ALG_CBC_NO_PADDING) {
2163 return MBEDTLS_SSL_MODE_CBC;
2164 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002165#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 if (PSA_ALG_IS_AEAD(alg)) {
2167 return MBEDTLS_SSL_MODE_AEAD;
2168 }
2169 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002170}
2171
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002172
Gilles Peskinee108d982022-04-26 16:50:40 +02002173static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2174 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002176{
2177#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2179 base_mode == MBEDTLS_SSL_MODE_CBC) {
2180 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002181 }
2182#else
2183 (void) encrypt_then_mac;
2184#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002186}
2187
Neil Armstrongab555e02022-04-04 11:07:59 +02002188mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002190{
Gilles Peskinee108d982022-04-26 16:50:40 +02002191 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002193 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002194
Gilles Peskinee108d982022-04-26 16:50:40 +02002195 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002196#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002197 encrypt_then_mac = transform->encrypt_then_mac;
2198#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002200}
2201
Neil Armstrongab555e02022-04-04 11:07:59 +02002202mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002203#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002205#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002207{
Gilles Peskinee108d982022-04-26 16:50:40 +02002208 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2209
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002210 psa_status_t status;
2211 psa_algorithm_t alg;
2212 psa_key_type_t type;
2213 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002214 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2215 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 if (status == PSA_SUCCESS) {
2217 base_mode = mbedtls_ssl_get_base_mode(alg);
2218 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002219
Gilles Peskinee108d982022-04-26 16:50:40 +02002220#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2221 int encrypt_then_mac = 0;
2222#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002224}
2225
Jerry Yu251a12e2022-07-13 15:15:48 +08002226
Ronald Cron8b592d22024-11-12 18:08:25 +01002227const mbedtls_error_pair_t psa_to_ssl_errors[] =
2228{
2229 { PSA_SUCCESS, 0 },
2230 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2231 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2232 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2233 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2234 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2235 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2236};
2237
Gilles Peskine449bd832023-01-11 14:50:10 +01002238psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2239 size_t taglen,
2240 psa_algorithm_t *alg,
2241 psa_key_type_t *key_type,
2242 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002243{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002244#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002245 (void) taglen;
2246#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002248#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002249 case MBEDTLS_CIPHER_AES_128_CBC:
2250 *alg = PSA_ALG_CBC_NO_PADDING;
2251 *key_type = PSA_KEY_TYPE_AES;
2252 *key_size = 128;
2253 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002254#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002255#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002256 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002258 *key_type = PSA_KEY_TYPE_AES;
2259 *key_size = 128;
2260 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002261#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002262#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002263 case MBEDTLS_CIPHER_AES_128_GCM:
2264 *alg = PSA_ALG_GCM;
2265 *key_type = PSA_KEY_TYPE_AES;
2266 *key_size = 128;
2267 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002268#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002269#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002270 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002272 *key_type = PSA_KEY_TYPE_AES;
2273 *key_size = 192;
2274 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002275#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002276#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002277 case MBEDTLS_CIPHER_AES_192_GCM:
2278 *alg = PSA_ALG_GCM;
2279 *key_type = PSA_KEY_TYPE_AES;
2280 *key_size = 192;
2281 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002282#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002283#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002284 case MBEDTLS_CIPHER_AES_256_CBC:
2285 *alg = PSA_ALG_CBC_NO_PADDING;
2286 *key_type = PSA_KEY_TYPE_AES;
2287 *key_size = 256;
2288 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002289#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002290#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002291 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002293 *key_type = PSA_KEY_TYPE_AES;
2294 *key_size = 256;
2295 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002296#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002297#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002298 case MBEDTLS_CIPHER_AES_256_GCM:
2299 *alg = PSA_ALG_GCM;
2300 *key_type = PSA_KEY_TYPE_AES;
2301 *key_size = 256;
2302 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002303#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002304#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002305 case MBEDTLS_CIPHER_ARIA_128_CBC:
2306 *alg = PSA_ALG_CBC_NO_PADDING;
2307 *key_type = PSA_KEY_TYPE_ARIA;
2308 *key_size = 128;
2309 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002310#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002311#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002312 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002314 *key_type = PSA_KEY_TYPE_ARIA;
2315 *key_size = 128;
2316 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002317#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002318#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002319 case MBEDTLS_CIPHER_ARIA_128_GCM:
2320 *alg = PSA_ALG_GCM;
2321 *key_type = PSA_KEY_TYPE_ARIA;
2322 *key_size = 128;
2323 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002324#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002325#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002326 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002328 *key_type = PSA_KEY_TYPE_ARIA;
2329 *key_size = 192;
2330 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002331#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002332#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002333 case MBEDTLS_CIPHER_ARIA_192_GCM:
2334 *alg = PSA_ALG_GCM;
2335 *key_type = PSA_KEY_TYPE_ARIA;
2336 *key_size = 192;
2337 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002338#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002339#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002340 case MBEDTLS_CIPHER_ARIA_256_CBC:
2341 *alg = PSA_ALG_CBC_NO_PADDING;
2342 *key_type = PSA_KEY_TYPE_ARIA;
2343 *key_size = 256;
2344 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002345#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002346#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002347 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002349 *key_type = PSA_KEY_TYPE_ARIA;
2350 *key_size = 256;
2351 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002352#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002353#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002354 case MBEDTLS_CIPHER_ARIA_256_GCM:
2355 *alg = PSA_ALG_GCM;
2356 *key_type = PSA_KEY_TYPE_ARIA;
2357 *key_size = 256;
2358 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002359#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002360#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002361 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2362 *alg = PSA_ALG_CBC_NO_PADDING;
2363 *key_type = PSA_KEY_TYPE_CAMELLIA;
2364 *key_size = 128;
2365 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002366#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002367#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002368 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002370 *key_type = PSA_KEY_TYPE_CAMELLIA;
2371 *key_size = 128;
2372 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002373#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002374#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002375 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2376 *alg = PSA_ALG_GCM;
2377 *key_type = PSA_KEY_TYPE_CAMELLIA;
2378 *key_size = 128;
2379 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002380#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002381#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002382 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002384 *key_type = PSA_KEY_TYPE_CAMELLIA;
2385 *key_size = 192;
2386 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002387#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002388#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002389 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2390 *alg = PSA_ALG_GCM;
2391 *key_type = PSA_KEY_TYPE_CAMELLIA;
2392 *key_size = 192;
2393 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002394#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002395#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002396 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2397 *alg = PSA_ALG_CBC_NO_PADDING;
2398 *key_type = PSA_KEY_TYPE_CAMELLIA;
2399 *key_size = 256;
2400 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002401#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002402#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002403 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002405 *key_type = PSA_KEY_TYPE_CAMELLIA;
2406 *key_size = 256;
2407 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002408#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002409#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002410 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2411 *alg = PSA_ALG_GCM;
2412 *key_type = PSA_KEY_TYPE_CAMELLIA;
2413 *key_size = 256;
2414 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002415#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002416#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002417 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2418 *alg = PSA_ALG_CHACHA20_POLY1305;
2419 *key_type = PSA_KEY_TYPE_CHACHA20;
2420 *key_size = 256;
2421 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002422#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002423 case MBEDTLS_CIPHER_NULL:
2424 *alg = MBEDTLS_SSL_NULL_CIPHER;
2425 *key_type = 0;
2426 *key_size = 0;
2427 break;
2428 default:
2429 return PSA_ERROR_NOT_SUPPORTED;
2430 }
2431
2432 return PSA_SUCCESS;
2433}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002434
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002435#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002436int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2437 const unsigned char *dhm_P, size_t P_len,
2438 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002439{
Janos Follath865b3eb2019-12-16 11:46:15 +00002440 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002441
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 mbedtls_mpi_free(&conf->dhm_P);
2443 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002444
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2446 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2447 mbedtls_mpi_free(&conf->dhm_P);
2448 mbedtls_mpi_free(&conf->dhm_G);
2449 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002450 }
2451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002453}
Paul Bakker5121ce52009-01-03 21:22:43 +00002454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002456{
Janos Follath865b3eb2019-12-16 11:46:15 +00002457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002458
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 mbedtls_mpi_free(&conf->dhm_P);
2460 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002461
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2463 &conf->dhm_P)) != 0 ||
2464 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2465 &conf->dhm_G)) != 0) {
2466 mbedtls_mpi_free(&conf->dhm_P);
2467 mbedtls_mpi_free(&conf->dhm_G);
2468 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002469 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002470
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002472}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002473#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002474
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002475#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2476/*
2477 * Set the minimum length for Diffie-Hellman parameters
2478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002479void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2480 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002481{
2482 conf->dhm_min_bitlen = bitlen;
2483}
2484#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2485
Ronald Crone68ab4f2022-10-05 12:46:29 +02002486#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002487#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002488/*
2489 * Set allowed/preferred hashes for handshake signatures
2490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002491void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2492 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002493{
2494 conf->sig_hashes = hashes;
2495}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002496#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002497
Jerry Yuf017ee42022-01-12 15:49:48 +08002498/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002499void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2500 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002501{
Jerry Yuf017ee42022-01-12 15:49:48 +08002502#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2503 conf->sig_hashes = NULL;
2504#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2505 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002506}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002507#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002508
Brett Warrene0edc842021-08-17 09:53:13 +01002509/*
2510 * Set the allowed groups
2511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002512void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2513 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002514{
Brett Warrene0edc842021-08-17 09:53:13 +01002515 conf->group_list = group_list;
2516}
2517
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002518#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01002519
2520#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2521/** Whether mbedtls_ssl_set_hostname() has been called.
2522 *
2523 * \param[in] ssl SSL context
2524 *
2525 * \return \c 1 if mbedtls_ssl_set_hostname() has been called on \p ssl
2526 * (including `mbedtls_ssl_set_hostname(ssl, NULL)`),
2527 * otherwise \c 0.
2528 */
2529static int mbedtls_ssl_has_set_hostname_been_called(
2530 const mbedtls_ssl_context *ssl)
2531{
Gilles Peskine434016e2025-02-20 18:49:59 +01002532 return (ssl->flags & MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET) != 0;
Gilles Peskine4ac40082025-02-20 18:13:58 +01002533}
2534#endif
2535
2536static void mbedtls_ssl_free_hostname(mbedtls_ssl_context *ssl)
2537{
2538 if (ssl->hostname != NULL) {
2539 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
2540 }
2541 ssl->hostname = NULL;
2542}
2543
Gilles Peskine449bd832023-01-11 14:50:10 +01002544int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002545{
Hanno Becker947194e2017-04-07 13:25:49 +01002546 /* Initialize to suppress unnecessary compiler warning */
2547 size_t hostname_len = 0;
2548
2549 /* Check if new hostname is valid before
2550 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 if (hostname != NULL) {
2552 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002553
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2555 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2556 }
Hanno Becker947194e2017-04-07 13:25:49 +01002557 }
2558
2559 /* Now it's clear that we will overwrite the old hostname,
2560 * so we can free it safely */
Gilles Peskine4ac40082025-02-20 18:13:58 +01002561 mbedtls_ssl_free_hostname(ssl);
Hanno Becker947194e2017-04-07 13:25:49 +01002562
2563 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002564
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002566 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 } else {
2568 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2569 if (ssl->hostname == NULL) {
2570 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2571 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002574
Hanno Becker947194e2017-04-07 13:25:49 +01002575 ssl->hostname[hostname_len] = '\0';
2576 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002577
Gilles Peskine434016e2025-02-20 18:49:59 +01002578 ssl->flags |= MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET;
2579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002581}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002582#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002583
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002584#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002585void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2586 int (*f_sni)(void *, mbedtls_ssl_context *,
2587 const unsigned char *, size_t),
2588 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002589{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002590 conf->f_sni = f_sni;
2591 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002592}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002593#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002594
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002596int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002597{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002598 size_t cur_len, tot_len;
2599 const char **p;
2600
2601 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002602 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2603 * MUST NOT be truncated."
2604 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002605 */
2606 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 for (p = protos; *p != NULL; p++) {
2608 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002609 tot_len += cur_len;
2610
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 if ((cur_len == 0) ||
2612 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2613 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2614 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2615 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002616 }
2617
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002618 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002619
Gilles Peskine449bd832023-01-11 14:50:10 +01002620 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002621}
2622
Gilles Peskine449bd832023-01-11 14:50:10 +01002623const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002624{
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002626}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002627#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002628
Johan Pascalb62bb512015-12-03 21:56:45 +01002629#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002630void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2631 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002632{
2633 conf->dtls_srtp_mki_support = support_mki_value;
2634}
2635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2637 unsigned char *mki_value,
2638 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002639{
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2641 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002642 }
Ron Eldor591f1622018-01-22 12:30:04 +02002643
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2645 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002646 }
Ron Eldor591f1622018-01-22 12:30:04 +02002647
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002649 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002651}
2652
Gilles Peskine449bd832023-01-11 14:50:10 +01002653int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2654 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002655{
Johan Pascal253d0262020-09-22 13:04:45 +02002656 const mbedtls_ssl_srtp_profile *p;
2657 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002658
Johan Pascal253d0262020-09-22 13:04:45 +02002659 /* check the profiles list: all entry must be valid,
2660 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2662 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2663 p++) {
2664 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002665 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002667 /* unsupported value, stop parsing and set the size to an error value */
2668 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002669 }
2670 }
2671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2673 conf->dtls_srtp_profile_list = NULL;
2674 conf->dtls_srtp_profile_list_len = 0;
2675 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002676 }
2677
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002678 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002679 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002682}
2683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2685 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002686{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002687 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2688 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002690 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002692 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002693 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2694 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002695 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002696}
Johan Pascalb62bb512015-12-03 21:56:45 +01002697#endif /* MBEDTLS_SSL_DTLS_SRTP */
2698
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302699#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002700void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002701{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002702 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002703}
2704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002706{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002707 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002708}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302709#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002710
Janos Follath088ce432017-04-10 12:42:31 +01002711#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002712void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2713 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002714{
2715 conf->cert_req_ca_list = cert_req_ca_list;
2716}
2717#endif
2718
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002720void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002721{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002722 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002723}
2724#endif
2725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002726#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002727void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002728{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002729 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002730}
2731#endif
2732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002733#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002734int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002735{
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2737 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2738 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002739 }
2740
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002741 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002742
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002744}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002745#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002746
Gilles Peskine449bd832023-01-11 14:50:10 +01002747void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002748{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002749 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002750}
2751
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002752#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002753void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002754{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002755 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002756}
2757
Gilles Peskine449bd832023-01-11 14:50:10 +01002758void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002759{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002760 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002761}
2762
Gilles Peskine449bd832023-01-11 14:50:10 +01002763void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2764 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002765{
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002767}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002769
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002770#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002771#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002772void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002773{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002774 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002775}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002776#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002777
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002778#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002779
Jerry Yud0766ec2022-09-22 10:46:57 +08002780#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002781void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2782 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002783{
Jerry Yud0766ec2022-09-22 10:46:57 +08002784 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002785}
2786#endif
2787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2789 mbedtls_ssl_ticket_write_t *f_ticket_write,
2790 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2791 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002792{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002793 conf->f_ticket_write = f_ticket_write;
2794 conf->f_ticket_parse = f_ticket_parse;
2795 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002796}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002797#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2801 mbedtls_ssl_export_keys_t *f_export_keys,
2802 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002803{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002804 ssl->f_export_keys = f_export_keys;
2805 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002806}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002807
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002808#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002809void mbedtls_ssl_conf_async_private_cb(
2810 mbedtls_ssl_config *conf,
2811 mbedtls_ssl_async_sign_t *f_async_sign,
2812 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2813 mbedtls_ssl_async_resume_t *f_async_resume,
2814 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002816{
2817 conf->f_async_sign_start = f_async_sign;
2818 conf->f_async_decrypt_start = f_async_decrypt;
2819 conf->f_async_resume = f_async_resume;
2820 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002821 conf->p_async_config_data = async_config_data;
2822}
2823
Gilles Peskine449bd832023-01-11 14:50:10 +01002824void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002825{
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002827}
2828
Gilles Peskine449bd832023-01-11 14:50:10 +01002829void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002830{
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 if (ssl->handshake == NULL) {
2832 return NULL;
2833 } else {
2834 return ssl->handshake->user_async_ctx;
2835 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002836}
2837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2839 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002840{
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002842 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002844}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002845#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002846
Paul Bakker5121ce52009-01-03 21:22:43 +00002847/*
2848 * SSL get accessors
2849 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002850uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002851{
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 if (ssl->session != NULL) {
2853 return ssl->session->verify_result;
2854 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 if (ssl->session_negotiate != NULL) {
2857 return ssl->session_negotiate->verify_result;
2858 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002861}
2862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002864{
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 if (ssl == NULL || ssl->session == NULL) {
2866 return 0;
2867 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002868
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002870}
2871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002873{
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 if (ssl == NULL || ssl->session == NULL) {
2875 return NULL;
2876 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002877
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002879}
2880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002882{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2885 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002886 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002888 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002890 }
2891 }
2892#endif
2893
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002895 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002896 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002897 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002899 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002901 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002902}
2903
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002904#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2905
2906size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2907{
2908 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2909 size_t record_size_limit = max_len;
2910
2911 if (ssl->session != NULL &&
2912 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2913 ssl->session->record_size_limit < max_len) {
2914 record_size_limit = ssl->session->record_size_limit;
2915 }
2916
2917 // TODO: this is currently untested
2918 /* During a handshake, use the value being negotiated */
2919 if (ssl->session_negotiate != NULL &&
2920 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2921 ssl->session_negotiate->record_size_limit < max_len) {
2922 record_size_limit = ssl->session_negotiate->record_size_limit;
2923 }
2924
2925 return record_size_limit;
2926}
2927#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2928
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002929#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002930size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002931{
David Horstmann95d516f2021-05-04 18:36:56 +01002932 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002933 size_t read_mfl;
2934
Jerry Yuddda0502022-12-01 19:43:12 +08002935#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002936 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2938 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2939 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002940 }
Jerry Yuddda0502022-12-01 19:43:12 +08002941#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002942
2943 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 if (ssl->session_out != NULL) {
2945 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2946 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002947 max_len = read_mfl;
2948 }
2949 }
2950
Jerry Yuddda0502022-12-01 19:43:12 +08002951 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 if (ssl->session_negotiate != NULL) {
2953 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2954 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002955 max_len = read_mfl;
2956 }
2957 }
2958
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002960}
2961
Gilles Peskine449bd832023-01-11 14:50:10 +01002962size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002963{
2964 size_t max_len;
2965
2966 /*
2967 * Assume mfl_code is correct since it was checked when set
2968 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002970
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002971 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 if (ssl->session_out != NULL &&
2973 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2974 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002975 }
2976
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002977 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 if (ssl->session_negotiate != NULL &&
2979 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2980 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002981 }
2982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002984}
2985#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2986
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002987#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002988size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002989{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002990 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2992 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2993 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2994 return 0;
2995 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002996
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2998 return ssl->mtu;
2999 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003000
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 if (ssl->mtu == 0) {
3002 return ssl->handshake->mtu;
3003 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 return ssl->mtu < ssl->handshake->mtu ?
3006 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003007}
3008#endif /* MBEDTLS_SSL_PROTO_DTLS */
3009
Gilles Peskine449bd832023-01-11 14:50:10 +01003010int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003011{
3012 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3013
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003014#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003015 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003016 !defined(MBEDTLS_SSL_PROTO_DTLS)
3017 (void) ssl;
3018#endif
3019
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003020#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003022
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003024 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003026#endif
3027
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003028#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3029 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3030
3031 if (max_len > record_size_limit) {
3032 max_len = record_size_limit;
3033 }
3034#endif
3035
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003036 if (ssl->transform_out != NULL &&
3037 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003038 /*
3039 * In TLS 1.3 case, when records are protected, `max_len` as computed
3040 * above is the maximum length of the TLSInnerPlaintext structure that
3041 * along the plaintext payload contains the inner content type (one byte)
3042 * and some zero padding. Given the algorithm used for padding
3043 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3044 * the plaintext payload. Round down to a multiple of
3045 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3046 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003047 */
3048 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3049 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3050 }
3051
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003052#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3054 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3055 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003056 const size_t overhead = (size_t) ret;
3057
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 if (ret < 0) {
3059 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003060 }
3061
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 if (mtu <= overhead) {
3063 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3064 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3065 }
3066
3067 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003068 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003070 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003071#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003072
Hanno Becker0defedb2018-08-10 12:35:02 +01003073#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003074 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3075 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003076 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003077#endif
3078
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003080}
3081
Gilles Peskine449bd832023-01-11 14:50:10 +01003082int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003083{
3084 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3085
3086#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3087 (void) ssl;
3088#endif
3089
3090#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003092
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003094 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003096#endif
3097
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003099}
3100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003101#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003102const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003103{
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 if (ssl == NULL || ssl->session == NULL) {
3105 return NULL;
3106 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003107
Hanno Beckere6824572019-02-07 13:18:46 +00003108#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003110#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003112#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003113}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003114#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003115
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003117int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3118 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003119{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003120 int ret;
3121
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003123 dst == NULL ||
3124 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3126 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003127 }
3128
Hanno Beckere810bbc2021-05-14 16:01:05 +01003129 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3130 * idempotent: Each session can only be exported once.
3131 *
3132 * (This is in preparation for TLS 1.3 support where we will
3133 * need the ability to export multiple sessions (aka tickets),
3134 * which will be achieved by calling mbedtls_ssl_get_session()
3135 * multiple times until it fails.)
3136 *
3137 * Check whether we have already exported the current session,
3138 * and fail if so.
3139 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 if (ssl->session->exported == 1) {
3141 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3142 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003143
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3145 if (ret != 0) {
3146 return ret;
3147 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003148
3149 /* Remember that we've exported the session. */
3150 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003152}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003154
David Horstmanncb01b362024-02-29 17:31:46 +00003155#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3156
3157/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003158 *
David Horstmanncb01b362024-02-29 17:31:46 +00003159 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003160 */
3161static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3162 unsigned char *buf,
3163 size_t buf_len)
3164{
3165 unsigned char *p = buf;
3166 size_t used = 0;
3167
3168#if defined(MBEDTLS_HAVE_TIME)
3169 uint64_t start;
3170#endif
3171#if defined(MBEDTLS_X509_CRT_PARSE_C)
3172#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3173 size_t cert_len;
3174#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3175#endif /* MBEDTLS_X509_CRT_PARSE_C */
3176
3177 /*
3178 * Time
3179 */
3180#if defined(MBEDTLS_HAVE_TIME)
3181 used += 8;
3182
3183 if (used <= buf_len) {
3184 start = (uint64_t) session->start;
3185
3186 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3187 p += 8;
3188 }
3189#endif /* MBEDTLS_HAVE_TIME */
3190
3191 /*
3192 * Basic mandatory fields
3193 */
3194 used += 1 /* id_len */
3195 + sizeof(session->id)
3196 + sizeof(session->master)
3197 + 4; /* verify_result */
3198
3199 if (used <= buf_len) {
3200 *p++ = MBEDTLS_BYTE_0(session->id_len);
3201 memcpy(p, session->id, 32);
3202 p += 32;
3203
3204 memcpy(p, session->master, 48);
3205 p += 48;
3206
3207 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3208 p += 4;
3209 }
3210
3211 /*
3212 * Peer's end-entity certificate
3213 */
3214#if defined(MBEDTLS_X509_CRT_PARSE_C)
3215#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3216 if (session->peer_cert == NULL) {
3217 cert_len = 0;
3218 } else {
3219 cert_len = session->peer_cert->raw.len;
3220 }
3221
3222 used += 3 + cert_len;
3223
3224 if (used <= buf_len) {
3225 *p++ = MBEDTLS_BYTE_2(cert_len);
3226 *p++ = MBEDTLS_BYTE_1(cert_len);
3227 *p++ = MBEDTLS_BYTE_0(cert_len);
3228
3229 if (session->peer_cert != NULL) {
3230 memcpy(p, session->peer_cert->raw.p, cert_len);
3231 p += cert_len;
3232 }
3233 }
3234#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3235 if (session->peer_cert_digest != NULL) {
3236 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3237 if (used <= buf_len) {
3238 *p++ = (unsigned char) session->peer_cert_digest_type;
3239 *p++ = (unsigned char) session->peer_cert_digest_len;
3240 memcpy(p, session->peer_cert_digest,
3241 session->peer_cert_digest_len);
3242 p += session->peer_cert_digest_len;
3243 }
3244 } else {
3245 used += 2;
3246 if (used <= buf_len) {
3247 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3248 *p++ = 0;
3249 }
3250 }
3251#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3252#endif /* MBEDTLS_X509_CRT_PARSE_C */
3253
3254 /*
3255 * Session ticket if any, plus associated data
3256 */
3257#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3258#if defined(MBEDTLS_SSL_CLI_C)
3259 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3260 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3261
3262 if (used <= buf_len) {
3263 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3264 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3265 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3266
3267 if (session->ticket != NULL) {
3268 memcpy(p, session->ticket, session->ticket_len);
3269 p += session->ticket_len;
3270 }
3271
3272 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3273 p += 4;
3274 }
3275 }
3276#endif /* MBEDTLS_SSL_CLI_C */
3277#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3278 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3279 used += 8;
3280
3281 if (used <= buf_len) {
3282 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3283 p += 8;
3284 }
3285 }
3286#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3287#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3288
3289 /*
3290 * Misc extension-related info
3291 */
3292#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3293 used += 1;
3294
3295 if (used <= buf_len) {
3296 *p++ = session->mfl_code;
3297 }
3298#endif
3299
3300#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3301 used += 1;
3302
3303 if (used <= buf_len) {
3304 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3305 }
3306#endif
3307
3308 return used;
3309}
3310
3311MBEDTLS_CHECK_RETURN_CRITICAL
3312static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3313 const unsigned char *buf,
3314 size_t len)
3315{
3316#if defined(MBEDTLS_HAVE_TIME)
3317 uint64_t start;
3318#endif
3319#if defined(MBEDTLS_X509_CRT_PARSE_C)
3320#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3321 size_t cert_len;
3322#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3323#endif /* MBEDTLS_X509_CRT_PARSE_C */
3324
3325 const unsigned char *p = buf;
3326 const unsigned char * const end = buf + len;
3327
3328 /*
3329 * Time
3330 */
3331#if defined(MBEDTLS_HAVE_TIME)
3332 if (8 > (size_t) (end - p)) {
3333 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3334 }
3335
3336 start = MBEDTLS_GET_UINT64_BE(p, 0);
3337 p += 8;
3338
3339 session->start = (time_t) start;
3340#endif /* MBEDTLS_HAVE_TIME */
3341
3342 /*
3343 * Basic mandatory fields
3344 */
3345 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3346 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3347 }
3348
3349 session->id_len = *p++;
3350 memcpy(session->id, p, 32);
3351 p += 32;
3352
3353 memcpy(session->master, p, 48);
3354 p += 48;
3355
3356 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3357 p += 4;
3358
3359 /* Immediately clear invalid pointer values that have been read, in case
3360 * we exit early before we replaced them with valid ones. */
3361#if defined(MBEDTLS_X509_CRT_PARSE_C)
3362#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3363 session->peer_cert = NULL;
3364#else
3365 session->peer_cert_digest = NULL;
3366#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3367#endif /* MBEDTLS_X509_CRT_PARSE_C */
3368#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3369 session->ticket = NULL;
3370#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3371
3372 /*
3373 * Peer certificate
3374 */
3375#if defined(MBEDTLS_X509_CRT_PARSE_C)
3376#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3377 /* Deserialize CRT from the end of the ticket. */
3378 if (3 > (size_t) (end - p)) {
3379 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3380 }
3381
3382 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3383 p += 3;
3384
3385 if (cert_len != 0) {
3386 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3387
3388 if (cert_len > (size_t) (end - p)) {
3389 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3390 }
3391
3392 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3393
3394 if (session->peer_cert == NULL) {
3395 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3396 }
3397
3398 mbedtls_x509_crt_init(session->peer_cert);
3399
3400 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3401 p, cert_len)) != 0) {
3402 mbedtls_x509_crt_free(session->peer_cert);
3403 mbedtls_free(session->peer_cert);
3404 session->peer_cert = NULL;
3405 return ret;
3406 }
3407
3408 p += cert_len;
3409 }
3410#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3411 /* Deserialize CRT digest from the end of the ticket. */
3412 if (2 > (size_t) (end - p)) {
3413 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3414 }
3415
3416 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3417 session->peer_cert_digest_len = (size_t) *p++;
3418
3419 if (session->peer_cert_digest_len != 0) {
3420 const mbedtls_md_info_t *md_info =
3421 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3422 if (md_info == NULL) {
3423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3424 }
3425 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3426 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3427 }
3428
3429 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3430 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3431 }
3432
3433 session->peer_cert_digest =
3434 mbedtls_calloc(1, session->peer_cert_digest_len);
3435 if (session->peer_cert_digest == NULL) {
3436 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3437 }
3438
3439 memcpy(session->peer_cert_digest, p,
3440 session->peer_cert_digest_len);
3441 p += session->peer_cert_digest_len;
3442 }
3443#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3444#endif /* MBEDTLS_X509_CRT_PARSE_C */
3445
3446 /*
3447 * Session ticket and associated data
3448 */
3449#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3450#if defined(MBEDTLS_SSL_CLI_C)
3451 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3452 if (3 > (size_t) (end - p)) {
3453 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3454 }
3455
3456 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3457 p += 3;
3458
3459 if (session->ticket_len != 0) {
3460 if (session->ticket_len > (size_t) (end - p)) {
3461 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3462 }
3463
3464 session->ticket = mbedtls_calloc(1, session->ticket_len);
3465 if (session->ticket == NULL) {
3466 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3467 }
3468
3469 memcpy(session->ticket, p, session->ticket_len);
3470 p += session->ticket_len;
3471 }
3472
3473 if (4 > (size_t) (end - p)) {
3474 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3475 }
3476
3477 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3478 p += 4;
3479 }
3480#endif /* MBEDTLS_SSL_CLI_C */
3481#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3482 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3483 if (8 > (size_t) (end - p)) {
3484 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3485 }
3486 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3487 p += 8;
3488 }
3489#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3490#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3491
3492 /*
3493 * Misc extension-related info
3494 */
3495#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3496 if (1 > (size_t) (end - p)) {
3497 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3498 }
3499
3500 session->mfl_code = *p++;
3501#endif
3502
3503#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3504 if (1 > (size_t) (end - p)) {
3505 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3506 }
3507
3508 session->encrypt_then_mac = *p++;
3509#endif
3510
3511 /* Done, should have consumed entire buffer */
3512 if (p != end) {
3513 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3514 }
3515
3516 return 0;
3517}
3518
3519#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3520
3521#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3522/* Serialization of TLS 1.3 sessions:
3523 *
David Horstmanncb01b362024-02-29 17:31:46 +00003524 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003525 */
3526#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3527MBEDTLS_CHECK_RETURN_CRITICAL
3528static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3529 unsigned char *buf,
3530 size_t buf_len,
3531 size_t *olen)
3532{
3533 unsigned char *p = buf;
3534#if defined(MBEDTLS_SSL_CLI_C) && \
3535 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3536 size_t hostname_len = (session->hostname == NULL) ?
3537 0 : strlen(session->hostname) + 1;
3538#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003539
3540#if defined(MBEDTLS_SSL_SRV_C) && \
3541 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003542 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003543 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003544#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003545 size_t needed = 4 /* ticket_age_add */
3546 + 1 /* ticket_flags */
3547 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003548
David Horstmanne59f9702024-02-29 16:08:57 +00003549 *olen = 0;
3550
3551 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3552 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3553 }
3554 needed += session->resumption_key_len; /* resumption_key */
3555
3556#if defined(MBEDTLS_SSL_EARLY_DATA)
3557 needed += 4; /* max_early_data_size */
3558#endif
3559#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3560 needed += 2; /* record_size_limit */
3561#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3562
3563#if defined(MBEDTLS_HAVE_TIME)
3564 needed += 8; /* ticket_creation_time or ticket_reception_time */
3565#endif
3566
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003567#if defined(MBEDTLS_SSL_SRV_C)
3568 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3569#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003570 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003571 + alpn_len; /* alpn */
3572#endif
3573 }
3574#endif /* MBEDTLS_SSL_SRV_C */
3575
David Horstmanne59f9702024-02-29 16:08:57 +00003576#if defined(MBEDTLS_SSL_CLI_C)
3577 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3578#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3579 needed += 2 /* hostname_len */
3580 + hostname_len; /* hostname */
3581#endif
3582
3583 needed += 4 /* ticket_lifetime */
3584 + 2; /* ticket_len */
3585
3586 /* Check size_t overflow */
3587 if (session->ticket_len > SIZE_MAX - needed) {
3588 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3589 }
3590
3591 needed += session->ticket_len; /* ticket */
3592 }
3593#endif /* MBEDTLS_SSL_CLI_C */
3594
3595 *olen = needed;
3596 if (needed > buf_len) {
3597 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3598 }
3599
3600 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3601 p[4] = session->ticket_flags;
3602
3603 /* save resumption_key */
3604 p[5] = session->resumption_key_len;
3605 p += 6;
3606 memcpy(p, session->resumption_key, session->resumption_key_len);
3607 p += session->resumption_key_len;
3608
3609#if defined(MBEDTLS_SSL_EARLY_DATA)
3610 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3611 p += 4;
3612#endif
3613#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3614 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3615 p += 2;
3616#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3617
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003618#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003619 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003620#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003621 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3622 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003623#endif /* MBEDTLS_HAVE_TIME */
3624
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003625#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003626 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3627 p += 2;
3628
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003629 if (alpn_len > 0) {
3630 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003631 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003632 p += alpn_len;
3633 }
3634#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3635 }
3636#endif /* MBEDTLS_SSL_SRV_C */
3637
David Horstmanne59f9702024-02-29 16:08:57 +00003638#if defined(MBEDTLS_SSL_CLI_C)
3639 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3640#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3641 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3642 p += 2;
3643 if (hostname_len > 0) {
3644 /* save host name */
3645 memcpy(p, session->hostname, hostname_len);
3646 p += hostname_len;
3647 }
3648#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3649
3650#if defined(MBEDTLS_HAVE_TIME)
3651 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3652 p += 8;
3653#endif
3654 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3655 p += 4;
3656
3657 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3658 p += 2;
3659
3660 if (session->ticket != NULL && session->ticket_len > 0) {
3661 memcpy(p, session->ticket, session->ticket_len);
3662 p += session->ticket_len;
3663 }
3664 }
3665#endif /* MBEDTLS_SSL_CLI_C */
3666 return 0;
3667}
3668
3669MBEDTLS_CHECK_RETURN_CRITICAL
3670static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3671 const unsigned char *buf,
3672 size_t len)
3673{
3674 const unsigned char *p = buf;
3675 const unsigned char *end = buf + len;
3676
3677 if (end - p < 6) {
3678 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3679 }
3680 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3681 session->ticket_flags = p[4];
3682
3683 /* load resumption_key */
3684 session->resumption_key_len = p[5];
3685 p += 6;
3686
3687 if (end - p < session->resumption_key_len) {
3688 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3689 }
3690
3691 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3692 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3693 }
3694 memcpy(session->resumption_key, p, session->resumption_key_len);
3695 p += session->resumption_key_len;
3696
3697#if defined(MBEDTLS_SSL_EARLY_DATA)
3698 if (end - p < 4) {
3699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3700 }
3701 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3702 p += 4;
3703#endif
3704#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3705 if (end - p < 2) {
3706 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3707 }
3708 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3709 p += 2;
3710#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3711
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003712#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003713 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003714#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003715 if (end - p < 8) {
3716 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3717 }
3718 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3719 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003720#endif /* MBEDTLS_HAVE_TIME */
3721
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003722#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003723 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003724
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003725 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003726 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3727 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003728
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003729 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3730 p += 2;
3731
3732 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003733 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3734 }
3735
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003736 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003737 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3738 if (ret != 0) {
3739 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003740 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003741 p += alpn_len;
3742 }
3743#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3744 }
3745#endif /* MBEDTLS_SSL_SRV_C */
3746
David Horstmanne59f9702024-02-29 16:08:57 +00003747#if defined(MBEDTLS_SSL_CLI_C)
3748 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3749#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3750 size_t hostname_len;
3751 /* load host name */
3752 if (end - p < 2) {
3753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3754 }
3755 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3756 p += 2;
3757
3758 if (end - p < (long int) hostname_len) {
3759 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3760 }
3761 if (hostname_len > 0) {
3762 session->hostname = mbedtls_calloc(1, hostname_len);
3763 if (session->hostname == NULL) {
3764 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3765 }
3766 memcpy(session->hostname, p, hostname_len);
3767 p += hostname_len;
3768 }
3769#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3770
3771#if defined(MBEDTLS_HAVE_TIME)
3772 if (end - p < 8) {
3773 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3774 }
3775 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3776 p += 8;
3777#endif
3778 if (end - p < 4) {
3779 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3780 }
3781 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3782 p += 4;
3783
3784 if (end - p < 2) {
3785 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3786 }
3787 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3788 p += 2;
3789
3790 if (end - p < (long int) session->ticket_len) {
3791 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3792 }
3793 if (session->ticket_len > 0) {
3794 session->ticket = mbedtls_calloc(1, session->ticket_len);
3795 if (session->ticket == NULL) {
3796 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3797 }
3798 memcpy(session->ticket, p, session->ticket_len);
3799 p += session->ticket_len;
3800 }
3801 }
3802#endif /* MBEDTLS_SSL_CLI_C */
3803
3804 return 0;
3805
3806}
3807#else /* MBEDTLS_SSL_SESSION_TICKETS */
3808MBEDTLS_CHECK_RETURN_CRITICAL
3809static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3810 unsigned char *buf,
3811 size_t buf_len,
3812 size_t *olen)
3813{
3814 ((void) session);
3815 ((void) buf);
3816 ((void) buf_len);
3817 *olen = 0;
3818 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3819}
3820
3821static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003822 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003823 size_t buf_len)
3824{
3825 ((void) session);
3826 ((void) buf);
3827 ((void) buf_len);
3828 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3829}
3830#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3831#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3832
Paul Bakker5121ce52009-01-03 21:22:43 +00003833/*
Hanno Beckera835da52019-05-16 12:39:07 +01003834 * Define ticket header determining Mbed TLS version
3835 * and structure of the ticket.
3836 */
3837
Hanno Becker94ef3b32019-05-16 12:50:45 +01003838/*
Hanno Becker50b59662019-05-28 14:30:45 +01003839 * Define bitflag determining compile-time settings influencing
3840 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003841 */
3842
Hanno Becker50b59662019-05-28 14:30:45 +01003843#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003844#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003845#else
Hanno Becker3e088662019-05-29 11:10:18 +01003846#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003847#endif /* MBEDTLS_HAVE_TIME */
3848
3849#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003850#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003851#else
Hanno Becker3e088662019-05-29 11:10:18 +01003852#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003853#endif /* MBEDTLS_X509_CRT_PARSE_C */
3854
David Horstmann5c5a32f2024-02-13 17:53:35 +00003855#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003856#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003857#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003858#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003859#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3860
Hanno Becker94ef3b32019-05-16 12:50:45 +01003861#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003862#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003863#else
Hanno Becker3e088662019-05-29 11:10:18 +01003864#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003865#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3866
3867#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003868#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003869#else
Hanno Becker3e088662019-05-29 11:10:18 +01003870#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003871#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3872
Hanno Becker94ef3b32019-05-16 12:50:45 +01003873#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003874#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003875#else
Hanno Becker3e088662019-05-29 11:10:18 +01003876#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003877#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3878
Hanno Becker94ef3b32019-05-16 12:50:45 +01003879#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3880#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3881#else
3882#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3883#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3884
David Horstmann92b258b2024-02-13 17:23:34 +00003885#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3886#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3887#else
3888#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3889#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3890
3891#if defined(MBEDTLS_SSL_EARLY_DATA)
3892#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3893#else
3894#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3895#endif /* MBEDTLS_SSL_EARLY_DATA */
3896
3897#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3898#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3899#else
3900#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3901#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3902
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003903#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3904 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003905#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3906#else
3907#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3908#endif /* MBEDTLS_SSL_ALPN */
3909
Hanno Becker3e088662019-05-29 11:10:18 +01003910#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3911#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3912#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3913#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003914#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3915#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003916#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003917#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3918#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3919#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003920#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003921
Hanno Becker50b59662019-05-28 14:30:45 +01003922#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003923 ((uint16_t) ( \
3924 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3925 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3926 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3927 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3928 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3929 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003930 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003931 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3932 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003933 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3934 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3935 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3936 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003937 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003938 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003939 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003940
Chien Wong4e9683e2023-12-28 17:07:43 +08003941static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003942 MBEDTLS_VERSION_MAJOR,
3943 MBEDTLS_VERSION_MINOR,
3944 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003945 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3946 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003947};
Hanno Beckera835da52019-05-16 12:39:07 +01003948
3949/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003950 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003951 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003952 *
David Horstmanncb01b362024-02-29 17:31:46 +00003953 * TLS 1.2 session:
3954 *
3955 * struct {
3956 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3957 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3958 * uint32 ticket_lifetime;
3959 * #endif
3960 * } ClientOnlyData;
3961 *
3962 * struct {
3963 * #if defined(MBEDTLS_HAVE_TIME)
3964 * uint64 start_time;
3965 * #endif
3966 * uint8 session_id_len; // at most 32
3967 * opaque session_id[32];
3968 * opaque master[48]; // fixed length in the standard
3969 * uint32 verify_result;
3970 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3971 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3972 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003973 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003974 * opaque peer_cert_digest<0..2^8-1>
3975 * #endif
3976 * select (endpoint) {
3977 * case client: ClientOnlyData;
3978 * case server: uint64 ticket_creation_time;
3979 * };
3980 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3981 * uint8 mfl_code; // up to 255 according to standard
3982 * #endif
3983 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3984 * uint8 encrypt_then_mac; // 0 or 1
3985 * #endif
3986 * } serialized_session_tls12;
3987 *
3988 *
3989 * TLS 1.3 Session:
3990 *
3991 * struct {
3992 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3993 * opaque hostname<0..2^16-1>;
3994 * #endif
3995 * #if defined(MBEDTLS_HAVE_TIME)
3996 * uint64 ticket_reception_time;
3997 * #endif
3998 * uint32 ticket_lifetime;
3999 * opaque ticket<1..2^16-1>;
4000 * } ClientOnlyData;
4001 *
4002 * struct {
4003 * uint32 ticket_age_add;
4004 * uint8 ticket_flags;
4005 * opaque resumption_key<0..255>;
4006 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4007 * uint32 max_early_data_size;
4008 * #endif
4009 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4010 * uint16 record_size_limit;
4011 * #endif
4012 * select ( endpoint ) {
4013 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004014 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004015 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004016 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004017 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004018 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004019 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004020 * #endif
4021 * };
4022 * } serialized_session_tls13;
4023 *
4024 *
4025 * SSL session:
4026 *
4027 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004028 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004029 * opaque mbedtls_version[3]; // library version: major, minor, patch
4030 * opaque session_format[2]; // library-version specific 16-bit field
4031 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004032 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004033 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004034 * Note: When updating the format, remember to keep
4035 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004036 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004037 * // In this version, `session_format` determines
4038 * // the setting of those compile-time
4039 * // configuration options which influence
4040 * // the structure of mbedtls_ssl_session.
4041 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004042 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004043 * // - TLS 1.2 (0x0303)
4044 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004045 * uint8_t endpoint;
4046 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004047 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004048 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004049 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004050 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004051 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004052 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004053 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004054 *
4055 * };
4056 *
4057 * } serialized_session;
4058 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004059 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004060
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004061MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004062static int ssl_session_save(const mbedtls_ssl_session *session,
4063 unsigned char omit_header,
4064 unsigned char *buf,
4065 size_t buf_len,
4066 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004067{
4068 unsigned char *p = buf;
4069 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004070 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004071#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4072 size_t out_len;
4073 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4074#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 if (session == NULL) {
4076 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4077 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004078
Gilles Peskine449bd832023-01-11 14:50:10 +01004079 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004080 /*
4081 * Add Mbed TLS version identifier
4082 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004084
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 if (used <= buf_len) {
4086 memcpy(p, ssl_serialized_session_header,
4087 sizeof(ssl_serialized_session_header));
4088 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004089 }
4090 }
4091
4092 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004093 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004094 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004095 used += 1 /* TLS version */
4096 + 1 /* endpoint */
4097 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004098 if (used <= buf_len) {
4099 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004100 *p++ = session->endpoint;
4101 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4102 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004103 }
4104
4105 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004106 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004107 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004108#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 case MBEDTLS_SSL_VERSION_TLS1_2:
4110 used += ssl_tls12_session_save(session, p, remaining_len);
4111 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004112#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4113
Jerry Yu251a12e2022-07-13 15:15:48 +08004114#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004115 case MBEDTLS_SSL_VERSION_TLS1_3:
4116 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4117 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4118 return ret;
4119 }
4120 used += out_len;
4121 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004122#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4123
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 default:
4125 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004126 }
4127
4128 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 if (used > buf_len) {
4130 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4131 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004134}
4135
4136/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004137 * Public wrapper for ssl_session_save()
4138 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004139int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4140 unsigned char *buf,
4141 size_t buf_len,
4142 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004143{
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004145}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004146
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004147/*
4148 * Deserialize session, see mbedtls_ssl_session_save() for format.
4149 *
4150 * This internal version is wrapped by a public function that cleans up in
4151 * case of error, and has an extra option omit_header.
4152 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004153MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004154static int ssl_session_load(mbedtls_ssl_session *session,
4155 unsigned char omit_header,
4156 const unsigned char *buf,
4157 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004158{
4159 const unsigned char *p = buf;
4160 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004161 size_t remaining_len;
4162
4163
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 if (session == NULL) {
4165 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4166 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004167
Gilles Peskine449bd832023-01-11 14:50:10 +01004168 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004169 /*
4170 * Check Mbed TLS version identifier
4171 */
4172
Gilles Peskine449bd832023-01-11 14:50:10 +01004173 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004175 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004176
4177 if (memcmp(p, ssl_serialized_session_header,
4178 sizeof(ssl_serialized_session_header)) != 0) {
4179 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4180 }
4181 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004182 }
4183
4184 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004185 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004186 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004187 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004188 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4189 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004190 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004191 session->endpoint = *p++;
4192 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4193 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004194
4195 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004196 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004198#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004199 case MBEDTLS_SSL_VERSION_TLS1_2:
4200 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004201#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4202
Jerry Yu438ddd82022-07-07 06:55:50 +00004203#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 case MBEDTLS_SSL_VERSION_TLS1_3:
4205 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004206#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4207
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 default:
4209 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004210 }
4211}
4212
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004213/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004214 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004215 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004216int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4217 const unsigned char *buf,
4218 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004219{
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004221
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 if (ret != 0) {
4223 mbedtls_ssl_session_free(session);
4224 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004225
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004227}
4228
4229/*
Paul Bakker1961b702013-01-25 14:49:24 +01004230 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004231 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004232MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004233static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004234{
4235 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4236
Ronald Cron66dbf912022-02-02 15:33:46 +01004237 /*
4238 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004239 * that were written into the output buffer by the previous handshake step,
4240 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004241 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4242 * We proceed to the next handshake step only when all data from the
4243 * previous one have been sent to the peer, thus we make sure that this is
4244 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4245 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4246 * we have to wait before to go ahead.
4247 * In the case of TLS 1.3, handshake step handlers do not send data to the
4248 * peer. Data are only sent here and through
4249 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004250 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004251 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004252 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4253 return ret;
4254 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004255
4256#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4258 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4259 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4260 return ret;
4261 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004262 }
4263#endif /* MBEDTLS_SSL_PROTO_DTLS */
4264
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004266}
4267
Gilles Peskine449bd832023-01-11 14:50:10 +01004268int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004269{
Hanno Becker41934dd2021-08-07 19:13:43 +01004270 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004271
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004273 ssl->conf == NULL ||
4274 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004275 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4276 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004277 }
4278
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 ret = ssl_prepare_handshake_step(ssl);
4280 if (ret != 0) {
4281 return ret;
4282 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004283
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 ret = mbedtls_ssl_handle_pending_alert(ssl);
4285 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004286 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 }
Jerry Yue7047812021-09-13 19:26:39 +08004288
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004289 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4290 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4291 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4292
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004293#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4295 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004296 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004297
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004299 case MBEDTLS_SSL_HELLO_REQUEST:
4300 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004301 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004302 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004303
Ronald Cron9f0fba32022-02-10 16:45:15 +01004304 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004306 break;
4307
4308 default:
4309#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4311 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4312 } else {
4313 ret = mbedtls_ssl_handshake_client_step(ssl);
4314 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004315#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004317#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004318 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004319#endif
4320 }
Jerry Yub9930e72021-08-06 17:11:51 +08004321 }
Ronald Cron6291b232023-03-08 15:51:25 +01004322#endif /* MBEDTLS_SSL_CLI_C */
4323
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004324#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004326#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4327 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004329 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004330 ret = mbedtls_ssl_handshake_server_step(ssl);
4331 }
Ronald Cron6291b232023-03-08 15:51:25 +01004332#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4333 ret = mbedtls_ssl_handshake_server_step(ssl);
4334#else
4335 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004336#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004337 }
4338#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004339
Gilles Peskine449bd832023-01-11 14:50:10 +01004340 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004341 /* handshake_step return error. And it is same
4342 * with alert_reason.
4343 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 if (ssl->send_alert) {
4345 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004346 goto cleanup;
4347 }
4348 }
4349
4350cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004352}
4353
4354/*
4355 * Perform the SSL handshake
4356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004357int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004358{
4359 int ret = 0;
4360
Hanno Beckera817ea42020-10-20 15:20:23 +01004361 /* Sanity checks */
4362
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 if (ssl == NULL || ssl->conf == NULL) {
4364 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4365 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004366
Hanno Beckera817ea42020-10-20 15:20:23 +01004367#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4369 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4370 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4371 "mbedtls_ssl_set_timer_cb() for DTLS"));
4372 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004373 }
4374#endif /* MBEDTLS_SSL_PROTO_DTLS */
4375
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004377
Hanno Beckera817ea42020-10-20 15:20:23 +01004378 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4380 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004381
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004383 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 }
Paul Bakker1961b702013-01-25 14:49:24 +01004385 }
4386
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004390}
4391
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004392#if defined(MBEDTLS_SSL_RENEGOTIATION)
4393#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004394/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004395 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004396 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004397MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004398static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004399{
Janos Follath865b3eb2019-12-16 11:46:15 +00004400 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004401
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004403
4404 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004405 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4406 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004407
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4409 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4410 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004411 }
4412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004414
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004416}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004417#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004418
4419/*
4420 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004421 * - any side: calling mbedtls_ssl_renegotiate(),
4422 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4423 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004424 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004425 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004426 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004427 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004428int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004429{
Janos Follath865b3eb2019-12-16 11:46:15 +00004430 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004431
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004433
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 if ((ret = ssl_handshake_init(ssl)) != 0) {
4435 return ret;
4436 }
Paul Bakker48916f92012-09-16 19:57:18 +00004437
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004438 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4439 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004440#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4442 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4443 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004444 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004446 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004448 }
4449#endif
4450
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004451 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4452 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004453
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4455 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4456 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004457 }
4458
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004460
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004462}
4463
4464/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004465 * Renegotiate current connection on client,
4466 * or request renegotiation on server
4467 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004468int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004469{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004470 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004471
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 if (ssl == NULL || ssl->conf == NULL) {
4473 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4474 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004475
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004476#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004477 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4479 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4480 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4481 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004483 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004484
4485 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 if (ssl->out_left != 0) {
4487 return mbedtls_ssl_flush_output(ssl);
4488 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004489
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004491 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004492#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004493
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004494#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004495 /*
4496 * On client, either start the renegotiation process or,
4497 * if already in progress, continue the handshake
4498 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4500 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4501 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004502 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004503
4504 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4505 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4506 return ret;
4507 }
4508 } else {
4509 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4510 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4511 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004512 }
4513 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004514#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004515
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004517}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004518#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004519
Gilles Peskine449bd832023-01-11 14:50:10 +01004520void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004521{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004522 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004525 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004527
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004528#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004529#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 if (ssl->handshake->group_list_heap_allocated) {
4531 mbedtls_free((void *) handshake->group_list);
4532 }
Brett Warrene0edc842021-08-17 09:53:13 +01004533 handshake->group_list = NULL;
4534#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004535#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004536
Ronald Crone68ab4f2022-10-05 12:46:29 +02004537#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004538#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 if (ssl->handshake->sig_algs_heap_allocated) {
4540 mbedtls_free((void *) handshake->sig_algs);
4541 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004542 handshake->sig_algs = NULL;
4543#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004544#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 if (ssl->handshake->certificate_request_context) {
4546 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004547 }
4548#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004549#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004550
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004551#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4553 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004554 handshake->async_in_progress = 0;
4555 }
4556#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4557
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004558#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004560#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004561#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004563#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004565#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004567#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004568
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004569#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004571 /*
4572 * Opaque keys are not stored in the handshake's data and it's the user
4573 * responsibility to destroy them. Clear ones, instead, are created by
4574 * the TLS library and should be destroyed at the same level
4575 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4577 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004578 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004579 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004580#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004582 handshake->ecjpake_cache = NULL;
4583 handshake->ecjpake_cache_len = 0;
4584#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004585#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004586
Valerio Setti7aeec542023-07-05 18:57:21 +02004587#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004588 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004589 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004590 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004592#endif
4593
Ronald Cron73fe8df2022-10-05 14:31:43 +02004594#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004596 /* The maintenance of the external PSK key slot is the
4597 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 if (ssl->handshake->psk_opaque_is_internal) {
4599 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004600 ssl->handshake->psk_opaque_is_internal = 0;
4601 }
4602 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4603 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004604#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004605
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004606#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4607 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004608 /*
4609 * Free only the linked list wrapper, not the keys themselves
4610 * since the belong to the SNI callback
4611 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004612 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004613#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004614
Gilles Peskineeccd8882020-03-10 12:19:08 +01004615#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4617 if (handshake->ecrs_peer_cert != NULL) {
4618 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4619 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004620 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004621#endif
4622
Hanno Becker75173122019-02-06 16:18:31 +00004623#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4624 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004626#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4627
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004628#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4630 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004631#endif /* MBEDTLS_SSL_CLI_C &&
4632 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004633
4634#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 mbedtls_ssl_flight_free(handshake->flight);
4636 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004637#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004638
Valerio Settiea59c432023-07-25 11:14:03 +02004639#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004640 if (handshake->xxdh_psa_privkey_is_external == 0) {
4641 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 }
Valerio Settiea59c432023-07-25 11:14:03 +02004643#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004644
Ronald Cron6f135e12021-12-08 16:57:54 +01004645#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 mbedtls_ssl_transform_free(handshake->transform_handshake);
4647 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004648#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4650 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004651#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004652#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004653
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004654
4655#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4656 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4657 * processes datagrams and the fact that a datagram is allowed to have
4658 * several records in it, it is possible that the I/O buffers are not
4659 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4661 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004662#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004663
Jerry Yuba9c7272021-10-30 11:54:10 +08004664 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 mbedtls_platform_zeroize(handshake,
4666 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004667}
4668
Gilles Peskine449bd832023-01-11 14:50:10 +01004669void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004670{
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004672 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004675#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004677#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004678
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004679#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004680#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4681 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004683#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004685#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004686
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004687#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4688 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004689 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004690#endif
4691
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004693}
4694
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004695#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004696
4697#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4698#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4699#else
4700#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4701#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4702
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004703#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004704
4705#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4706#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4707#else
4708#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4709#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4710
4711#if defined(MBEDTLS_SSL_ALPN)
4712#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4713#else
4714#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4715#endif /* MBEDTLS_SSL_ALPN */
4716
4717#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4718#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4719#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4720#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4721
4722#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 ((uint32_t) ( \
4724 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4725 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4726 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4727 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4728 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4729 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4730 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4731 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004732
Chien Wong4e9683e2023-12-28 17:07:43 +08004733static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004734 MBEDTLS_VERSION_MAJOR,
4735 MBEDTLS_VERSION_MINOR,
4736 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4738 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4739 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4740 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4741 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004742};
4743
Paul Bakker5121ce52009-01-03 21:22:43 +00004744/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004745 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004746 *
4747 * The format of the serialized data is:
4748 * (in the presentation language of TLS, RFC 8446 section 3)
4749 *
4750 * // header
4751 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004752 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004753 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004754 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004755 * Note: When updating the format, remember to keep these
4756 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004757 *
4758 * // session sub-structure
4759 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4760 * // transform sub-structure
4761 * uint8 random[64]; // ServerHello.random+ClientHello.random
4762 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4763 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4764 * // fields from ssl_context
4765 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4766 * uint64 in_window_top; // DTLS: last validated record seq_num
4767 * uint64 in_window; // DTLS: bitmask for replay protection
4768 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4769 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4770 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4771 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4772 *
4773 * Note that many fields of the ssl_context or sub-structures are not
4774 * serialized, as they fall in one of the following categories:
4775 *
4776 * 1. forced value (eg in_left must be 0)
4777 * 2. pointer to dynamically-allocated memory (eg session, transform)
4778 * 3. value can be re-derived from other data (eg session keys from MS)
4779 * 4. value was temporary (eg content of input buffer)
4780 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004781 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004782int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4783 unsigned char *buf,
4784 size_t buf_len,
4785 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004786{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004787 unsigned char *p = buf;
4788 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004789 size_t session_len;
4790 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004791
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004792 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004793 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4794 * this function's documentation.
4795 *
4796 * These are due to assumptions/limitations in the implementation. Some of
4797 * them are likely to stay (no handshake in progress) some might go away
4798 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004799 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004800 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4802 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4803 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004804 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 if (ssl->handshake != NULL) {
4806 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4807 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004808 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004809 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 if (ssl->transform == NULL || ssl->session == NULL) {
4811 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4812 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004813 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004814 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 if (mbedtls_ssl_check_pending(ssl) != 0) {
4816 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4817 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004818 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 if (ssl->out_left != 0) {
4820 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4821 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004822 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004823 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4825 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4826 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004827 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004828 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4830 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4831 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004832 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004833 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4835 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4836 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004837 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004838 /* Renegotiation must not be enabled */
4839#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4841 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4842 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004843 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004844#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004845
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004846 /*
4847 * Version and format identifier
4848 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004850
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 if (used <= buf_len) {
4852 memcpy(p, ssl_serialized_context_header,
4853 sizeof(ssl_serialized_context_header));
4854 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004855 }
4856
4857 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004858 * Session (length + data)
4859 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4861 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4862 return ret;
4863 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004864
4865 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 if (used <= buf_len) {
4867 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004868 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004869
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 ret = ssl_session_save(ssl->session, 1,
4871 p, session_len, &session_len);
4872 if (ret != 0) {
4873 return ret;
4874 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004875
4876 p += session_len;
4877 }
4878
4879 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004880 * Transform
4881 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 used += sizeof(ssl->transform->randbytes);
4883 if (used <= buf_len) {
4884 memcpy(p, ssl->transform->randbytes,
4885 sizeof(ssl->transform->randbytes));
4886 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004887 }
4888
4889#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004890 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004892 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004894 p += ssl->transform->in_cid_len;
4895
4896 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004898 p += ssl->transform->out_cid_len;
4899 }
4900#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4901
4902 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004903 * Saved fields from top-level ssl_context structure
4904 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004905 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 if (used <= buf_len) {
4907 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004908 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004909 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004910
4911#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4912 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 if (used <= buf_len) {
4914 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004915 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004916
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004918 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004919 }
4920#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4921
4922#if defined(MBEDTLS_SSL_PROTO_DTLS)
4923 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004925 *p++ = ssl->disable_datagram_packing;
4926 }
4927#endif /* MBEDTLS_SSL_PROTO_DTLS */
4928
Jerry Yuae0b2e22021-10-08 15:21:19 +08004929 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 if (used <= buf_len) {
4931 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004932 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004933 }
4934
4935#if defined(MBEDTLS_SSL_PROTO_DTLS)
4936 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 if (used <= buf_len) {
4938 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004939 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004940 }
4941#endif /* MBEDTLS_SSL_PROTO_DTLS */
4942
4943#if defined(MBEDTLS_SSL_ALPN)
4944 {
4945 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004947 : 0;
4948
4949 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004951 *p++ = alpn_len;
4952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 if (ssl->alpn_chosen != NULL) {
4954 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004955 p += alpn_len;
4956 }
4957 }
4958 }
4959#endif /* MBEDTLS_SSL_ALPN */
4960
4961 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004962 * Done
4963 */
4964 *olen = used;
4965
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 if (used > buf_len) {
4967 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4968 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004969
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004971
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004973}
4974
4975/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004976 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004977 *
4978 * This internal version is wrapped by a public function that cleans up in
4979 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004980 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004981MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004982static int ssl_context_load(mbedtls_ssl_context *ssl,
4983 const unsigned char *buf,
4984 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004985{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004986 const unsigned char *p = buf;
4987 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004988 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004989 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004990#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004991 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004992#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004993
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004994 /*
4995 * The context should have been freshly setup or reset.
4996 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004997 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004998 * renegotiating, or if the user mistakenly loaded a session first.)
4999 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5001 ssl->session != NULL) {
5002 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005003 }
5004
5005 /*
5006 * We can't check that the config matches the initial one, but we can at
5007 * least check it matches the requirements for serializing.
5008 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005009 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005010#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005011 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005012#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005013 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5014 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5015 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5016 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005017 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005018 }
5019
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005021
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005022 /*
5023 * Check version identifier
5024 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005025 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5026 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005027 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005028
5029 if (memcmp(p, ssl_serialized_context_header,
5030 sizeof(ssl_serialized_context_header)) != 0) {
5031 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5032 }
5033 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005034
5035 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005036 * Session
5037 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 if ((size_t) (end - p) < 4) {
5039 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5040 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005041
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005042 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005043 p += 4;
5044
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005045 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005046 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005047 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005048 ssl->session_in = ssl->session;
5049 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005050 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005051
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 if ((size_t) (end - p) < session_len) {
5053 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5054 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005055
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 ret = ssl_session_load(ssl->session, 1, p, session_len);
5057 if (ret != 0) {
5058 mbedtls_ssl_session_free(ssl->session);
5059 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005060 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005061
5062 p += session_len;
5063
5064 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005065 * Transform
5066 */
5067
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005068 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005069 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005070#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005071 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005072 ssl->transform_in = ssl->transform;
5073 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005074 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005075#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005076
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005077#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5079 if (prf_func == NULL) {
5080 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5081 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005082
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005083 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5085 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5086 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005087
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 ret = ssl_tls12_populate_transform(ssl->transform,
5089 ssl->session->ciphersuite,
5090 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005091#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005093#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 prf_func,
5095 p, /* currently pointing to randbytes */
5096 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5097 ssl->conf->endpoint,
5098 ssl);
5099 if (ret != 0) {
5100 return ret;
5101 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005102#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005104
5105#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5106 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 if ((size_t) (end - p) < 1) {
5108 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5109 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005110
5111 ssl->transform->in_cid_len = *p++;
5112
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5114 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5115 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005116
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005118 p += ssl->transform->in_cid_len;
5119
5120 ssl->transform->out_cid_len = *p++;
5121
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5123 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5124 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005125
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005127 p += ssl->transform->out_cid_len;
5128#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5129
5130 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005131 * Saved fields from top-level ssl_context structure
5132 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 if ((size_t) (end - p) < 4) {
5134 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5135 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005136
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005137 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005138 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005139
5140#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 if ((size_t) (end - p) < 16) {
5142 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5143 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005144
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005145 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005146 p += 8;
5147
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005148 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005149 p += 8;
5150#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5151
5152#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 if ((size_t) (end - p) < 1) {
5154 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5155 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005156
5157 ssl->disable_datagram_packing = *p++;
5158#endif /* MBEDTLS_SSL_PROTO_DTLS */
5159
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5161 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5162 }
5163 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5164 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005165
5166#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 if ((size_t) (end - p) < 2) {
5168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5169 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005170
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005171 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005172 p += 2;
5173#endif /* MBEDTLS_SSL_PROTO_DTLS */
5174
5175#if defined(MBEDTLS_SSL_ALPN)
5176 {
5177 uint8_t alpn_len;
5178 const char **cur;
5179
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 if ((size_t) (end - p) < 1) {
5181 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5182 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005183
5184 alpn_len = *p++;
5185
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005187 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5189 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005190 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005191 ssl->alpn_chosen = *cur;
5192 break;
5193 }
5194 }
5195 }
5196
5197 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5199 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5200 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005201
5202 p += alpn_len;
5203 }
5204#endif /* MBEDTLS_SSL_ALPN */
5205
5206 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005207 * Forced fields from top-level ssl_context structure
5208 *
5209 * Most of them already set to the correct value by mbedtls_ssl_init() and
5210 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5211 */
5212 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005213 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005214
Hanno Becker361b10d2019-08-30 10:42:49 +01005215 /* Adjust pointers for header fields of outgoing records to
5216 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005218
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005219#if defined(MBEDTLS_SSL_PROTO_DTLS)
5220 ssl->in_epoch = 1;
5221#endif
5222
5223 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5224 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005225 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5226 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 if (ssl->handshake != NULL) {
5228 mbedtls_ssl_handshake_free(ssl);
5229 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005230 ssl->handshake = NULL;
5231 }
5232
5233 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005234 * Done - should have consumed entire buffer
5235 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 if (p != end) {
5237 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5238 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005239
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005241}
5242
5243/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005244 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005245 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005246int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5247 const unsigned char *buf,
5248 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005249{
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005251
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 if (ret != 0) {
5253 mbedtls_ssl_free(context);
5254 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005255
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005257}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005258#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005259
5260/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005261 * Free an SSL context
5262 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005263void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005264{
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005266 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005268
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005270
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005272#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5273 size_t out_buf_len = ssl->out_buf_len;
5274#else
5275 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5276#endif
5277
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005278 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005279 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005280 }
5281
Gilles Peskine449bd832023-01-11 14:50:10 +01005282 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005283#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5284 size_t in_buf_len = ssl->in_buf_len;
5285#else
5286 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5287#endif
5288
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005289 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005290 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005291 }
5292
Gilles Peskine449bd832023-01-11 14:50:10 +01005293 if (ssl->transform) {
5294 mbedtls_ssl_transform_free(ssl->transform);
5295 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005296 }
5297
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 if (ssl->handshake) {
5299 mbedtls_ssl_handshake_free(ssl);
5300 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005301
5302#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5304 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005305#endif
5306
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 mbedtls_ssl_session_free(ssl->session_negotiate);
5308 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005309 }
5310
Ronald Cron6f135e12021-12-08 16:57:54 +01005311#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005312 mbedtls_ssl_transform_free(ssl->transform_application);
5313 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005314#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005315
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 if (ssl->session) {
5317 mbedtls_ssl_session_free(ssl->session);
5318 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005319 }
5320
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005321#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01005322 mbedtls_ssl_free_hostname(ssl);
Paul Bakker0be444a2013-08-27 21:55:01 +02005323#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005324
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005325#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005327#endif
5328
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005330
Paul Bakker86f04f42013-02-14 11:20:09 +01005331 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005333}
5334
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005335/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005336 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005337 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005338void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005339{
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005341}
5342
Gilles Peskineae270bf2021-06-02 00:05:29 +02005343/* The selection should be the same as mbedtls_x509_crt_profile_default in
5344 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005345 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005346 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005347 * about this list.
5348 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005349static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005350#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005351 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005352#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005353#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005354 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005355#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005356#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005357 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005358#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005359#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005360 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005361#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005362#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005363 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005364#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005365#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005366 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005367#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005368#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005369 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005370#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005371#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005372 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005373#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005374#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005375 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5376 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5377 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5378 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5379 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5380#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005381 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005382};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005383
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005384static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005385 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5386 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5387 0
5388};
5389
Ronald Crone68ab4f2022-10-05 12:46:29 +02005390#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005391
Jerry Yu909df7b2022-01-22 11:56:27 +08005392/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005393 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005394 * rules SHOULD be upheld.
5395 * - No duplicate entries.
5396 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005397 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005398 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005399 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005400static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005401
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005402#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005403 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005404 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005405 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005406 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5407#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005408
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005409#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005410 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005411 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005412 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005413 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5414#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005415
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005416#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005417 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005418 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005419 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005420 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5421#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005422
Gabor Mezeic15ef932024-06-13 12:53:54 +02005423#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005424 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005425#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005426
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005427#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005428 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005429#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005430
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005431#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005432 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005433#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005434
Gabor Mezeic15ef932024-06-13 12:53:54 +02005435#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005436 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005437#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005438
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005439#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005440 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005441#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005442
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005443#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005444 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005445#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005446
Gabor Mezei15b95a62022-05-09 16:37:58 +02005447 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005448};
5449
5450/* NOTICE: see above */
5451#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5452static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005453
Gabor Mezeic15ef932024-06-13 12:53:54 +02005454#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005455#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005457#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005458#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5459 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005460#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005461#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005463#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005464#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005465
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005466#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005467#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005469#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005470#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5471 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005472#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005473#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005475#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005476#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005477
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005478#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005479#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005481#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005482#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5483 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005484#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005485#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005487#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005488#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005489
Gabor Mezei15b95a62022-05-09 16:37:58 +02005490 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005491};
5492#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005493
Jerry Yu909df7b2022-01-22 11:56:27 +08005494/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005495static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005496
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005497#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005498 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005499 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005500 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005501 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5502#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005503
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005504#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005505 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005506 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005507 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005508 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5509#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005510
Gabor Mezei15b95a62022-05-09 16:37:58 +02005511 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005512};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005513
Jerry Yu909df7b2022-01-22 11:56:27 +08005514/* NOTICE: see above */
5515#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5516static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005517
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005518#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005519#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005521#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005522#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005523
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005524#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005525#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005526 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005527#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005528#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005529
Gabor Mezei15b95a62022-05-09 16:37:58 +02005530 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005531};
Jerry Yu909df7b2022-01-22 11:56:27 +08005532#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5533
Ronald Crone68ab4f2022-10-05 12:46:29 +02005534#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005535
Chien Wong4e9683e2023-12-28 17:07:43 +08005536static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005537#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005538 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005539#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005540#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005541 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005542#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005543 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005544};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005545
Ronald Crone68ab4f2022-10-05 12:46:29 +02005546#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005547/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005548 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005549MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005550static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005551{
5552 size_t i, j;
5553 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005554
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5556 for (j = 0; j < i; j++) {
5557 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005558 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 }
5560 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5561 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5562 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005563 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005564 }
5565 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005567}
5568
Ronald Crone68ab4f2022-10-05 12:46:29 +02005569#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005570
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005571/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005572 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005573 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005574int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5575 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005576{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005577#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005578 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005579#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005580
Ronald Crone68ab4f2022-10-05 12:46:29 +02005581#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5583 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5584 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005585 }
5586
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5588 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5589 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005590 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005591
5592#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5594 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5595 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005596 }
5597
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5599 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5600 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005601 }
5602#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005603#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005604
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005605 /* Use the functions here so that they are covered in tests,
5606 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 mbedtls_ssl_conf_endpoint(conf, endpoint);
5608 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005609
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005610 /*
5611 * Things that are common to all presets
5612 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005613#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005615 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5616#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5617 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5618#endif
5619 }
5620#endif
5621
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005622#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5623 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5624#endif
5625
5626#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5627 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5628#endif
5629
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005630#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005631 conf->f_cookie_write = ssl_cookie_write_dummy;
5632 conf->f_cookie_check = ssl_cookie_check_dummy;
5633#endif
5634
5635#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5636 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5637#endif
5638
Janos Follath088ce432017-04-10 12:42:31 +01005639#if defined(MBEDTLS_SSL_SRV_C)
5640 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005641 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005642#endif
5643
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005644#if defined(MBEDTLS_SSL_PROTO_DTLS)
5645 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5646 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5647#endif
5648
5649#if defined(MBEDTLS_SSL_RENEGOTIATION)
5650 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 memset(conf->renego_period, 0x00, 2);
5652 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005653#endif
5654
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005655#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005657 const unsigned char dhm_p[] =
5658 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5659 const unsigned char dhm_g[] =
5660 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005661
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5663 dhm_p, sizeof(dhm_p),
5664 dhm_g, sizeof(dhm_g))) != 0) {
5665 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005666 }
5667 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005668#endif
5669
Ronald Cron6f135e12021-12-08 16:57:54 +01005670#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005671
5672#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005673 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005674#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005675 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005676#endif
5677#endif /* MBEDTLS_SSL_EARLY_DATA */
5678
Jerry Yud0766ec2022-09-22 10:46:57 +08005679#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005680 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005681 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005682#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005683 /*
5684 * Allow all TLS 1.3 key exchange modes by default.
5685 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005686 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005687#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005688
Gilles Peskine449bd832023-01-11 14:50:10 +01005689 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005690#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005691 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005692 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005693#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005695#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005697#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005698 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5699 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005700#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5701 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5702 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5703#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5704 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5705 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5706#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005708#endif
5709 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005710
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005711 /*
5712 * Preset-specific defaults
5713 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005715 /*
5716 * NSA Suite B
5717 */
5718 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005719
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005720 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005721
5722#if defined(MBEDTLS_X509_CRT_PARSE_C)
5723 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005724#endif
5725
Ronald Crone68ab4f2022-10-05 12:46:29 +02005726#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005727#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005729 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005731#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005733#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005734
Brett Warrene0edc842021-08-17 09:53:13 +01005735 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005736 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005737
5738 /*
5739 * Default
5740 */
5741 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005742
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005743 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005744
5745#if defined(MBEDTLS_X509_CRT_PARSE_C)
5746 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5747#endif
5748
Ronald Crone68ab4f2022-10-05 12:46:29 +02005749#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005750#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005752 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005754#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005756#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005757
Brett Warrene0edc842021-08-17 09:53:13 +01005758 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005759
5760#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5761 conf->dhm_min_bitlen = 1024;
5762#endif
5763 }
5764
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005766}
5767
5768/*
5769 * Free mbedtls_ssl_config
5770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005771void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005772{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005773 if (conf == NULL) {
5774 return;
5775 }
5776
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005777#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005778 mbedtls_mpi_free(&conf->dhm_P);
5779 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005780#endif
5781
Ronald Cron73fe8df2022-10-05 14:31:43 +02005782#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005783 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005784 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5785 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005787 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005788 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005789 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005790 }
5791
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005793 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005794 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005795 conf->psk_identity_len = 0;
5796 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005797#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005798
5799#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005801#endif
5802
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005804}
5805
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005806#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005807 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005808/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005809 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005810 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005811unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005812{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005813#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5815 return MBEDTLS_SSL_SIG_RSA;
5816 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005817#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005818#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5820 return MBEDTLS_SSL_SIG_ECDSA;
5821 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005822#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005824}
5825
Gilles Peskine449bd832023-01-11 14:50:10 +01005826unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005827{
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005829 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005831 case MBEDTLS_PK_ECDSA:
5832 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005834 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005835 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005836 }
5837}
5838
Gilles Peskine449bd832023-01-11 14:50:10 +01005839mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005840{
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005842#if defined(MBEDTLS_RSA_C)
5843 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005845#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005846#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005847 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005849#endif
5850 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005852 }
5853}
Valerio Settie9646ec2023-08-02 20:02:28 +02005854#endif /* MBEDTLS_PK_C &&
5855 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005856
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005857/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005858 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005859 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005860mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005861{
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005863#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005864 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005866#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005867#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005868 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005870#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005871#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005872 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005873 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005874#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005875#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005876 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005877 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005878#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005879#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005880 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005881 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005882#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005883#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005884 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005886#endif
5887 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005889 }
5890}
5891
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005892/*
5893 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5894 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005895unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005896{
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005898#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005899 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005901#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005902#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005903 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005904 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005905#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005906#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005907 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005909#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005910#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005911 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005913#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005914#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005915 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005917#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005918#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005919 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005920 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005921#endif
5922 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005924 }
5925}
5926
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005927/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005928 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005929 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005930 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005931int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005932{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005933 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005934
Gilles Peskine449bd832023-01-11 14:50:10 +01005935 if (group_list == NULL) {
5936 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005937 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005938
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 for (; *group_list != 0; group_list++) {
5940 if (*group_list == tls_id) {
5941 return 0;
5942 }
5943 }
5944
5945 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005946}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005947
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005948#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005949/*
5950 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005952int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005953{
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005955
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005957 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005959
Gilles Peskine449bd832023-01-11 14:50:10 +01005960 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005961}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005962#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005963
Valerio Setti18c9fed2022-12-30 17:44:24 +01005964static const struct {
5965 uint16_t tls_id;
5966 mbedtls_ecp_group_id ecp_group_id;
5967 psa_ecc_family_t psa_family;
5968 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005969} tls_id_match_table[] =
5970{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005971#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005972 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005973#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005974#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005975 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005976#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005977#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005978 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005979#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005980#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005981 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005982#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005983#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005984 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005985#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005986#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005987 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005988#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005989#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005990 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005991#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005992#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005993 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005994#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005995#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005996 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005997#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005998#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005999 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006000#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01006001#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02006002 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006003#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01006004#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006005 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006006#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006007 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006008};
6009
Gilles Peskine449bd832023-01-11 14:50:10 +01006010int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006011 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006013{
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6015 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006016 if (type != NULL) {
6017 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 }
6019 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006020 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006022 return PSA_SUCCESS;
6023 }
6024 }
6025
6026 return PSA_ERROR_NOT_SUPPORTED;
6027}
6028
Gilles Peskine449bd832023-01-11 14:50:10 +01006029mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006030{
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6032 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006033 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006035 }
6036
6037 return MBEDTLS_ECP_DP_NONE;
6038}
6039
Gilles Peskine449bd832023-01-11 14:50:10 +01006040uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006041{
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6043 i++) {
6044 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006045 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006047 }
6048
6049 return 0;
6050}
6051
Valerio Setti67419f02023-01-04 16:12:42 +01006052#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006053static const struct {
6054 uint16_t tls_id;
6055 const char *name;
6056} tls_id_curve_name_table[] =
6057{
Valerio Setti54e23792023-07-07 10:49:27 +02006058 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6059 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6060 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6061 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6062 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6063 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6064 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6065 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6066 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6067 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6068 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6069 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6070 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006071 { 0, NULL },
6072};
6073
Gilles Peskine449bd832023-01-11 14:50:10 +01006074const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006075{
Valerio Settiacd32c02023-06-29 18:06:29 +02006076 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6077 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6078 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006080 }
6081
6082 return NULL;
6083}
Valerio Setti67419f02023-01-04 16:12:42 +01006084#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006085
Gilles Peskine449bd832023-01-11 14:50:10 +01006086int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6087 const mbedtls_md_type_t md,
6088 unsigned char *dst,
6089 size_t dst_len,
6090 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006091{
Ronald Cronf6893e12022-01-07 22:09:01 +01006092 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6093 psa_hash_operation_t *hash_operation_to_clone;
6094 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6095
Jerry Yu148165c2021-09-24 23:20:59 +08006096 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006097
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006099#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 case MBEDTLS_MD_SHA384:
6101 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6102 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006103#endif
6104
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006105#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 case MBEDTLS_MD_SHA256:
6107 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6108 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006109#endif
6110
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 default:
6112 goto exit;
6113 }
6114
6115 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6116 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006117 goto exit;
6118 }
6119
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6121 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006122 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006124
6125exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006126#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006127 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006128 (void) ssl;
6129#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006130 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006131}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006132
Ronald Crone68ab4f2022-10-05 12:46:29 +02006133#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006134/* mbedtls_ssl_parse_sig_alg_ext()
6135 *
6136 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6137 * value (TLS 1.3 RFC8446):
6138 * enum {
6139 * ....
6140 * ecdsa_secp256r1_sha256( 0x0403 ),
6141 * ecdsa_secp384r1_sha384( 0x0503 ),
6142 * ecdsa_secp521r1_sha512( 0x0603 ),
6143 * ....
6144 * } SignatureScheme;
6145 *
6146 * struct {
6147 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6148 * } SignatureSchemeList;
6149 *
6150 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6151 * value (TLS 1.2 RFC5246):
6152 * enum {
6153 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6154 * sha512(6), (255)
6155 * } HashAlgorithm;
6156 *
6157 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6158 * SignatureAlgorithm;
6159 *
6160 * struct {
6161 * HashAlgorithm hash;
6162 * SignatureAlgorithm signature;
6163 * } SignatureAndHashAlgorithm;
6164 *
6165 * SignatureAndHashAlgorithm
6166 * supported_signature_algorithms<2..2^16-2>;
6167 *
6168 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6169 * generalization of the TLS 1.2 signature algorithm extension.
6170 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6171 * `SignatureScheme` field of TLS 1.3
6172 *
6173 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006174int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6175 const unsigned char *buf,
6176 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006177{
6178 const unsigned char *p = buf;
6179 size_t supported_sig_algs_len = 0;
6180 const unsigned char *supported_sig_algs_end;
6181 uint16_t sig_alg;
6182 uint32_t common_idx = 0;
6183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6185 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006186 p += 2;
6187
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 memset(ssl->handshake->received_sig_algs, 0,
6189 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006190
Gilles Peskine449bd832023-01-11 14:50:10 +01006191 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006192 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 while (p < supported_sig_algs_end) {
6194 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6195 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006196 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6198 sig_alg,
6199 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006200#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6202 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6203 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006204 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006205 }
6206#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006207
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6209 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006210
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006212 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6213 common_idx += 1;
6214 }
6215 }
6216 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 if (p != end) {
6218 MBEDTLS_SSL_DEBUG_MSG(1,
6219 ("Signature algorithms extension length misaligned"));
6220 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6221 MBEDTLS_ERR_SSL_DECODE_ERROR);
6222 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006223 }
6224
Gilles Peskine449bd832023-01-11 14:50:10 +01006225 if (common_idx == 0) {
6226 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6227 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6228 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6229 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006230 }
6231
Gabor Mezei15b95a62022-05-09 16:37:58 +02006232 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006234}
6235
Ronald Crone68ab4f2022-10-05 12:46:29 +02006236#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006237
Jerry Yudc7bd172022-02-17 13:44:15 +08006238#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6239
Jerry Yudc7bd172022-02-17 13:44:15 +08006240
Gilles Peskine449bd832023-01-11 14:50:10 +01006241static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6242 mbedtls_svc_key_id_t key,
6243 psa_algorithm_t alg,
6244 const unsigned char *raw_psk, size_t raw_psk_length,
6245 const unsigned char *seed, size_t seed_length,
6246 const unsigned char *label, size_t label_length,
6247 const unsigned char *other_secret,
6248 size_t other_secret_length,
6249 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006250{
6251 psa_status_t status;
6252
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 status = psa_key_derivation_setup(derivation, alg);
6254 if (status != PSA_SUCCESS) {
6255 return status;
6256 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006257
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6259 status = psa_key_derivation_input_bytes(derivation,
6260 PSA_KEY_DERIVATION_INPUT_SEED,
6261 seed, seed_length);
6262 if (status != PSA_SUCCESS) {
6263 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006264 }
6265
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 if (other_secret != NULL) {
6267 status = psa_key_derivation_input_bytes(derivation,
6268 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6269 other_secret, other_secret_length);
6270 if (status != PSA_SUCCESS) {
6271 return status;
6272 }
6273 }
6274
6275 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006276 status = psa_key_derivation_input_bytes(
6277 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 raw_psk, raw_psk_length);
6279 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006280 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006282 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 if (status != PSA_SUCCESS) {
6284 return status;
6285 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006286
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 status = psa_key_derivation_input_bytes(derivation,
6288 PSA_KEY_DERIVATION_INPUT_LABEL,
6289 label, label_length);
6290 if (status != PSA_SUCCESS) {
6291 return status;
6292 }
6293 } else {
6294 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006295 }
6296
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 status = psa_key_derivation_set_capacity(derivation, capacity);
6298 if (status != PSA_SUCCESS) {
6299 return status;
6300 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006301
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006303}
6304
Andrzej Kurek57d10632022-10-24 10:32:01 -04006305#if defined(PSA_WANT_ALG_SHA_384) || \
6306 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006307MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006308static int tls_prf_generic(mbedtls_md_type_t md_type,
6309 const unsigned char *secret, size_t slen,
6310 const char *label,
6311 const unsigned char *random, size_t rlen,
6312 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006313{
6314 psa_status_t status;
6315 psa_algorithm_t alg;
6316 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6317 psa_key_derivation_operation_t derivation =
6318 PSA_KEY_DERIVATION_OPERATION_INIT;
6319
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006321 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006322 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006323 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006324 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006325
6326 /* Normally a "secret" should be long enough to be impossible to
6327 * find by brute force, and in particular should not be empty. But
6328 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6329 * and for this use case it makes sense to have a 0-length "secret".
6330 * Since the key API doesn't allow importing a key of length 0,
6331 * keep master_key=0, which setup_psa_key_derivation() understands
6332 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006334 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006335 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6336 psa_set_key_algorithm(&key_attributes, alg);
6337 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006338
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6340 if (status != PSA_SUCCESS) {
6341 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6342 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006343 }
6344
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 status = setup_psa_key_derivation(&derivation,
6346 master_key, alg,
6347 NULL, 0,
6348 random, rlen,
6349 (unsigned char const *) label,
6350 (size_t) strlen(label),
6351 NULL, 0,
6352 dlen);
6353 if (status != PSA_SUCCESS) {
6354 psa_key_derivation_abort(&derivation);
6355 psa_destroy_key(master_key);
6356 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006357 }
6358
Gilles Peskine449bd832023-01-11 14:50:10 +01006359 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6360 if (status != PSA_SUCCESS) {
6361 psa_key_derivation_abort(&derivation);
6362 psa_destroy_key(master_key);
6363 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006364 }
6365
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 status = psa_key_derivation_abort(&derivation);
6367 if (status != PSA_SUCCESS) {
6368 psa_destroy_key(master_key);
6369 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006370 }
6371
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 if (!mbedtls_svc_key_id_is_null(master_key)) {
6373 status = psa_destroy_key(master_key);
6374 }
6375 if (status != PSA_SUCCESS) {
6376 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6377 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006378
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006380}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006381#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006382
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006383#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006384MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006385static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6386 const char *label,
6387 const unsigned char *random, size_t rlen,
6388 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006389{
Gilles Peskine449bd832023-01-11 14:50:10 +01006390 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6391 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006392}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006393#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006394
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006395#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006396MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006397static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6398 const char *label,
6399 const unsigned char *random, size_t rlen,
6400 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006401{
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6403 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006404}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006405#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006406
Jerry Yuf009d862022-02-17 14:01:37 +08006407/*
6408 * Set appropriate PRF function and other SSL / TLS1.2 functions
6409 *
6410 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006411 * - hash associated with the ciphersuite (only used by TLS 1.2)
6412 *
6413 * Outputs:
6414 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6415 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006416MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006417static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6418 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006419{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006420#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006422 handshake->tls_prf = tls_prf_sha384;
6423 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6424 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006426#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006427#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006428 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006429 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006430 handshake->tls_prf = tls_prf_sha256;
6431 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6432 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6433 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006434#else
Jerry Yuf009d862022-02-17 14:01:37 +08006435 {
Jerry Yuf009d862022-02-17 14:01:37 +08006436 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006437 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006439 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006440#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006441
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006443}
Jerry Yud6ab2352022-02-17 14:03:43 +08006444
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006445/*
6446 * Compute master secret if needed
6447 *
6448 * Parameters:
6449 * [in/out] handshake
6450 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6451 * (PSA-PSK) ciphersuite_info, psk_opaque
6452 * [out] premaster (cleared)
6453 * [out] master
6454 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6455 * debug: conf->f_dbg, conf->p_dbg
6456 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006457 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006458 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006459MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006460static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6461 unsigned char *master,
6462 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006463{
6464 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6465
6466 /* cf. RFC 5246, Section 8.1:
6467 * "The master secret is always exactly 48 bytes in length." */
6468 size_t const master_secret_len = 48;
6469
6470#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6471 unsigned char session_hash[48];
6472#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6473
6474 /* The label for the KDF used for key expansion.
6475 * This is either "master secret" or "extended master secret"
6476 * depending on whether the Extended Master Secret extension
6477 * is used. */
6478 char const *lbl = "master secret";
6479
Przemek Stekielae4ed302022-04-05 17:15:55 +02006480 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006481 * - If the Extended Master Secret extension is not used,
6482 * this is ClientHello.Random + ServerHello.Random
6483 * (see Sect. 8.1 in RFC 5246).
6484 * - If the Extended Master Secret extension is used,
6485 * this is the transcript of the handshake so far.
6486 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006487 unsigned char const *seed = handshake->randbytes;
6488 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006489
6490#if !defined(MBEDTLS_DEBUG_C) && \
6491 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006492 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006493 ssl = NULL; /* make sure we don't use it except for those cases */
6494 (void) ssl;
6495#endif
6496
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 if (handshake->resume != 0) {
6498 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6499 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006500 }
6501
6502#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006504 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006505 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006506 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6507 if (ret != 0) {
6508 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6509 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006510
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6512 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006513 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006514#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006515
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006516#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006518 /* Perform PSK-to-MS expansion in a single step. */
6519 psa_status_t status;
6520 psa_algorithm_t alg;
6521 mbedtls_svc_key_id_t psk;
6522 psa_key_derivation_operation_t derivation =
6523 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006524 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006525
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006527
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006529
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006531 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006533 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006535
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006536 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006538
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006540 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006541 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006542 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006543 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006544 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6545 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6546 other_secret = handshake->premaster + 2;
6547 break;
6548 default:
6549 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006550 }
6551
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 status = setup_psa_key_derivation(&derivation, psk, alg,
6553 ssl->conf->psk, ssl->conf->psk_len,
6554 seed, seed_len,
6555 (unsigned char const *) lbl,
6556 (size_t) strlen(lbl),
6557 other_secret, other_secret_len,
6558 master_secret_len);
6559 if (status != PSA_SUCCESS) {
6560 psa_key_derivation_abort(&derivation);
6561 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006562 }
6563
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 status = psa_key_derivation_output_bytes(&derivation,
6565 master,
6566 master_secret_len);
6567 if (status != PSA_SUCCESS) {
6568 psa_key_derivation_abort(&derivation);
6569 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006570 }
6571
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 status = psa_key_derivation_abort(&derivation);
6573 if (status != PSA_SUCCESS) {
6574 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6575 }
6576 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006577#endif
6578 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006579#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006581 psa_status_t status;
6582 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6583 psa_key_derivation_operation_t derivation =
6584 PSA_KEY_DERIVATION_OPERATION_INIT;
6585
Gilles Peskine449bd832023-01-11 14:50:10 +01006586 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006587
6588 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6589
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 status = psa_key_derivation_setup(&derivation, alg);
6591 if (status != PSA_SUCCESS) {
6592 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006593 }
6594
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 status = psa_key_derivation_set_capacity(&derivation,
6596 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6597 if (status != PSA_SUCCESS) {
6598 psa_key_derivation_abort(&derivation);
6599 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006600 }
6601
Gilles Peskine449bd832023-01-11 14:50:10 +01006602 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6603 &derivation);
6604 if (status != PSA_SUCCESS) {
6605 psa_key_derivation_abort(&derivation);
6606 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006607 }
6608
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 status = psa_key_derivation_output_bytes(&derivation,
6610 handshake->premaster,
6611 handshake->pmslen);
6612 if (status != PSA_SUCCESS) {
6613 psa_key_derivation_abort(&derivation);
6614 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6615 }
6616
6617 status = psa_key_derivation_abort(&derivation);
6618 if (status != PSA_SUCCESS) {
6619 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006620 }
6621 }
6622#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6624 lbl, seed, seed_len,
6625 master,
6626 master_secret_len);
6627 if (ret != 0) {
6628 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6629 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006630 }
6631
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6633 handshake->premaster,
6634 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006635
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 mbedtls_platform_zeroize(handshake->premaster,
6637 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006638 }
6639
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006641}
6642
Gilles Peskine449bd832023-01-11 14:50:10 +01006643int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006644{
6645 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6646 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6647 ssl->handshake->ciphersuite_info;
6648
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006650
6651 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006653 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006654 if (ret != 0) {
6655 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6656 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006657 }
6658
6659 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006660 ret = ssl_compute_master(ssl->handshake,
6661 ssl->session_negotiate->master,
6662 ssl);
6663 if (ret != 0) {
6664 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6665 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006666 }
6667
6668 /* Swap the client and server random values:
6669 * - MS derivation wanted client+server (RFC 5246 8.1)
6670 * - key derivation wants server+client (RFC 5246 6.3) */
6671 {
6672 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006673 memcpy(tmp, ssl->handshake->randbytes, 64);
6674 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6675 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6676 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006677 }
6678
6679 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006680 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6681 ssl->session_negotiate->ciphersuite,
6682 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006683#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006684 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006685#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006686 ssl->handshake->tls_prf,
6687 ssl->handshake->randbytes,
6688 ssl->tls_version,
6689 ssl->conf->endpoint,
6690 ssl);
6691 if (ret != 0) {
6692 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6693 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006694 }
6695
6696 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006697 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6698 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006699
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006701
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006703}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006704
Gilles Peskine449bd832023-01-11 14:50:10 +01006705int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006706{
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006708#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006709 case MBEDTLS_SSL_HASH_SHA384:
6710 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6711 break;
6712#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006713#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006714 case MBEDTLS_SSL_HASH_SHA256:
6715 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6716 break;
6717#endif
6718 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006719 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006720 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006721#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006722 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006723 (void) ssl;
6724#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006725 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006726}
6727
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006728static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6729 const psa_hash_operation_t *hs_op,
6730 size_t buffer_size,
6731 unsigned char *hash,
6732 size_t *hlen)
6733{
6734 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006735 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006736
6737#if !defined(MBEDTLS_DEBUG_C)
6738 (void) ssl;
6739#endif
6740 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006741 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006742 if (status != PSA_SUCCESS) {
6743 goto exit;
6744 }
6745
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006746 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006747 if (status != PSA_SUCCESS) {
6748 goto exit;
6749 }
6750
6751 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6752 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6753
6754exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006755 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006756 return mbedtls_md_error_from_psa(status);
6757}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006758
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006759#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006760int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6761 unsigned char *hash,
6762 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006763{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006764 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6765 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006766}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006767#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006768
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006769#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006770int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6771 unsigned char *hash,
6772 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006773{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006774 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6775 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006776}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006777#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006778
Jerry Yuc2c673d2022-02-17 14:20:39 +08006779#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006780MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006781static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006782
6783#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006784int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006785{
6786 /* If renegotiation is not enforced, retransmit until we would reach max
6787 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006789 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6790 unsigned char doublings = 1;
6791
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006793 ++doublings;
6794 ratio >>= 1;
6795 }
6796
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 if (++ssl->renego_records_seen > doublings) {
6798 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6799 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006800 }
6801 }
6802
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006804}
6805#endif
6806#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006807
Jerry Yud9526692022-02-17 14:23:47 +08006808/*
6809 * Handshake functions
6810 */
6811#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6812/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006813int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006814{
6815 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6816 ssl->handshake->ciphersuite_info;
6817
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006819
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6821 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006822 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006823 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006824 }
6825
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6827 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006828}
6829
Gilles Peskine449bd832023-01-11 14:50:10 +01006830int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006831{
6832 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6833 ssl->handshake->ciphersuite_info;
6834
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006836
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6838 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006839 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006841 }
6842
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6844 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006845}
6846
6847#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6848/* Some certificate support -> implement write and parse */
6849
Gilles Peskine449bd832023-01-11 14:50:10 +01006850int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006851{
6852 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6853 size_t i, n;
6854 const mbedtls_x509_crt *crt;
6855 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6856 ssl->handshake->ciphersuite_info;
6857
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006859
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6861 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006862 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006864 }
6865
6866#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6868 if (ssl->handshake->client_auth == 0) {
6869 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006870 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006872 }
6873 }
6874#endif /* MBEDTLS_SSL_CLI_C */
6875#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6877 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006878 /* Should never happen because we shouldn't have picked the
6879 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006881 }
6882 }
6883#endif
6884
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006886
6887 /*
6888 * 0 . 0 handshake type
6889 * 1 . 3 handshake length
6890 * 4 . 6 length of all certs
6891 * 7 . 9 length of cert. 1
6892 * 10 . n-1 peer certificate
6893 * n . n+2 length of cert. 2
6894 * n+3 . ... upper level cert, etc.
6895 */
6896 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006897 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006898
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006900 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6902 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6903 " > %" MBEDTLS_PRINTF_SIZET,
6904 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6905 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006906 }
6907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6909 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6910 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006911
Gilles Peskine449bd832023-01-11 14:50:10 +01006912 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006913 i += n; crt = crt->next;
6914 }
6915
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6917 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6918 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006919
6920 ssl->out_msglen = i;
6921 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6922 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6923
6924 ssl->state++;
6925
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6927 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6928 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006929 }
6930
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006932
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006934}
6935
6936#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6937
6938#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006939MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006940static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6941 unsigned char *crt_buf,
6942 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006943{
6944 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6945
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 if (peer_crt == NULL) {
6947 return -1;
6948 }
Jerry Yud9526692022-02-17 14:23:47 +08006949
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 if (peer_crt->raw.len != crt_buf_len) {
6951 return -1;
6952 }
Jerry Yud9526692022-02-17 14:23:47 +08006953
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006955}
6956#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006957MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006958static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6959 unsigned char *crt_buf,
6960 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006961{
6962 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6963 unsigned char const * const peer_cert_digest =
6964 ssl->session->peer_cert_digest;
6965 mbedtls_md_type_t const peer_cert_digest_type =
6966 ssl->session->peer_cert_digest_type;
6967 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006969 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6970 size_t digest_len;
6971
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 if (peer_cert_digest == NULL || digest_info == NULL) {
6973 return -1;
6974 }
Jerry Yud9526692022-02-17 14:23:47 +08006975
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 digest_len = mbedtls_md_get_size(digest_info);
6977 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6978 return -1;
6979 }
Jerry Yud9526692022-02-17 14:23:47 +08006980
Gilles Peskine449bd832023-01-11 14:50:10 +01006981 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6982 if (ret != 0) {
6983 return -1;
6984 }
Jerry Yud9526692022-02-17 14:23:47 +08006985
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006987}
6988#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6989#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6990
6991/*
6992 * Once the certificate message is read, parse it into a cert chain and
6993 * perform basic checks, but leave actual verification to the caller
6994 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006995MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006996static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6997 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006998{
6999 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7000#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007002#endif
7003 size_t i, n;
7004 uint8_t alert;
7005
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7007 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7008 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7009 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7010 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007011 }
7012
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7014 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7015 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7016 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007017 }
7018
Gilles Peskine449bd832023-01-11 14:50:10 +01007019 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7020 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7021 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7022 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7023 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007024 }
7025
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007027
7028 /*
7029 * Same message structure as in mbedtls_ssl_write_certificate()
7030 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007031 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007032
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 if (ssl->in_msg[i] != 0 ||
7034 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7035 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7036 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7037 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7038 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007039 }
7040
7041 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7042 i += 3;
7043
7044 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007045 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007046 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 if (i + 3 > ssl->in_hslen) {
7048 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7049 mbedtls_ssl_send_alert_message(ssl,
7050 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7051 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7052 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007053 }
7054 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7055 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 if (ssl->in_msg[i] != 0) {
7057 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7058 mbedtls_ssl_send_alert_message(ssl,
7059 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7060 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7061 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007062 }
7063
7064 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007065 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007066 i += 3;
7067
Gilles Peskine449bd832023-01-11 14:50:10 +01007068 if (n < 128 || i + n > ssl->in_hslen) {
7069 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7070 mbedtls_ssl_send_alert_message(ssl,
7071 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7072 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7073 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007074 }
7075
7076 /* Check if we're handling the first CRT in the chain. */
7077#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007079 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007081 /* During client-side renegotiation, check that the server's
7082 * end-CRTs hasn't changed compared to the initial handshake,
7083 * mitigating the triple handshake attack. On success, reuse
7084 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7086 if (ssl_check_peer_crt_unchanged(ssl,
7087 &ssl->in_msg[i],
7088 n) != 0) {
7089 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7090 mbedtls_ssl_send_alert_message(ssl,
7091 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7092 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7093 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007094 }
7095
7096 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007098 }
7099#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7100
7101 /* Parse the next certificate in the chain. */
7102#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007103 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007104#else
7105 /* If we don't need to store the CRT chain permanently, parse
7106 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007108#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007110 case 0: /*ok*/
7111 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7112 /* Ignore certificate with an unknown algorithm: maybe a
7113 prior certificate was already trusted. */
7114 break;
7115
7116 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7117 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7118 goto crt_parse_der_failed;
7119
7120 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7121 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7122 goto crt_parse_der_failed;
7123
7124 default:
7125 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007126crt_parse_der_failed:
7127 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7128 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7129 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007130 }
7131
7132 i += n;
7133 }
7134
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7136 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007137}
7138
7139#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007140MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007141static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007142{
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7144 return -1;
7145 }
Jerry Yud9526692022-02-17 14:23:47 +08007146
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007148 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7149 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007150 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7151 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7152 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007153 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007155}
7156#endif /* MBEDTLS_SSL_SRV_C */
7157
7158/* Check if a certificate message is expected.
7159 * Return either
7160 * - SSL_CERTIFICATE_EXPECTED, or
7161 * - SSL_CERTIFICATE_SKIP
7162 * indicating whether a Certificate message is expected or not.
7163 */
7164#define SSL_CERTIFICATE_EXPECTED 0
7165#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007166MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007167static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7168 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007169{
7170 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7171 ssl->handshake->ciphersuite_info;
7172
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7174 return SSL_CERTIFICATE_SKIP;
7175 }
Jerry Yud9526692022-02-17 14:23:47 +08007176
7177#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007178 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007180 ssl->session_negotiate->verify_result =
7181 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007183 }
7184 }
7185#else
7186 ((void) authmode);
7187#endif /* MBEDTLS_SSL_SRV_C */
7188
Gilles Peskine449bd832023-01-11 14:50:10 +01007189 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007190}
7191
Jerry Yud9526692022-02-17 14:23:47 +08007192#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007193MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007194static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7195 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007196{
7197 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7198 /* Remember digest of the peer's end-CRT. */
7199 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007200 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7201 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7202 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7203 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7204 mbedtls_ssl_send_alert_message(ssl,
7205 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7206 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007207
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007209 }
7210
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 ret = mbedtls_md(mbedtls_md_info_from_type(
7212 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7213 start, len,
7214 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007215
7216 ssl->session_negotiate->peer_cert_digest_type =
7217 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7218 ssl->session_negotiate->peer_cert_digest_len =
7219 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7220
Gilles Peskine449bd832023-01-11 14:50:10 +01007221 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007222}
7223
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007224MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007225static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7226 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007227{
7228 unsigned char *end = start + len;
7229 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7230
7231 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007232 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7233 ret = mbedtls_pk_parse_subpubkey(&start, end,
7234 &ssl->handshake->peer_pubkey);
7235 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007236 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007238 }
7239
Gilles Peskine449bd832023-01-11 14:50:10 +01007240 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007241}
7242#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7243
Gilles Peskine449bd832023-01-11 14:50:10 +01007244int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007245{
7246 int ret = 0;
7247 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007248 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007249#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7250 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7251 ? ssl->handshake->sni_authmode
7252 : ssl->conf->authmode;
7253#else
7254 const int authmode = ssl->conf->authmode;
7255#endif
7256 void *rs_ctx = NULL;
7257 mbedtls_x509_crt *chain = NULL;
7258
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007260
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7262 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7263 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007264 goto exit;
7265 }
7266
7267#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 if (ssl->handshake->ecrs_enabled &&
7269 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007270 chain = ssl->handshake->ecrs_peer_cert;
7271 ssl->handshake->ecrs_peer_cert = NULL;
7272 goto crt_verify;
7273 }
7274#endif
7275
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007277 /* mbedtls_ssl_read_record may have sent an alert already. We
7278 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007279 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007280 goto exit;
7281 }
7282
7283#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007284 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007285 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7286
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007288 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007289 }
Jerry Yud9526692022-02-17 14:23:47 +08007290
7291 goto exit;
7292 }
7293#endif /* MBEDTLS_SSL_SRV_C */
7294
7295 /* Clear existing peer CRT structure in case we tried to
7296 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007298
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7300 if (chain == NULL) {
7301 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7302 sizeof(mbedtls_x509_crt)));
7303 mbedtls_ssl_send_alert_message(ssl,
7304 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7305 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007306
7307 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7308 goto exit;
7309 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007310 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007311
Gilles Peskine449bd832023-01-11 14:50:10 +01007312 ret = ssl_parse_certificate_chain(ssl, chain);
7313 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007314 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 }
Jerry Yud9526692022-02-17 14:23:47 +08007316
7317#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007318 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007319 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007320 }
Jerry Yud9526692022-02-17 14:23:47 +08007321
7322crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007324 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 }
Jerry Yud9526692022-02-17 14:23:47 +08007326#endif
7327
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007328 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7329 ssl->handshake->ciphersuite_info,
7330 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007332 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007333 }
Jerry Yud9526692022-02-17 14:23:47 +08007334
7335#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7336 {
7337 unsigned char *crt_start, *pk_start;
7338 size_t crt_len, pk_len;
7339
7340 /* We parse the CRT chain without copying, so
7341 * these pointers point into the input buffer,
7342 * and are hence still valid after freeing the
7343 * CRT chain. */
7344
7345 crt_start = chain->raw.p;
7346 crt_len = chain->raw.len;
7347
7348 pk_start = chain->pk_raw.p;
7349 pk_len = chain->pk_raw.len;
7350
7351 /* Free the CRT structures before computing
7352 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 mbedtls_x509_crt_free(chain);
7354 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007355 chain = NULL;
7356
Gilles Peskine449bd832023-01-11 14:50:10 +01007357 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7358 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007359 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 }
Jerry Yud9526692022-02-17 14:23:47 +08007361
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7363 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007364 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 }
Jerry Yud9526692022-02-17 14:23:47 +08007366 }
7367#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7368 /* Pass ownership to session structure. */
7369 ssl->session_negotiate->peer_cert = chain;
7370 chain = NULL;
7371#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7372
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007374
7375exit:
7376
Gilles Peskine449bd832023-01-11 14:50:10 +01007377 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007378 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 }
Jerry Yud9526692022-02-17 14:23:47 +08007380
7381#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007383 ssl->handshake->ecrs_peer_cert = chain;
7384 chain = NULL;
7385 }
7386#endif
7387
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 if (chain != NULL) {
7389 mbedtls_x509_crt_free(chain);
7390 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007391 }
7392
Gilles Peskine449bd832023-01-11 14:50:10 +01007393 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007394}
7395#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7396
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007397static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7398 unsigned char *padbuf, size_t hlen,
7399 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007400{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007401 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007402 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007403 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007404 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007405 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007406 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007407
7408 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007409 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007410 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007412
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007414 ? "client finished"
7415 : "server finished";
7416
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007417 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007418
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007419 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007421 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007422 }
7423
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007424 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007426 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007427 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007428 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007429
7430 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7431
Jerry Yu615bd6f2022-02-17 14:25:15 +08007432 /*
7433 * TLSv1.2:
7434 * hash = PRF( master, finished_label,
7435 * Hash( handshake ) )[0.11]
7436 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007438 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007439
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007441
Paul Elliottecb95be2023-08-11 16:41:04 +01007442 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007443
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007444 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007445
7446exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007447 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007448 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007449}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007450
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007451#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007452static int ssl_calc_finished_tls_sha256(
7453 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7454{
7455 unsigned char padbuf[32];
7456 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007457 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007458 padbuf, sizeof(padbuf),
7459 buf, from);
7460}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007461#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007462
Jerry Yub7ba49e2022-02-17 14:25:53 +08007463
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007464#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007465static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007467{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007468 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007469 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007470 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007471 padbuf, sizeof(padbuf),
7472 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007473}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007474#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007475
Gilles Peskine449bd832023-01-11 14:50:10 +01007476void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007477{
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007479
7480 /*
7481 * Free our handshake params
7482 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 mbedtls_ssl_handshake_free(ssl);
7484 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007485 ssl->handshake = NULL;
7486
7487 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007488 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007489 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 if (ssl->transform) {
7491 mbedtls_ssl_transform_free(ssl->transform);
7492 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007493 }
7494 ssl->transform = ssl->transform_negotiate;
7495 ssl->transform_negotiate = NULL;
7496
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007498}
7499
Gilles Peskine449bd832023-01-11 14:50:10 +01007500void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007501{
7502 int resume = ssl->handshake->resume;
7503
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007505
7506#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007508 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7509 ssl->renego_records_seen = 0;
7510 }
7511#endif
7512
7513 /*
7514 * Free the previous session and switch in the current one
7515 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007517#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7518 /* RFC 7366 3.1: keep the EtM state */
7519 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007521#endif
7522
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 mbedtls_ssl_session_free(ssl->session);
7524 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007525 }
7526 ssl->session = ssl->session_negotiate;
7527 ssl->session_negotiate = NULL;
7528
7529 /*
7530 * Add cache entry
7531 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007533 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 resume == 0) {
7535 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7536 ssl->session->id,
7537 ssl->session->id_len,
7538 ssl->session) != 0) {
7539 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7540 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007541 }
7542
7543#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7545 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007546 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007548
7549 /* Keep last flight around in case we need to resend it:
7550 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7552 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007553#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007555
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007556 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007557
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007559}
7560
Gilles Peskine449bd832023-01-11 14:50:10 +01007561int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007562{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007563 int ret;
7564 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007565
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 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007569
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007570 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7571 if (ret != 0) {
7572 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007573 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007574 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007575
7576 /*
7577 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7578 * may define some other value. Currently (early 2016), no defined
7579 * ciphersuite does this (and this is unlikely to change as activity has
7580 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7581 */
7582 hash_len = 12;
7583
7584#if defined(MBEDTLS_SSL_RENEGOTIATION)
7585 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007587#endif
7588
7589 ssl->out_msglen = 4 + hash_len;
7590 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7591 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7592
7593 /*
7594 * In case of session resuming, invert the client and server
7595 * ChangeCipherSpec messages order.
7596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007598#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007600 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007602#endif
7603#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007605 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007607#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007609 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007611
7612 /*
7613 * Switch to our negotiated transform and session parameters for outbound
7614 * data.
7615 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007617
7618#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007620 unsigned char i;
7621
7622 /* Remember current epoch settings for resending */
7623 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7625 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007626
7627 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007629
7630
7631 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 for (i = 2; i > 0; i--) {
7633 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007634 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 }
7636 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007637
7638 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 if (i == 0) {
7640 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7641 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007642 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007644#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007646
7647 ssl->transform_out = ssl->transform_negotiate;
7648 ssl->session_out = ssl->session_negotiate;
7649
7650#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7652 mbedtls_ssl_send_flight_completed(ssl);
7653 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007654#endif
7655
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7657 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7658 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007659 }
7660
7661#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007662 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7663 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7664 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7665 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007666 }
7667#endif
7668
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007672}
7673
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007674#define SSL_MAX_HASH_LEN 12
7675
Gilles Peskine449bd832023-01-11 14:50:10 +01007676int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007677{
7678 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7679 unsigned int hash_len = 12;
7680 unsigned char buf[SSL_MAX_HASH_LEN];
7681
Gilles Peskine449bd832023-01-11 14:50:10 +01007682 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007683
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007684 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7685 if (ret != 0) {
7686 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007687 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007688 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007689
Gilles Peskine449bd832023-01-11 14:50:10 +01007690 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7691 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007692 goto exit;
7693 }
7694
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7696 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7697 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7698 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007699 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7700 goto exit;
7701 }
7702
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7704 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7705 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007706 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7707 goto exit;
7708 }
7709
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7711 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7712 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7713 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007714 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7715 goto exit;
7716 }
7717
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7719 buf, hash_len) != 0) {
7720 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7721 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7722 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007723 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7724 goto exit;
7725 }
7726
7727#if defined(MBEDTLS_SSL_RENEGOTIATION)
7728 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007730#endif
7731
Gilles Peskine449bd832023-01-11 14:50:10 +01007732 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007733#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007734 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007735 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007737#endif
7738#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007739 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007740 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007741 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007742#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007744 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007746
7747#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007748 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7749 mbedtls_ssl_recv_flight_completed(ssl);
7750 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007751#endif
7752
Gilles Peskine449bd832023-01-11 14:50:10 +01007753 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007754
7755exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007756 mbedtls_platform_zeroize(buf, hash_len);
7757 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007758}
7759
Jerry Yu392112c2022-02-17 14:34:10 +08007760#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7761/*
7762 * Helper to get TLS 1.2 PRF from ciphersuite
7763 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7764 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007765static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007766{
Jerry Yu392112c2022-02-17 14:34:10 +08007767 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007769#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007770 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7771 return tls_prf_sha384;
7772 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007773#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007774#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007775 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007776 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7777 return tls_prf_sha256;
7778 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007779 }
7780#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007781#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007782 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007783 (void) ciphersuite_info;
7784#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007785
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007787}
7788#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007789
Gilles Peskine449bd832023-01-11 14:50:10 +01007790static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007791{
7792 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007793#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 if (tls_prf == tls_prf_sha384) {
7795 return MBEDTLS_SSL_TLS_PRF_SHA384;
7796 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007797#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007798#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 if (tls_prf == tls_prf_sha256) {
7800 return MBEDTLS_SSL_TLS_PRF_SHA256;
7801 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007802#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007804}
7805
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007806/*
7807 * Populate a transform structure with session keys and all the other
7808 * necessary information.
7809 *
7810 * Parameters:
7811 * - [in/out]: transform: structure to populate
7812 * [in] must be just initialised with mbedtls_ssl_transform_init()
7813 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7814 * - [in] ciphersuite
7815 * - [in] master
7816 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007817 * - [in] tls_prf: pointer to PRF to use for key derivation
7818 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007819 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007820 * - [in] endpoint: client or server
7821 * - [in] ssl: used for:
7822 * - ssl->conf->{f,p}_export_keys
7823 * [in] optionally used for:
7824 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7825 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007826MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007827static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7828 int ciphersuite,
7829 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007830#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007831 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007832#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 ssl_tls_prf_t tls_prf,
7834 const unsigned char randbytes[64],
7835 mbedtls_ssl_protocol_version tls_version,
7836 unsigned endpoint,
7837 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007838{
7839 int ret = 0;
7840 unsigned char keyblk[256];
7841 unsigned char *key1;
7842 unsigned char *key2;
7843 unsigned char *mac_enc;
7844 unsigned char *mac_dec;
7845 size_t mac_key_len = 0;
7846 size_t iv_copy_len;
7847 size_t keylen;
7848 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007849 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007850
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007851 psa_key_type_t key_type;
7852 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7853 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007854 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007855 size_t key_bits;
7856 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007857
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007858 /*
7859 * Some data just needs copying into the structure
7860 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007861#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007862 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007863#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007864 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007865
7866#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007868#endif
7869
7870#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007871 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007872 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7873 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007874 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007875 }
7876#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7877
7878 /*
7879 * Get various info structures
7880 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007881 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7882 if (ciphersuite_info == NULL) {
7883 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7884 ciphersuite));
7885 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007886 }
7887
Neil Armstrongab555e02022-04-04 11:07:59 +02007888 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007889#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007891#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007893
Gilles Peskine449bd832023-01-11 14:50:10 +01007894 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007895 transform->taglen =
7896 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007898
Dave Rodgman2eab4622023-10-05 13:30:37 +01007899 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 transform->taglen,
7901 &alg,
7902 &key_type,
7903 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007904 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007906 goto end;
7907 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007908
Dave Rodgman2eab4622023-10-05 13:30:37 +01007909 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007911 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007912 (unsigned) ciphersuite_info->mac));
7913 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007914 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007915
7916#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7917 /* Copy own and peer's CID if the use of the CID
7918 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007919 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7920 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007921
7922 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7924 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7925 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007926
7927 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007928 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7929 ssl->handshake->peer_cid_len);
7930 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7931 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007932 }
7933#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7934
7935 /*
7936 * Compute key block using the PRF
7937 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7939 if (ret != 0) {
7940 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7941 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007942 }
7943
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7945 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7946 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7947 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7948 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007949
7950 /*
7951 * Determine the appropriate key, IV and MAC length.
7952 */
7953
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007954 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007955
Valerio Settie5707042023-10-11 11:54:42 +02007956#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007957 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007958 size_t explicit_ivlen;
7959
7960 transform->maclen = 0;
7961 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007962
7963 /* All modes haves 96-bit IVs, but the length of the static parts vary
7964 * with mode and version:
7965 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7966 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7967 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7968 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7969 * sequence number).
7970 */
7971 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007972
7973 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007974 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007975
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007977 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007979 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007980 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007981
7982 /* Minimum length of encrypted record */
7983 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7984 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007985 } else
Valerio Settie5707042023-10-11 11:54:42 +02007986#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007987#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007989 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007992
Neil Armstronge4512952022-03-08 09:08:22 +01007993 /* Get MAC length */
7994 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007995 transform->maclen = mac_key_len;
7996
7997 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007999
8000 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008002 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008004 /*
8005 * GenericBlockCipher:
8006 * 1. if EtM is in use: one block plus MAC
8007 * otherwise: * first multiple of blocklen greater than maclen
8008 * 2. IV
8009 */
8010#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008012 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 + block_size;
8014 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008015#endif
8016 {
8017 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 + block_size
8019 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008020 }
8021
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008023 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 } else {
8025 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008026 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8027 goto end;
8028 }
8029 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008031#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8032 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8034 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008035 }
8036
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8038 (unsigned) keylen,
8039 (unsigned) transform->minlen,
8040 (unsigned) transform->ivlen,
8041 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008042
8043 /*
8044 * Finally setup the cipher contexts, IVs and MAC secrets.
8045 */
8046#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008048 key1 = keyblk + mac_key_len * 2;
8049 key2 = keyblk + mac_key_len * 2 + keylen;
8050
8051 mac_enc = keyblk;
8052 mac_dec = keyblk + mac_key_len;
8053
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 iv_copy_len = (transform->fixed_ivlen) ?
8055 transform->fixed_ivlen : transform->ivlen;
8056 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8057 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8058 iv_copy_len);
8059 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008060#endif /* MBEDTLS_SSL_CLI_C */
8061#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008062 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008063 key1 = keyblk + mac_key_len * 2 + keylen;
8064 key2 = keyblk + mac_key_len * 2;
8065
8066 mac_enc = keyblk + mac_key_len;
8067 mac_dec = keyblk;
8068
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 iv_copy_len = (transform->fixed_ivlen) ?
8070 transform->fixed_ivlen : transform->ivlen;
8071 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8072 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8073 iv_copy_len);
8074 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008075#endif /* MBEDTLS_SSL_SRV_C */
8076 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008078 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8079 goto end;
8080 }
8081
Paul Elliott4fb19552023-10-18 12:15:30 +01008082 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 ssl->f_export_keys(ssl->p_export_keys,
8084 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8085 master, 48,
8086 randbytes + 32,
8087 randbytes,
8088 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008089 }
8090
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008091 transform->psa_alg = alg;
8092
Gilles Peskine449bd832023-01-11 14:50:10 +01008093 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8094 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8095 psa_set_key_algorithm(&attributes, alg);
8096 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008097
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 if ((status = psa_import_key(&attributes,
8099 key1,
8100 PSA_BITS_TO_BYTES(key_bits),
8101 &transform->psa_key_enc)) != PSA_SUCCESS) {
8102 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008103 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008104 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008105 goto end;
8106 }
8107
Gilles Peskine449bd832023-01-11 14:50:10 +01008108 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008109
Gilles Peskine449bd832023-01-11 14:50:10 +01008110 if ((status = psa_import_key(&attributes,
8111 key2,
8112 PSA_BITS_TO_BYTES(key_bits),
8113 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008114 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008115 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008116 goto end;
8117 }
8118 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008119
Neil Armstrong29c0c042022-03-17 17:47:28 +01008120#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8121 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8122 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008123 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008124 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008125
Gilles Peskine449bd832023-01-11 14:50:10 +01008126 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8127 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8128 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008129
Gilles Peskine449bd832023-01-11 14:50:10 +01008130 if ((status = psa_import_key(&attributes,
8131 mac_enc, mac_key_len,
8132 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008133 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008134 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008135 goto end;
8136 }
8137
Gilles Peskine449bd832023-01-11 14:50:10 +01008138 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8139 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008140#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008141 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008142#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008143 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008144 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008145 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8146 PSA_KEY_USAGE_VERIFY_HASH);
8147 } else {
8148 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8149 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008150
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 if ((status = psa_import_key(&attributes,
8152 mac_dec, mac_key_len,
8153 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008154 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008155 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008156 goto end;
8157 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008158 }
8159#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8160
8161 ((void) mac_dec);
8162 ((void) mac_enc);
8163
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008164end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008165 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8166 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008167}
8168
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008169#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008170int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008171 psa_pake_operation_t *pake_ctx,
8172 const unsigned char *buf,
8173 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008174{
8175 psa_status_t status;
8176 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008177 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008178 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8179 * At round two perform a single cycle
8180 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008181 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008182
Gilles Peskine449bd832023-01-11 14:50:10 +01008183 for (; remaining_steps > 0; remaining_steps--) {
8184 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008185 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008186 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008187 /* Length is stored at the first byte */
8188 size_t length = buf[input_offset];
8189 input_offset += 1;
8190
Gilles Peskine449bd832023-01-11 14:50:10 +01008191 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008192 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8193 }
8194
Gilles Peskine449bd832023-01-11 14:50:10 +01008195 status = psa_pake_input(pake_ctx, step,
8196 buf + input_offset, length);
8197 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008198 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008199 }
8200
8201 input_offset += length;
8202 }
8203 }
8204
Gilles Peskine449bd832023-01-11 14:50:10 +01008205 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008206 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008208
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008210}
8211
Valerio Setti6b3dab02022-11-17 17:14:54 +01008212int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008213 psa_pake_operation_t *pake_ctx,
8214 unsigned char *buf,
8215 size_t len, size_t *olen,
8216 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008217{
8218 psa_status_t status;
8219 size_t output_offset = 0;
8220 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008221 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008222 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8223 * At round two perform a single cycle
8224 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008225 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008226
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 for (; remaining_steps > 0; remaining_steps--) {
8228 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8229 step <= PSA_PAKE_STEP_ZK_PROOF;
8230 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008231 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008232 * For each step, prepend 1 byte with the length of the data as
8233 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008234 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008235 status = psa_pake_output(pake_ctx, step,
8236 buf + output_offset + 1,
8237 len - output_offset - 1,
8238 &output_len);
8239 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008240 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008241 }
8242
Valerio Setti99d88c12022-11-22 16:03:43 +01008243 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008244
8245 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008246 }
8247 }
8248
8249 *olen = output_offset;
8250
Gilles Peskine449bd832023-01-11 14:50:10 +01008251 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008252}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008253#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008254
Gilles Peskine449bd832023-01-11 14:50:10 +01008255int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8256 unsigned char *hash, size_t *hashlen,
8257 unsigned char *data, size_t data_len,
8258 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008259{
8260 psa_status_t status;
8261 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008262 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008263
Gilles Peskine449bd832023-01-11 14:50:10 +01008264 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008265
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 if ((status = psa_hash_setup(&hash_operation,
8267 hash_alg)) != PSA_SUCCESS) {
8268 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008269 goto exit;
8270 }
8271
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8273 64)) != PSA_SUCCESS) {
8274 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008275 goto exit;
8276 }
8277
Gilles Peskine449bd832023-01-11 14:50:10 +01008278 if ((status = psa_hash_update(&hash_operation,
8279 data, data_len)) != PSA_SUCCESS) {
8280 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008281 goto exit;
8282 }
8283
Gilles Peskine449bd832023-01-11 14:50:10 +01008284 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8285 hashlen)) != PSA_SUCCESS) {
8286 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8287 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008288 }
8289
8290exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008291 if (status != PSA_SUCCESS) {
8292 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8293 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8294 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008295 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008296 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008297 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8298 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008299 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008300 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008301 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008302 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008304 }
8305 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008306 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008307}
8308
Jerry Yuee40f9d2022-02-17 14:55:16 +08008309
Jerry Yud9d91da2022-02-17 14:57:06 +08008310#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8311
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008312/* Find the preferred hash for a given signature algorithm. */
8313unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008314 mbedtls_ssl_context *ssl,
8315 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008316{
Gabor Mezei078e8032022-04-27 21:17:56 +02008317 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008318 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008319
Gilles Peskine449bd832023-01-11 14:50:10 +01008320 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8321 return MBEDTLS_SSL_HASH_NONE;
8322 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008323
Gilles Peskine449bd832023-01-11 14:50:10 +01008324 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008325 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008326 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8327 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008328 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008329 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8330 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008331
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008332 mbedtls_md_type_t md_alg =
8333 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8334 if (md_alg == MBEDTLS_MD_NONE) {
8335 continue;
8336 }
8337
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008339 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008340 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008341 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008342
Gilles Peskine449bd832023-01-11 14:50:10 +01008343 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8344 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8345 PSA_ALG_ECDSA(psa_hash_alg),
8346 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008347 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008348 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008349
Gilles Peskine449bd832023-01-11 14:50:10 +01008350 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8351 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8352 PSA_ALG_RSA_PKCS1V15_SIGN(
8353 psa_hash_alg),
8354 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008355 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008356 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008357 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008358
Gilles Peskine449bd832023-01-11 14:50:10 +01008359 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008360 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008361 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008362
Gilles Peskine449bd832023-01-11 14:50:10 +01008363 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008364}
8365
8366#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8367
Jerry Yudc7bd172022-02-17 13:44:15 +08008368#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8369
XiaokangQian75d40ef2022-04-20 11:05:24 +00008370int mbedtls_ssl_validate_ciphersuite(
8371 const mbedtls_ssl_context *ssl,
8372 const mbedtls_ssl_ciphersuite_t *suite_info,
8373 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008374 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008375{
8376 (void) ssl;
8377
Gilles Peskine449bd832023-01-11 14:50:10 +01008378 if (suite_info == NULL) {
8379 return -1;
8380 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008381
Gilles Peskine449bd832023-01-11 14:50:10 +01008382 if ((suite_info->min_tls_version > max_tls_version) ||
8383 (suite_info->max_tls_version < min_tls_version)) {
8384 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008385 }
8386
XiaokangQian060d8672022-04-21 09:24:56 +00008387#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008388#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008389 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008390 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008391 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008392 }
8393#endif
8394
8395 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8396#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008397 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8398 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8399 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008400 }
8401#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8402#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8403
Gilles Peskine449bd832023-01-11 14:50:10 +01008404 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008405}
8406
Ronald Crone68ab4f2022-10-05 12:46:29 +02008407#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008408/*
8409 * Function for writing a signature algorithm extension.
8410 *
8411 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8412 * value (TLS 1.3 RFC8446):
8413 * enum {
8414 * ....
8415 * ecdsa_secp256r1_sha256( 0x0403 ),
8416 * ecdsa_secp384r1_sha384( 0x0503 ),
8417 * ecdsa_secp521r1_sha512( 0x0603 ),
8418 * ....
8419 * } SignatureScheme;
8420 *
8421 * struct {
8422 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8423 * } SignatureSchemeList;
8424 *
8425 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8426 * value (TLS 1.2 RFC5246):
8427 * enum {
8428 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8429 * sha512(6), (255)
8430 * } HashAlgorithm;
8431 *
8432 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8433 * SignatureAlgorithm;
8434 *
8435 * struct {
8436 * HashAlgorithm hash;
8437 * SignatureAlgorithm signature;
8438 * } SignatureAndHashAlgorithm;
8439 *
8440 * SignatureAndHashAlgorithm
8441 * supported_signature_algorithms<2..2^16-2>;
8442 *
8443 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8444 * generalization of the TLS 1.2 signature algorithm extension.
8445 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8446 * `SignatureScheme` field of TLS 1.3
8447 *
8448 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008449int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8450 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008451{
8452 unsigned char *p = buf;
8453 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8454 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8455
8456 *out_len = 0;
8457
Gilles Peskine449bd832023-01-11 14:50:10 +01008458 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008459
8460 /* Check if we have space for header and length field:
8461 * - extension_type (2 bytes)
8462 * - extension_data_length (2 bytes)
8463 * - supported_signature_algorithms_length (2 bytes)
8464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008466 p += 6;
8467
8468 /*
8469 * Write supported_signature_algorithms
8470 */
8471 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008472 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8473 if (sig_alg == NULL) {
8474 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8475 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008476
Gilles Peskine449bd832023-01-11 14:50:10 +01008477 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8478 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8479 *sig_alg,
8480 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8481 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008482 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 }
8484 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8485 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008486 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008487 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8488 *sig_alg,
8489 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008490 }
8491
8492 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008493 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008494 if (supported_sig_alg_len == 0) {
8495 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8496 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008497 }
8498
Gilles Peskine449bd832023-01-11 14:50:10 +01008499 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8500 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8501 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008502
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008503 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008504
8505#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008506 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008507#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008508
Gilles Peskine449bd832023-01-11 14:50:10 +01008509 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008510}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008511#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008512
XiaokangQian40a35232022-05-07 09:02:40 +00008513#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008514/*
8515 * mbedtls_ssl_parse_server_name_ext
8516 *
8517 * Structure of server_name extension:
8518 *
8519 * enum {
8520 * host_name(0), (255)
8521 * } NameType;
8522 * opaque HostName<1..2^16-1>;
8523 *
8524 * struct {
8525 * NameType name_type;
8526 * select (name_type) {
8527 * case host_name: HostName;
8528 * } name;
8529 * } ServerName;
8530 * struct {
8531 * ServerName server_name_list<1..2^16-1>
8532 * } ServerNameList;
8533 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008534MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008535int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8536 const unsigned char *buf,
8537 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008538{
8539 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8540 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008541 size_t server_name_list_len, hostname_len;
8542 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008543
Gilles Peskine449bd832023-01-11 14:50:10 +01008544 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008545
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8547 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008548 p += 2;
8549
Gilles Peskine449bd832023-01-11 14:50:10 +01008550 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008551 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008552 while (p < server_name_list_end) {
8553 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8554 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8555 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8556 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008557
Gilles Peskine449bd832023-01-11 14:50:10 +01008558 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008559 /* sni_name is intended to be used only during the parsing of the
8560 * ClientHello message (it is reset to NULL before the end of
8561 * the message parsing). Thus it is ok to just point to the
8562 * reception buffer and not make a copy of it.
8563 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008564 ssl->handshake->sni_name = p + 3;
8565 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008566 if (ssl->conf->f_sni == NULL) {
8567 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008568 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008569 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8570 ssl, p + 3, hostname_len);
8571 if (ret != 0) {
8572 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8573 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8574 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8575 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8576 }
8577 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008578 }
8579
8580 p += hostname_len + 3;
8581 }
8582
Gilles Peskine449bd832023-01-11 14:50:10 +01008583 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008584}
8585#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8586
XiaokangQianacb39922022-06-17 10:18:48 +00008587#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008588MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008589int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8590 const unsigned char *buf,
8591 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008592{
8593 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008594 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008595 const unsigned char *protocol_name_list;
8596 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008597 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008598
8599 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008600 if (ssl->conf->alpn_list == NULL) {
8601 return 0;
8602 }
XiaokangQianacb39922022-06-17 10:18:48 +00008603
8604 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008605 * RFC7301, section 3.1
8606 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008607 *
XiaokangQianc7403452022-06-23 03:24:12 +00008608 * struct {
8609 * ProtocolName protocol_name_list<2..2^16-1>
8610 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008611 */
8612
XiaokangQianc7403452022-06-23 03:24:12 +00008613 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008614 * protocol_name_list_len 2 bytes
8615 * protocol_name_len 1 bytes
8616 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008617 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008619
Gilles Peskine449bd832023-01-11 14:50:10 +01008620 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008621 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008623 protocol_name_list = p;
8624 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008625
8626 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008628 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8630 protocol_name_len);
8631 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008632 MBEDTLS_SSL_PEND_FATAL_ALERT(
8633 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008634 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8635 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008636 }
8637
8638 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008639 }
8640
8641 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
8643 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008644 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008645 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008646 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008647 if (protocol_name_len == alpn_len &&
8648 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008649 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008650 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008651 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008652
8653 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008654 }
8655 }
8656
XiaokangQian95d5f542022-06-24 02:29:26 +00008657 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008658 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008659 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8660 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8661 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008662}
8663
Gilles Peskine449bd832023-01-11 14:50:10 +01008664int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8665 unsigned char *buf,
8666 unsigned char *end,
8667 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008668{
8669 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008670 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008671 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008672
Gilles Peskine449bd832023-01-11 14:50:10 +01008673 if (ssl->alpn_chosen == NULL) {
8674 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008675 }
8676
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 protocol_name_len = strlen(ssl->alpn_chosen);
8678 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008679
Gilles Peskine449bd832023-01-11 14:50:10 +01008680 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008681 /*
8682 * 0 . 1 ext identifier
8683 * 2 . 3 ext length
8684 * 4 . 5 protocol list length
8685 * 6 . 6 protocol name length
8686 * 7 . 7+n protocol name
8687 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008689
XiaokangQian95d5f542022-06-24 02:29:26 +00008690 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008691
Gilles Peskine449bd832023-01-11 14:50:10 +01008692 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8693 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008694 /* Note: the length of the chosen protocol has been checked to be less
8695 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8696 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008698
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008700
8701#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008702 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008703#endif
8704
Gilles Peskine449bd832023-01-11 14:50:10 +01008705 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008706}
8707#endif /* MBEDTLS_SSL_ALPN */
8708
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008709#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008710 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008711 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008712 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008713int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8714 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008715{
8716 /* Initialize to suppress unnecessary compiler warning */
8717 size_t hostname_len = 0;
8718
8719 /* Check if new hostname is valid before
8720 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008721 if (hostname != NULL) {
8722 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008723
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8725 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8726 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008727 }
8728
8729 /* Now it's clear that we will overwrite the old hostname,
8730 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008731 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008732 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008733 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008734 }
8735
8736 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008737 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008738 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008739 } else {
8740 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8741 if (session->hostname == NULL) {
8742 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8743 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008744
Gilles Peskine449bd832023-01-11 14:50:10 +01008745 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008746 }
8747
Gilles Peskine449bd832023-01-11 14:50:10 +01008748 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008749}
Xiaokang Qian03409292022-10-12 02:49:52 +00008750#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8751 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008752 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008753 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008754
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008755#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8756 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008757int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8758 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008759{
8760 size_t alpn_len = 0;
8761
8762 if (alpn != NULL) {
8763 alpn_len = strlen(alpn);
8764
8765 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8766 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8767 }
8768 }
8769
8770 if (session->ticket_alpn != NULL) {
8771 mbedtls_zeroize_and_free(session->ticket_alpn,
8772 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008773 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008774 }
8775
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008776 if (alpn != NULL) {
8777 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008778 if (session->ticket_alpn == NULL) {
8779 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8780 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008781 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008782 }
8783
8784 return 0;
8785}
8786#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008787
8788/*
8789 * The following functions are used by 1.2 and 1.3, client and server.
8790 */
8791#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8792int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8793 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8794 int recv_endpoint,
8795 mbedtls_ssl_protocol_version tls_version,
8796 uint32_t *flags)
8797{
8798 int ret = 0;
8799 unsigned int usage = 0;
8800 const char *ext_oid;
8801 size_t ext_len;
8802
8803 /*
8804 * keyUsage
8805 */
8806
8807 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8808 * to check what a compliant client will think while choosing which cert
8809 * to send to the client. */
8810#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8811 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8812 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8813 /* TLS 1.2 server part of the key exchange */
8814 switch (ciphersuite->key_exchange) {
8815 case MBEDTLS_KEY_EXCHANGE_RSA:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008816 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
8817 break;
8818
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008819 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8820 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8821 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8822 break;
8823
8824 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8825 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8826 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8827 break;
8828
8829 /* Don't use default: we want warnings when adding new values */
8830 case MBEDTLS_KEY_EXCHANGE_NONE:
8831 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008832 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8833 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8834 usage = 0;
8835 }
8836 } else
8837#endif
8838 {
8839 /* This is either TLS 1.3 authentication, which always uses signatures,
8840 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8841 * options we implement, both using signatures. */
8842 (void) tls_version;
8843 (void) ciphersuite;
8844 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8845 }
8846
8847 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8848 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8849 ret = -1;
8850 }
8851
8852 /*
8853 * extKeyUsage
8854 */
8855
8856 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8857 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8858 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8859 } else {
8860 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8861 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8862 }
8863
8864 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8865 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8866 ret = -1;
8867 }
8868
8869 return ret;
8870}
8871
Gilles Peskine4ac40082025-02-20 18:13:58 +01008872static int get_hostname_for_verification(mbedtls_ssl_context *ssl,
8873 const char **hostname)
8874{
8875 if (!mbedtls_ssl_has_set_hostname_been_called(ssl)) {
8876 MBEDTLS_SSL_DEBUG_MSG(1, ("Certificate verification without having set hostname"));
Gilles Peskine488b9192025-02-13 14:39:02 +01008877 if (mbedtls_ssl_conf_get_endpoint(ssl->conf) == MBEDTLS_SSL_IS_CLIENT &&
8878 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8879 return MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME;
8880 }
Gilles Peskine4ac40082025-02-20 18:13:58 +01008881 }
8882
8883 *hostname = ssl->hostname;
8884 if (*hostname == NULL) {
8885 MBEDTLS_SSL_DEBUG_MSG(2, ("Certificate verification without CN verification"));
8886 }
8887
8888 return 0;
8889}
8890
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008891int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8892 int authmode,
8893 mbedtls_x509_crt *chain,
8894 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8895 void *rs_ctx)
8896{
8897 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8898 return 0;
8899 }
8900
8901 /*
8902 * Primary check: use the appropriate X.509 verification function
8903 */
8904 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8905 void *p_vrfy;
8906 if (ssl->f_vrfy != NULL) {
8907 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8908 f_vrfy = ssl->f_vrfy;
8909 p_vrfy = ssl->p_vrfy;
8910 } else {
8911 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8912 f_vrfy = ssl->conf->f_vrfy;
8913 p_vrfy = ssl->conf->p_vrfy;
8914 }
8915
Gilles Peskine4ac40082025-02-20 18:13:58 +01008916 const char *hostname = "";
8917 int ret = get_hostname_for_verification(ssl, &hostname);
8918 if (ret != 0) {
8919 MBEDTLS_SSL_DEBUG_RET(1, "get_hostname_for_verification", ret);
8920 return ret;
8921 }
8922
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008923 int have_ca_chain_or_callback = 0;
8924#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8925 if (ssl->conf->f_ca_cb != NULL) {
8926 ((void) rs_ctx);
8927 have_ca_chain_or_callback = 1;
8928
8929 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8930 ret = mbedtls_x509_crt_verify_with_ca_cb(
8931 chain,
8932 ssl->conf->f_ca_cb,
8933 ssl->conf->p_ca_cb,
8934 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008935 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008936 &ssl->session_negotiate->verify_result,
8937 f_vrfy, p_vrfy);
8938 } else
8939#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8940 {
8941 mbedtls_x509_crt *ca_chain;
8942 mbedtls_x509_crl *ca_crl;
8943#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8944 if (ssl->handshake->sni_ca_chain != NULL) {
8945 ca_chain = ssl->handshake->sni_ca_chain;
8946 ca_crl = ssl->handshake->sni_ca_crl;
8947 } else
8948#endif
8949 {
8950 ca_chain = ssl->conf->ca_chain;
8951 ca_crl = ssl->conf->ca_crl;
8952 }
8953
8954 if (ca_chain != NULL) {
8955 have_ca_chain_or_callback = 1;
8956 }
8957
8958 ret = mbedtls_x509_crt_verify_restartable(
8959 chain,
8960 ca_chain, ca_crl,
8961 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008962 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008963 &ssl->session_negotiate->verify_result,
8964 f_vrfy, p_vrfy, rs_ctx);
8965 }
8966
8967 if (ret != 0) {
8968 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8969 }
8970
8971#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8972 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8973 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8974 }
8975#endif
8976
8977 /*
8978 * Secondary checks: always done, but change 'ret' only if it was 0
8979 */
8980
8981 /* With TLS 1.2 and ECC certs, check that the curve used by the
8982 * certificate is on our list of acceptable curves.
8983 *
8984 * With TLS 1.3 this is not needed because the curve is part of the
8985 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8986 * we validate the signature made with the key associated to this cert.
8987 */
8988#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8989 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8990 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8991 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8992 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8993 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8994 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8995 if (ret == 0) {
8996 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8997 }
8998 }
8999 }
9000#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
9001
9002 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
9003 if (mbedtls_ssl_check_cert_usage(chain,
9004 ciphersuite_info,
9005 ssl->conf->endpoint,
9006 ssl->tls_version,
9007 &ssl->session_negotiate->verify_result) != 0) {
9008 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
9009 if (ret == 0) {
9010 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
9011 }
9012 }
9013
9014 /* With authmode optional, we want to keep going if the certificate was
9015 * unacceptable, but still fail on other errors (out of memory etc),
9016 * including fatal errors from the f_vrfy callback.
9017 *
9018 * The only acceptable errors are:
9019 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
9020 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
9021 * Anything else is a fatal error. */
9022 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
9023 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
9024 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
9025 ret = 0;
9026 }
9027
9028 /* Return a specific error as this is a user error: inconsistent
9029 * configuration - can't verify without trust anchors. */
9030 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
9031 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
9032 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
9033 }
9034
9035 if (ret != 0) {
9036 uint8_t alert;
9037
9038 /* The certificate may have been rejected for several reasons.
9039 Pick one and send the corresponding alert. Which alert to send
9040 may be a subject of debate in some cases. */
9041 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
9042 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
9043 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
9044 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
9045 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
9046 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9047 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
9048 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9049 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
9050 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9051 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
9052 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9053 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
9054 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
9055 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
9056 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
9057 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
9058 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
9059 } else {
9060 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
9061 }
9062 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9063 alert);
9064 }
9065
9066#if defined(MBEDTLS_DEBUG_C)
9067 if (ssl->session_negotiate->verify_result != 0) {
9068 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
9069 (unsigned int) ssl->session_negotiate->verify_result));
9070 } else {
9071 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
9072 }
9073#endif /* MBEDTLS_DEBUG_C */
9074
9075 return ret;
9076}
9077#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
9078
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009079#endif /* MBEDTLS_SSL_TLS_C */