blob: 60f2e1cd6d0491b79def68daa9cccf4b517ede16 [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;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001414 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001415
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001417
1418 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001419#if defined(MBEDTLS_SSL_RENEGOTIATION)
1420 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001421 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001422
1423 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1425 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001426#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001427 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001428
Hanno Beckerb0302c42021-08-03 09:39:42 +01001429 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001430 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 if (ssl->session) {
1432 mbedtls_ssl_session_free(ssl->session);
1433 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001434 ssl->session = NULL;
1435 }
1436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001437#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001438 ssl->alpn_chosen = NULL;
1439#endif
1440
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001441#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001442 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001443#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001445#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 if (free_cli_id) {
1447 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001448 ssl->cli_id = NULL;
1449 ssl->cli_id_len = 0;
1450 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001451#endif
1452
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 if ((ret = ssl_handshake_init(ssl)) != 0) {
1454 return ret;
1455 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001458}
1459
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001460/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001461 * Reset an initialized and used SSL context for re-use while retaining
1462 * all application-set variables, function pointers and data.
1463 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001464int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001465{
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001467}
1468
1469/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001470 * SSL set accessors
1471 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001472void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001473{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001474 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001475}
1476
Gilles Peskine449bd832023-01-11 14:50:10 +01001477void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001478{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001479 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001480}
1481
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001483void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001484{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001485 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001486}
1487#endif
1488
Gilles Peskine449bd832023-01-11 14:50:10 +01001489void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001490{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001491 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001492}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001493
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001494#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001495
Gilles Peskine449bd832023-01-11 14:50:10 +01001496void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1497 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001498{
1499 ssl->disable_datagram_packing = !allow_packing;
1500}
1501
Gilles Peskine449bd832023-01-11 14:50:10 +01001502void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1503 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001504{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001505 conf->hs_timeout_min = min;
1506 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001507}
1508#endif
1509
Gilles Peskine449bd832023-01-11 14:50:10 +01001510void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001511{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001512 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001513}
1514
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001515#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001516void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1517 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1518 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001519{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001520 conf->f_vrfy = f_vrfy;
1521 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001522}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001523#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001524
Gilles Peskine449bd832023-01-11 14:50:10 +01001525void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1526 int (*f_rng)(void *, unsigned char *, size_t),
1527 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001528{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001529 conf->f_rng = f_rng;
1530 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001531}
1532
Gilles Peskine449bd832023-01-11 14:50:10 +01001533void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1534 void (*f_dbg)(void *, int, const char *, int, const char *),
1535 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001536{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001537 conf->f_dbg = f_dbg;
1538 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001539}
1540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1542 void *p_bio,
1543 mbedtls_ssl_send_t *f_send,
1544 mbedtls_ssl_recv_t *f_recv,
1545 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001546{
1547 ssl->p_bio = p_bio;
1548 ssl->f_send = f_send;
1549 ssl->f_recv = f_recv;
1550 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001551}
1552
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001553#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001554void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001555{
1556 ssl->mtu = mtu;
1557}
1558#endif
1559
Gilles Peskine449bd832023-01-11 14:50:10 +01001560void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001561{
1562 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001563}
1564
Gilles Peskine449bd832023-01-11 14:50:10 +01001565void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1566 void *p_timer,
1567 mbedtls_ssl_set_timer_t *f_set_timer,
1568 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001569{
1570 ssl->p_timer = p_timer;
1571 ssl->f_set_timer = f_set_timer;
1572 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001573
1574 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001575 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001576}
1577
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001578#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001579void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1580 void *p_cache,
1581 mbedtls_ssl_cache_get_t *f_get_cache,
1582 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001583{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001584 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001585 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001586 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001587}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001588#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001589
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001590#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001591int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001592{
Janos Follath865b3eb2019-12-16 11:46:15 +00001593 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001594
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001596 session == NULL ||
1597 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001598 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1599 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001600 }
1601
Gilles Peskine449bd832023-01-11 14:50:10 +01001602 if (ssl->handshake->resume == 1) {
1603 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1604 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001605
Jerry Yu21092062022-10-10 21:21:31 +08001606#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001608#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001609 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001610 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001611
Gilles Peskine449bd832023-01-11 14:50:10 +01001612 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001613 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1615 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1616 session->ciphersuite));
1617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001618 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001619#else
1620 /*
1621 * If session tickets are not enabled, it is not possible to resume a
1622 * TLS 1.3 session, thus do not make any change to the SSL context in
1623 * the first place.
1624 */
1625 return 0;
1626#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001627 }
Jerry Yu21092062022-10-10 21:21:31 +08001628#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001629
Gilles Peskine449bd832023-01-11 14:50:10 +01001630 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1631 session)) != 0) {
1632 return ret;
1633 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001634
Paul Bakker0a597072012-09-25 21:55:46 +00001635 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001636
Gilles Peskine449bd832023-01-11 14:50:10 +01001637 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001638}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001639#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1642 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001643{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001644 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001645}
1646
Ronald Cron6f135e12021-12-08 16:57:54 +01001647#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001648void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1649 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001650{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001651 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001652}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001653
1654#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001655void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1656 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001657{
1658 conf->early_data_enabled = early_data_enabled;
1659}
Jerry Yucc4e0072022-11-22 17:22:22 +08001660
1661#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001662void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001663 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001664{
Jerry Yu39da9852022-12-06 16:58:36 +08001665 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001666}
1667#endif /* MBEDTLS_SSL_SRV_C */
1668
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001669#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001670#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001671
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001672#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001673void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1674 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001675{
1676 conf->cert_profile = profile;
1677}
1678
Gilles Peskine449bd832023-01-11 14:50:10 +01001679static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001680{
1681 mbedtls_ssl_key_cert *cur = key_cert, *next;
1682
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001684 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001685 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001686 cur = next;
1687 }
1688}
1689
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001690/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001691MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001692static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1693 mbedtls_x509_crt *cert,
1694 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001695{
niisato8ee24222018-06-25 19:05:48 +09001696 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001699 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001700 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001701 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001703 }
1704
Gilles Peskine449bd832023-01-11 14:50:10 +01001705 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1706 if (new_cert == NULL) {
1707 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1708 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001709
niisato8ee24222018-06-25 19:05:48 +09001710 new_cert->cert = cert;
1711 new_cert->key = key;
1712 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001713
Glenn Strauss36872db2022-01-22 05:06:31 -05001714 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001716 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001717 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001718 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001720 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001721 }
niisato8ee24222018-06-25 19:05:48 +09001722 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001723 }
1724
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001726}
1727
Gilles Peskine449bd832023-01-11 14:50:10 +01001728int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001729 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001731{
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001733}
1734
Gilles Peskine449bd832023-01-11 14:50:10 +01001735void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001736 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001738{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001739 conf->ca_chain = ca_chain;
1740 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001741
1742#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1743 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1744 * cannot be used together. */
1745 conf->f_ca_cb = NULL;
1746 conf->p_ca_cb = NULL;
1747#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001748}
Hanno Becker5adaad92019-03-27 16:54:37 +00001749
1750#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001751void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1752 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1753 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001754{
1755 conf->f_ca_cb = f_ca_cb;
1756 conf->p_ca_cb = p_ca_cb;
1757
1758 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1759 * cannot be used together. */
1760 conf->ca_chain = NULL;
1761 conf->ca_crl = NULL;
1762}
1763#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001764#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001765
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001766#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001767const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1768 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001769{
1770 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001772}
1773
Gilles Peskine449bd832023-01-11 14:50:10 +01001774int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1775 mbedtls_x509_crt *own_cert,
1776 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001777{
Gilles Peskine449bd832023-01-11 14:50:10 +01001778 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1779 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001780}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001781
Gilles Peskine449bd832023-01-11 14:50:10 +01001782void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1783 mbedtls_x509_crt *ca_chain,
1784 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001785{
1786 ssl->handshake->sni_ca_chain = ca_chain;
1787 ssl->handshake->sni_ca_crl = ca_crl;
1788}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001789
Glenn Strauss999ef702022-03-11 01:37:23 -05001790#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001791void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1792 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001793{
1794 ssl->handshake->dn_hints = crt;
1795}
1796#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1797
Gilles Peskine449bd832023-01-11 14:50:10 +01001798void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1799 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001800{
1801 ssl->handshake->sni_authmode = authmode;
1802}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001803#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1804
Hanno Becker8927c832019-04-03 12:52:50 +01001805#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001806void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1807 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1808 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001809{
1810 ssl->f_vrfy = f_vrfy;
1811 ssl->p_vrfy = p_vrfy;
1812}
1813#endif
1814
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001815#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001816
Przemek Stekielfde11282023-03-13 16:06:09 +01001817static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1818static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1819
Valerio Setti016f6822022-12-09 14:17:50 +01001820static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 mbedtls_ssl_context *ssl,
1822 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001823{
1824 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001825 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001826 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001827 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001828 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001829 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1831 psa_pake_cs_set_primitive(&cipher_suite,
1832 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1833 PSA_ECC_FAMILY_SECP_R1,
1834 256));
1835 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001836
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1838 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001839 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001841
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001843 user = jpake_server_id;
1844 user_len = sizeof(jpake_server_id);
1845 peer = jpake_client_id;
1846 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001848 user = jpake_client_id;
1849 user_len = sizeof(jpake_client_id);
1850 peer = jpake_server_id;
1851 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001853
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001854 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1855 if (status != PSA_SUCCESS) {
1856 return status;
1857 }
1858
1859 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001861 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 }
Valerio Setti016f6822022-12-09 14:17:50 +01001863
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1865 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001866 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 }
Valerio Setti016f6822022-12-09 14:17:50 +01001868
1869 ssl->handshake->psa_pake_ctx_is_ok = 1;
1870
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001872}
1873
Gilles Peskine449bd832023-01-11 14:50:10 +01001874int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1875 const unsigned char *pw,
1876 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001877{
1878 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1879 psa_status_t status;
1880
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 if (ssl->handshake == NULL || ssl->conf == NULL) {
1882 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001883 }
1884
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 /* Empty password is not valid */
1886 if ((pw == NULL) || (pw_len == 0)) {
1887 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1888 }
1889
1890 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1891 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1892 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1893
1894 status = psa_import_key(&attributes, pw, pw_len,
1895 &ssl->handshake->psa_pake_password);
1896 if (status != PSA_SUCCESS) {
1897 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1898 }
1899
1900 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1901 ssl->handshake->psa_pake_password);
1902 if (status != PSA_SUCCESS) {
1903 psa_destroy_key(ssl->handshake->psa_pake_password);
1904 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1905 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1906 }
1907
1908 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001909}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001910
Gilles Peskine449bd832023-01-11 14:50:10 +01001911int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1912 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001913{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001914 psa_status_t status;
1915
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 if (ssl->handshake == NULL || ssl->conf == NULL) {
1917 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001918 }
1919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 if (mbedtls_svc_key_id_is_null(pwd)) {
1921 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1922 }
1923
1924 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1925 if (status != PSA_SUCCESS) {
1926 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1927 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1928 }
1929
1930 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001931}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001932#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001933
Ronald Cron73fe8df2022-10-05 14:31:43 +02001934#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001935int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001936{
Gilles Peskine449bd832023-01-11 14:50:10 +01001937 if (conf->psk_identity == NULL ||
1938 conf->psk_identity_len == 0) {
1939 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001940 }
1941
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1943 return 1;
1944 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001945
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 if (conf->psk != NULL && conf->psk_len != 0) {
1947 return 1;
1948 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001949
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001951}
1952
Gilles Peskine449bd832023-01-11 14:50:10 +01001953static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001954{
1955 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001957 /* The maintenance of the PSK key slot is the
1958 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001959 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001960 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001962 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001963 conf->psk = NULL;
1964 conf->psk_len = 0;
1965 }
1966
1967 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 if (conf->psk_identity != NULL) {
1969 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001970 conf->psk_identity = NULL;
1971 conf->psk_identity_len = 0;
1972 }
1973}
1974
Hanno Becker7390c712018-11-15 13:33:04 +00001975/* This function assumes that PSK identity in the SSL config is unset.
1976 * It checks that the provided identity is well-formed and attempts
1977 * to make a copy of it in the SSL config.
1978 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001979MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001980static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1981 unsigned char const *psk_identity,
1982 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001983{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001984 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001986 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 (psk_identity_len >> 16) != 0 ||
1988 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1989 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001990 }
1991
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1993 if (conf->psk_identity == NULL) {
1994 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1995 }
Paul Bakker6db455e2013-09-18 17:29:31 +02001996
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001997 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02001999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002001}
2002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2004 const unsigned char *psk, size_t psk_len,
2005 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002006{
Janos Follath865b3eb2019-12-16 11:46:15 +00002007 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002008
2009 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2011 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2012 }
Hanno Becker7390c712018-11-15 13:33:04 +00002013
2014 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 if (psk == NULL) {
2016 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2017 }
2018 if (psk_len == 0) {
2019 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2020 }
2021 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2022 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2023 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002024
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2026 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2027 }
Hanno Becker7390c712018-11-15 13:33:04 +00002028 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002030
2031 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002032 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2033 if (ret != 0) {
2034 ssl_conf_remove_psk(conf);
2035 }
Hanno Becker7390c712018-11-15 13:33:04 +00002036
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002038}
2039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002041{
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002043 /* The maintenance of the external PSK key slot is the
2044 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 if (ssl->handshake->psk_opaque_is_internal) {
2046 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002047 ssl->handshake->psk_opaque_is_internal = 0;
2048 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002049 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002050 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002051}
2052
Gilles Peskine449bd832023-01-11 14:50:10 +01002053int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2054 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002055{
Neil Armstrong501c9322022-05-03 09:35:09 +02002056 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002057 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002058 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002059 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002060
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 if (psk == NULL || ssl->handshake == NULL) {
2062 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2063 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002064
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2067 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002068
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002070
Jerry Yuccc68a42022-07-26 16:39:20 +08002071#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2073 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2074 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2075 } else {
2076 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2077 }
2078 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002079 }
2080#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002081
Jerry Yu568ec252022-07-22 21:27:34 +08002082#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2084 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2085 psa_set_key_usage_flags(&key_attributes,
2086 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002087 }
2088#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2089
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 psa_set_key_algorithm(&key_attributes, alg);
2091 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002092
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2094 if (status != PSA_SUCCESS) {
2095 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2096 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002097
2098 /* Allow calling psa_destroy_key() on psk remove */
2099 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002101}
2102
Gilles Peskine449bd832023-01-11 14:50:10 +01002103int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2104 mbedtls_svc_key_id_t psk,
2105 const unsigned char *psk_identity,
2106 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002107{
Janos Follath865b3eb2019-12-16 11:46:15 +00002108 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002109
2110 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2112 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2113 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002114
Hanno Becker7390c712018-11-15 13:33:04 +00002115 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 if (mbedtls_svc_key_id_is_null(psk)) {
2117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2118 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002119 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002120
2121 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2123 psk_identity_len);
2124 if (ret != 0) {
2125 ssl_conf_remove_psk(conf);
2126 }
Hanno Becker7390c712018-11-15 13:33:04 +00002127
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002129}
2130
Gilles Peskine449bd832023-01-11 14:50:10 +01002131int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2132 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002133{
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 if ((mbedtls_svc_key_id_is_null(psk)) ||
2135 (ssl->handshake == NULL)) {
2136 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2137 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002138
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002140 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002142}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002143
Jerry Yu8897c072022-08-12 13:56:53 +08002144#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002145void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2146 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2147 size_t),
2148 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002149{
2150 conf->f_psk = f_psk;
2151 conf->p_psk = p_psk;
2152}
Jerry Yu8897c072022-08-12 13:56:53 +08002153#endif /* MBEDTLS_SSL_SRV_C */
2154
Ronald Cron73fe8df2022-10-05 14:31:43 +02002155#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002156
Gilles Peskine301711e2022-04-26 16:57:05 +02002157static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002159{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002160#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 if (alg == PSA_ALG_CBC_NO_PADDING) {
2162 return MBEDTLS_SSL_MODE_CBC;
2163 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002164#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 if (PSA_ALG_IS_AEAD(alg)) {
2166 return MBEDTLS_SSL_MODE_AEAD;
2167 }
2168 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002169}
2170
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002171
Gilles Peskinee108d982022-04-26 16:50:40 +02002172static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2173 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002175{
2176#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2178 base_mode == MBEDTLS_SSL_MODE_CBC) {
2179 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002180 }
2181#else
2182 (void) encrypt_then_mac;
2183#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002185}
2186
Neil Armstrongab555e02022-04-04 11:07:59 +02002187mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002189{
Gilles Peskinee108d982022-04-26 16:50:40 +02002190 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002192 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002193
Gilles Peskinee108d982022-04-26 16:50:40 +02002194 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002195#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002196 encrypt_then_mac = transform->encrypt_then_mac;
2197#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002199}
2200
Neil Armstrongab555e02022-04-04 11:07:59 +02002201mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002202#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002204#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002206{
Gilles Peskinee108d982022-04-26 16:50:40 +02002207 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2208
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002209 psa_status_t status;
2210 psa_algorithm_t alg;
2211 psa_key_type_t type;
2212 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002213 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2214 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 if (status == PSA_SUCCESS) {
2216 base_mode = mbedtls_ssl_get_base_mode(alg);
2217 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002218
Gilles Peskinee108d982022-04-26 16:50:40 +02002219#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2220 int encrypt_then_mac = 0;
2221#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002223}
2224
Jerry Yu251a12e2022-07-13 15:15:48 +08002225
Ronald Cron8b592d22024-11-12 18:08:25 +01002226const mbedtls_error_pair_t psa_to_ssl_errors[] =
2227{
2228 { PSA_SUCCESS, 0 },
2229 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2230 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2231 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2232 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2233 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2234 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2235};
2236
Gilles Peskine449bd832023-01-11 14:50:10 +01002237psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2238 size_t taglen,
2239 psa_algorithm_t *alg,
2240 psa_key_type_t *key_type,
2241 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002242{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002243#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002244 (void) taglen;
2245#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002247#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002248 case MBEDTLS_CIPHER_AES_128_CBC:
2249 *alg = PSA_ALG_CBC_NO_PADDING;
2250 *key_type = PSA_KEY_TYPE_AES;
2251 *key_size = 128;
2252 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002253#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002254#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002255 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002257 *key_type = PSA_KEY_TYPE_AES;
2258 *key_size = 128;
2259 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002260#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002261#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002262 case MBEDTLS_CIPHER_AES_128_GCM:
2263 *alg = PSA_ALG_GCM;
2264 *key_type = PSA_KEY_TYPE_AES;
2265 *key_size = 128;
2266 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002267#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002268#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002269 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002271 *key_type = PSA_KEY_TYPE_AES;
2272 *key_size = 192;
2273 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002274#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002275#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002276 case MBEDTLS_CIPHER_AES_192_GCM:
2277 *alg = PSA_ALG_GCM;
2278 *key_type = PSA_KEY_TYPE_AES;
2279 *key_size = 192;
2280 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002281#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002282#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002283 case MBEDTLS_CIPHER_AES_256_CBC:
2284 *alg = PSA_ALG_CBC_NO_PADDING;
2285 *key_type = PSA_KEY_TYPE_AES;
2286 *key_size = 256;
2287 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002288#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002289#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002290 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002292 *key_type = PSA_KEY_TYPE_AES;
2293 *key_size = 256;
2294 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002295#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002296#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002297 case MBEDTLS_CIPHER_AES_256_GCM:
2298 *alg = PSA_ALG_GCM;
2299 *key_type = PSA_KEY_TYPE_AES;
2300 *key_size = 256;
2301 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002302#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002303#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002304 case MBEDTLS_CIPHER_ARIA_128_CBC:
2305 *alg = PSA_ALG_CBC_NO_PADDING;
2306 *key_type = PSA_KEY_TYPE_ARIA;
2307 *key_size = 128;
2308 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002309#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002310#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002311 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002313 *key_type = PSA_KEY_TYPE_ARIA;
2314 *key_size = 128;
2315 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002316#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002317#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002318 case MBEDTLS_CIPHER_ARIA_128_GCM:
2319 *alg = PSA_ALG_GCM;
2320 *key_type = PSA_KEY_TYPE_ARIA;
2321 *key_size = 128;
2322 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002323#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002324#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002325 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002327 *key_type = PSA_KEY_TYPE_ARIA;
2328 *key_size = 192;
2329 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002330#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002331#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002332 case MBEDTLS_CIPHER_ARIA_192_GCM:
2333 *alg = PSA_ALG_GCM;
2334 *key_type = PSA_KEY_TYPE_ARIA;
2335 *key_size = 192;
2336 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002337#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002338#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002339 case MBEDTLS_CIPHER_ARIA_256_CBC:
2340 *alg = PSA_ALG_CBC_NO_PADDING;
2341 *key_type = PSA_KEY_TYPE_ARIA;
2342 *key_size = 256;
2343 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002344#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002345#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002346 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002348 *key_type = PSA_KEY_TYPE_ARIA;
2349 *key_size = 256;
2350 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002351#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002352#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002353 case MBEDTLS_CIPHER_ARIA_256_GCM:
2354 *alg = PSA_ALG_GCM;
2355 *key_type = PSA_KEY_TYPE_ARIA;
2356 *key_size = 256;
2357 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002358#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002359#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002360 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2361 *alg = PSA_ALG_CBC_NO_PADDING;
2362 *key_type = PSA_KEY_TYPE_CAMELLIA;
2363 *key_size = 128;
2364 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002365#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002366#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002367 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002369 *key_type = PSA_KEY_TYPE_CAMELLIA;
2370 *key_size = 128;
2371 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002372#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002373#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002374 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2375 *alg = PSA_ALG_GCM;
2376 *key_type = PSA_KEY_TYPE_CAMELLIA;
2377 *key_size = 128;
2378 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002379#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002380#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002381 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002383 *key_type = PSA_KEY_TYPE_CAMELLIA;
2384 *key_size = 192;
2385 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002386#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002387#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002388 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2389 *alg = PSA_ALG_GCM;
2390 *key_type = PSA_KEY_TYPE_CAMELLIA;
2391 *key_size = 192;
2392 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002393#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002394#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002395 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2396 *alg = PSA_ALG_CBC_NO_PADDING;
2397 *key_type = PSA_KEY_TYPE_CAMELLIA;
2398 *key_size = 256;
2399 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002400#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002401#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002402 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002404 *key_type = PSA_KEY_TYPE_CAMELLIA;
2405 *key_size = 256;
2406 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002407#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002408#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002409 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2410 *alg = PSA_ALG_GCM;
2411 *key_type = PSA_KEY_TYPE_CAMELLIA;
2412 *key_size = 256;
2413 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002414#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002415#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002416 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2417 *alg = PSA_ALG_CHACHA20_POLY1305;
2418 *key_type = PSA_KEY_TYPE_CHACHA20;
2419 *key_size = 256;
2420 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002421#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002422 case MBEDTLS_CIPHER_NULL:
2423 *alg = MBEDTLS_SSL_NULL_CIPHER;
2424 *key_type = 0;
2425 *key_size = 0;
2426 break;
2427 default:
2428 return PSA_ERROR_NOT_SUPPORTED;
2429 }
2430
2431 return PSA_SUCCESS;
2432}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002433
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002434#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002435int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2436 const unsigned char *dhm_P, size_t P_len,
2437 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002438{
Janos Follath865b3eb2019-12-16 11:46:15 +00002439 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002440
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 mbedtls_mpi_free(&conf->dhm_P);
2442 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002443
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2445 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2446 mbedtls_mpi_free(&conf->dhm_P);
2447 mbedtls_mpi_free(&conf->dhm_G);
2448 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002449 }
2450
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002452}
Paul Bakker5121ce52009-01-03 21:22:43 +00002453
Gilles Peskine449bd832023-01-11 14:50:10 +01002454int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002455{
Janos Follath865b3eb2019-12-16 11:46:15 +00002456 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 mbedtls_mpi_free(&conf->dhm_P);
2459 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002460
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2462 &conf->dhm_P)) != 0 ||
2463 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2464 &conf->dhm_G)) != 0) {
2465 mbedtls_mpi_free(&conf->dhm_P);
2466 mbedtls_mpi_free(&conf->dhm_G);
2467 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002468 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002469
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002471}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002472#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002473
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002474#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2475/*
2476 * Set the minimum length for Diffie-Hellman parameters
2477 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002478void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2479 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002480{
2481 conf->dhm_min_bitlen = bitlen;
2482}
2483#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2484
Ronald Crone68ab4f2022-10-05 12:46:29 +02002485#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002486#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002487/*
2488 * Set allowed/preferred hashes for handshake signatures
2489 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002490void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2491 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002492{
2493 conf->sig_hashes = hashes;
2494}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002495#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002496
Jerry Yuf017ee42022-01-12 15:49:48 +08002497/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002498void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2499 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002500{
Jerry Yuf017ee42022-01-12 15:49:48 +08002501#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2502 conf->sig_hashes = NULL;
2503#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2504 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002505}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002506#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002507
Brett Warrene0edc842021-08-17 09:53:13 +01002508/*
2509 * Set the allowed groups
2510 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002511void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2512 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002513{
Brett Warrene0edc842021-08-17 09:53:13 +01002514 conf->group_list = group_list;
2515}
2516
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002517#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002518int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002519{
Hanno Becker947194e2017-04-07 13:25:49 +01002520 /* Initialize to suppress unnecessary compiler warning */
2521 size_t hostname_len = 0;
2522
2523 /* Check if new hostname is valid before
2524 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 if (hostname != NULL) {
2526 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002527
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2529 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2530 }
Hanno Becker947194e2017-04-07 13:25:49 +01002531 }
2532
2533 /* Now it's clear that we will overwrite the old hostname,
2534 * so we can free it safely */
2535
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002537 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002538 }
2539
2540 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002541
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002543 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 } else {
2545 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2546 if (ssl->hostname == NULL) {
2547 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2548 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002549
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002551
Hanno Becker947194e2017-04-07 13:25:49 +01002552 ssl->hostname[hostname_len] = '\0';
2553 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002554
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002556}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002557#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002558
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002559#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002560void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2561 int (*f_sni)(void *, mbedtls_ssl_context *,
2562 const unsigned char *, size_t),
2563 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002564{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002565 conf->f_sni = f_sni;
2566 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002567}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002571int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002572{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002573 size_t cur_len, tot_len;
2574 const char **p;
2575
2576 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002577 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2578 * MUST NOT be truncated."
2579 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002580 */
2581 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 for (p = protos; *p != NULL; p++) {
2583 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002584 tot_len += cur_len;
2585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 if ((cur_len == 0) ||
2587 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2588 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2589 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2590 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002591 }
2592
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002593 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002594
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002596}
2597
Gilles Peskine449bd832023-01-11 14:50:10 +01002598const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002599{
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002601}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002603
Johan Pascalb62bb512015-12-03 21:56:45 +01002604#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002605void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2606 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002607{
2608 conf->dtls_srtp_mki_support = support_mki_value;
2609}
2610
Gilles Peskine449bd832023-01-11 14:50:10 +01002611int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2612 unsigned char *mki_value,
2613 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002614{
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2616 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002617 }
Ron Eldor591f1622018-01-22 12:30:04 +02002618
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2620 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002621 }
Ron Eldor591f1622018-01-22 12:30:04 +02002622
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002624 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002626}
2627
Gilles Peskine449bd832023-01-11 14:50:10 +01002628int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2629 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002630{
Johan Pascal253d0262020-09-22 13:04:45 +02002631 const mbedtls_ssl_srtp_profile *p;
2632 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002633
Johan Pascal253d0262020-09-22 13:04:45 +02002634 /* check the profiles list: all entry must be valid,
2635 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2637 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2638 p++) {
2639 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002640 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002642 /* unsupported value, stop parsing and set the size to an error value */
2643 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002644 }
2645 }
2646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2648 conf->dtls_srtp_profile_list = NULL;
2649 conf->dtls_srtp_profile_list_len = 0;
2650 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002651 }
2652
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002653 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002654 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002655
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002657}
2658
Gilles Peskine449bd832023-01-11 14:50:10 +01002659void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2660 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002661{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002662 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2663 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002665 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002667 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2669 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002670 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002671}
Johan Pascalb62bb512015-12-03 21:56:45 +01002672#endif /* MBEDTLS_SSL_DTLS_SRTP */
2673
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302674#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002675void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002676{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002677 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002678}
2679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002681{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002682 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002683}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302684#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002685
Janos Follath088ce432017-04-10 12:42:31 +01002686#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002687void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2688 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002689{
2690 conf->cert_req_ca_list = cert_req_ca_list;
2691}
2692#endif
2693
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002694#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002695void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002696{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002697 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002698}
2699#endif
2700
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002701#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002702void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002703{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002704 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002705}
2706#endif
2707
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002708#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002709int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002710{
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2712 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002714 }
2715
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002716 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002717
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002719}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002720#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002721
Gilles Peskine449bd832023-01-11 14:50:10 +01002722void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002723{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002724 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002725}
2726
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002728void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002729{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002730 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002731}
2732
Gilles Peskine449bd832023-01-11 14:50:10 +01002733void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002734{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002735 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002736}
2737
Gilles Peskine449bd832023-01-11 14:50:10 +01002738void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2739 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002740{
Gilles Peskine449bd832023-01-11 14:50:10 +01002741 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002742}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002744
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002745#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002746#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002747void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002748{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002749 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002750}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002751#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002752
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002753#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002754
Jerry Yud0766ec2022-09-22 10:46:57 +08002755#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002756void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2757 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002758{
Jerry Yud0766ec2022-09-22 10:46:57 +08002759 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002760}
2761#endif
2762
Gilles Peskine449bd832023-01-11 14:50:10 +01002763void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2764 mbedtls_ssl_ticket_write_t *f_ticket_write,
2765 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2766 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002767{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002768 conf->f_ticket_write = f_ticket_write;
2769 conf->f_ticket_parse = f_ticket_parse;
2770 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002771}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002772#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2776 mbedtls_ssl_export_keys_t *f_export_keys,
2777 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002778{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002779 ssl->f_export_keys = f_export_keys;
2780 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002781}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002782
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002783#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002784void mbedtls_ssl_conf_async_private_cb(
2785 mbedtls_ssl_config *conf,
2786 mbedtls_ssl_async_sign_t *f_async_sign,
2787 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2788 mbedtls_ssl_async_resume_t *f_async_resume,
2789 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002791{
2792 conf->f_async_sign_start = f_async_sign;
2793 conf->f_async_decrypt_start = f_async_decrypt;
2794 conf->f_async_resume = f_async_resume;
2795 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002796 conf->p_async_config_data = async_config_data;
2797}
2798
Gilles Peskine449bd832023-01-11 14:50:10 +01002799void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002800{
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002802}
2803
Gilles Peskine449bd832023-01-11 14:50:10 +01002804void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002805{
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 if (ssl->handshake == NULL) {
2807 return NULL;
2808 } else {
2809 return ssl->handshake->user_async_ctx;
2810 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002811}
2812
Gilles Peskine449bd832023-01-11 14:50:10 +01002813void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2814 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002815{
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002817 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002819}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002820#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002821
Paul Bakker5121ce52009-01-03 21:22:43 +00002822/*
2823 * SSL get accessors
2824 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002825uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002826{
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 if (ssl->session != NULL) {
2828 return ssl->session->verify_result;
2829 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002830
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 if (ssl->session_negotiate != NULL) {
2832 return ssl->session_negotiate->verify_result;
2833 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002834
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002836}
2837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002839{
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 if (ssl == NULL || ssl->session == NULL) {
2841 return 0;
2842 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002843
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002845}
2846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002848{
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 if (ssl == NULL || ssl->session == NULL) {
2850 return NULL;
2851 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002852
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002854}
2855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002857{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2860 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002861 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002863 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002865 }
2866 }
2867#endif
2868
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002870 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002872 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002874 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002876 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002877}
2878
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002879#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2880
2881size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2882{
2883 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2884 size_t record_size_limit = max_len;
2885
2886 if (ssl->session != NULL &&
2887 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2888 ssl->session->record_size_limit < max_len) {
2889 record_size_limit = ssl->session->record_size_limit;
2890 }
2891
2892 // TODO: this is currently untested
2893 /* During a handshake, use the value being negotiated */
2894 if (ssl->session_negotiate != NULL &&
2895 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2896 ssl->session_negotiate->record_size_limit < max_len) {
2897 record_size_limit = ssl->session_negotiate->record_size_limit;
2898 }
2899
2900 return record_size_limit;
2901}
2902#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2903
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002904#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002905size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002906{
David Horstmann95d516f2021-05-04 18:36:56 +01002907 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002908 size_t read_mfl;
2909
Jerry Yuddda0502022-12-01 19:43:12 +08002910#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002911 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2913 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2914 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002915 }
Jerry Yuddda0502022-12-01 19:43:12 +08002916#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002917
2918 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 if (ssl->session_out != NULL) {
2920 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2921 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002922 max_len = read_mfl;
2923 }
2924 }
2925
Jerry Yuddda0502022-12-01 19:43:12 +08002926 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 if (ssl->session_negotiate != NULL) {
2928 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2929 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002930 max_len = read_mfl;
2931 }
2932 }
2933
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002935}
2936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002938{
2939 size_t max_len;
2940
2941 /*
2942 * Assume mfl_code is correct since it was checked when set
2943 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002945
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002946 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 if (ssl->session_out != NULL &&
2948 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2949 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002950 }
2951
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002952 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 if (ssl->session_negotiate != NULL &&
2954 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2955 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002956 }
2957
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002959}
2960#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2961
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002962#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002963size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002964{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002965 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2967 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2968 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2969 return 0;
2970 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002971
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2973 return ssl->mtu;
2974 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002975
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (ssl->mtu == 0) {
2977 return ssl->handshake->mtu;
2978 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002979
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 return ssl->mtu < ssl->handshake->mtu ?
2981 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002982}
2983#endif /* MBEDTLS_SSL_PROTO_DTLS */
2984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002986{
2987 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2988
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002989#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002990 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002991 !defined(MBEDTLS_SSL_PROTO_DTLS)
2992 (void) ssl;
2993#endif
2994
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002995#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002997
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002999 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003001#endif
3002
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003003#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3004 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3005
3006 if (max_len > record_size_limit) {
3007 max_len = record_size_limit;
3008 }
3009#endif
3010
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003011 if (ssl->transform_out != NULL &&
3012 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003013 /*
3014 * In TLS 1.3 case, when records are protected, `max_len` as computed
3015 * above is the maximum length of the TLSInnerPlaintext structure that
3016 * along the plaintext payload contains the inner content type (one byte)
3017 * and some zero padding. Given the algorithm used for padding
3018 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3019 * the plaintext payload. Round down to a multiple of
3020 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3021 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003022 */
3023 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3024 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3025 }
3026
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003027#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3029 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3030 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003031 const size_t overhead = (size_t) ret;
3032
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 if (ret < 0) {
3034 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003035 }
3036
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 if (mtu <= overhead) {
3038 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3039 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3040 }
3041
3042 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003043 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003045 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003046#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003047
Hanno Becker0defedb2018-08-10 12:35:02 +01003048#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003049 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3050 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003051 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003052#endif
3053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003055}
3056
Gilles Peskine449bd832023-01-11 14:50:10 +01003057int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003058{
3059 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3060
3061#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3062 (void) ssl;
3063#endif
3064
3065#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003067
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003069 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003071#endif
3072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003074}
3075
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003076#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003077const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003078{
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 if (ssl == NULL || ssl->session == NULL) {
3080 return NULL;
3081 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003082
Hanno Beckere6824572019-02-07 13:18:46 +00003083#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003085#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003087#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003088}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003092int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3093 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003094{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003095 int ret;
3096
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003098 dst == NULL ||
3099 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003102 }
3103
Hanno Beckere810bbc2021-05-14 16:01:05 +01003104 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3105 * idempotent: Each session can only be exported once.
3106 *
3107 * (This is in preparation for TLS 1.3 support where we will
3108 * need the ability to export multiple sessions (aka tickets),
3109 * which will be achieved by calling mbedtls_ssl_get_session()
3110 * multiple times until it fails.)
3111 *
3112 * Check whether we have already exported the current session,
3113 * and fail if so.
3114 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003115 if (ssl->session->exported == 1) {
3116 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3117 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003118
Gilles Peskine449bd832023-01-11 14:50:10 +01003119 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3120 if (ret != 0) {
3121 return ret;
3122 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003123
3124 /* Remember that we've exported the session. */
3125 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003126 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003127}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003128#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003129
David Horstmanncb01b362024-02-29 17:31:46 +00003130#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3131
3132/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003133 *
David Horstmanncb01b362024-02-29 17:31:46 +00003134 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003135 */
3136static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3137 unsigned char *buf,
3138 size_t buf_len)
3139{
3140 unsigned char *p = buf;
3141 size_t used = 0;
3142
3143#if defined(MBEDTLS_HAVE_TIME)
3144 uint64_t start;
3145#endif
3146#if defined(MBEDTLS_X509_CRT_PARSE_C)
3147#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3148 size_t cert_len;
3149#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3150#endif /* MBEDTLS_X509_CRT_PARSE_C */
3151
3152 /*
3153 * Time
3154 */
3155#if defined(MBEDTLS_HAVE_TIME)
3156 used += 8;
3157
3158 if (used <= buf_len) {
3159 start = (uint64_t) session->start;
3160
3161 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3162 p += 8;
3163 }
3164#endif /* MBEDTLS_HAVE_TIME */
3165
3166 /*
3167 * Basic mandatory fields
3168 */
3169 used += 1 /* id_len */
3170 + sizeof(session->id)
3171 + sizeof(session->master)
3172 + 4; /* verify_result */
3173
3174 if (used <= buf_len) {
3175 *p++ = MBEDTLS_BYTE_0(session->id_len);
3176 memcpy(p, session->id, 32);
3177 p += 32;
3178
3179 memcpy(p, session->master, 48);
3180 p += 48;
3181
3182 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3183 p += 4;
3184 }
3185
3186 /*
3187 * Peer's end-entity certificate
3188 */
3189#if defined(MBEDTLS_X509_CRT_PARSE_C)
3190#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3191 if (session->peer_cert == NULL) {
3192 cert_len = 0;
3193 } else {
3194 cert_len = session->peer_cert->raw.len;
3195 }
3196
3197 used += 3 + cert_len;
3198
3199 if (used <= buf_len) {
3200 *p++ = MBEDTLS_BYTE_2(cert_len);
3201 *p++ = MBEDTLS_BYTE_1(cert_len);
3202 *p++ = MBEDTLS_BYTE_0(cert_len);
3203
3204 if (session->peer_cert != NULL) {
3205 memcpy(p, session->peer_cert->raw.p, cert_len);
3206 p += cert_len;
3207 }
3208 }
3209#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3210 if (session->peer_cert_digest != NULL) {
3211 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3212 if (used <= buf_len) {
3213 *p++ = (unsigned char) session->peer_cert_digest_type;
3214 *p++ = (unsigned char) session->peer_cert_digest_len;
3215 memcpy(p, session->peer_cert_digest,
3216 session->peer_cert_digest_len);
3217 p += session->peer_cert_digest_len;
3218 }
3219 } else {
3220 used += 2;
3221 if (used <= buf_len) {
3222 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3223 *p++ = 0;
3224 }
3225 }
3226#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3227#endif /* MBEDTLS_X509_CRT_PARSE_C */
3228
3229 /*
3230 * Session ticket if any, plus associated data
3231 */
3232#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3233#if defined(MBEDTLS_SSL_CLI_C)
3234 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3235 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3236
3237 if (used <= buf_len) {
3238 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3239 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3240 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3241
3242 if (session->ticket != NULL) {
3243 memcpy(p, session->ticket, session->ticket_len);
3244 p += session->ticket_len;
3245 }
3246
3247 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3248 p += 4;
3249 }
3250 }
3251#endif /* MBEDTLS_SSL_CLI_C */
3252#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3253 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3254 used += 8;
3255
3256 if (used <= buf_len) {
3257 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3258 p += 8;
3259 }
3260 }
3261#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3262#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3263
3264 /*
3265 * Misc extension-related info
3266 */
3267#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3268 used += 1;
3269
3270 if (used <= buf_len) {
3271 *p++ = session->mfl_code;
3272 }
3273#endif
3274
3275#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3276 used += 1;
3277
3278 if (used <= buf_len) {
3279 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3280 }
3281#endif
3282
3283 return used;
3284}
3285
3286MBEDTLS_CHECK_RETURN_CRITICAL
3287static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3288 const unsigned char *buf,
3289 size_t len)
3290{
3291#if defined(MBEDTLS_HAVE_TIME)
3292 uint64_t start;
3293#endif
3294#if defined(MBEDTLS_X509_CRT_PARSE_C)
3295#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3296 size_t cert_len;
3297#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3298#endif /* MBEDTLS_X509_CRT_PARSE_C */
3299
3300 const unsigned char *p = buf;
3301 const unsigned char * const end = buf + len;
3302
3303 /*
3304 * Time
3305 */
3306#if defined(MBEDTLS_HAVE_TIME)
3307 if (8 > (size_t) (end - p)) {
3308 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3309 }
3310
3311 start = MBEDTLS_GET_UINT64_BE(p, 0);
3312 p += 8;
3313
3314 session->start = (time_t) start;
3315#endif /* MBEDTLS_HAVE_TIME */
3316
3317 /*
3318 * Basic mandatory fields
3319 */
3320 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3321 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3322 }
3323
3324 session->id_len = *p++;
3325 memcpy(session->id, p, 32);
3326 p += 32;
3327
3328 memcpy(session->master, p, 48);
3329 p += 48;
3330
3331 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3332 p += 4;
3333
3334 /* Immediately clear invalid pointer values that have been read, in case
3335 * we exit early before we replaced them with valid ones. */
3336#if defined(MBEDTLS_X509_CRT_PARSE_C)
3337#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3338 session->peer_cert = NULL;
3339#else
3340 session->peer_cert_digest = NULL;
3341#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3342#endif /* MBEDTLS_X509_CRT_PARSE_C */
3343#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3344 session->ticket = NULL;
3345#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3346
3347 /*
3348 * Peer certificate
3349 */
3350#if defined(MBEDTLS_X509_CRT_PARSE_C)
3351#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3352 /* Deserialize CRT from the end of the ticket. */
3353 if (3 > (size_t) (end - p)) {
3354 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3355 }
3356
3357 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3358 p += 3;
3359
3360 if (cert_len != 0) {
3361 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3362
3363 if (cert_len > (size_t) (end - p)) {
3364 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3365 }
3366
3367 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3368
3369 if (session->peer_cert == NULL) {
3370 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3371 }
3372
3373 mbedtls_x509_crt_init(session->peer_cert);
3374
3375 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3376 p, cert_len)) != 0) {
3377 mbedtls_x509_crt_free(session->peer_cert);
3378 mbedtls_free(session->peer_cert);
3379 session->peer_cert = NULL;
3380 return ret;
3381 }
3382
3383 p += cert_len;
3384 }
3385#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3386 /* Deserialize CRT digest from the end of the ticket. */
3387 if (2 > (size_t) (end - p)) {
3388 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3389 }
3390
3391 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3392 session->peer_cert_digest_len = (size_t) *p++;
3393
3394 if (session->peer_cert_digest_len != 0) {
3395 const mbedtls_md_info_t *md_info =
3396 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3397 if (md_info == NULL) {
3398 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3399 }
3400 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3401 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3402 }
3403
3404 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3405 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3406 }
3407
3408 session->peer_cert_digest =
3409 mbedtls_calloc(1, session->peer_cert_digest_len);
3410 if (session->peer_cert_digest == NULL) {
3411 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3412 }
3413
3414 memcpy(session->peer_cert_digest, p,
3415 session->peer_cert_digest_len);
3416 p += session->peer_cert_digest_len;
3417 }
3418#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3419#endif /* MBEDTLS_X509_CRT_PARSE_C */
3420
3421 /*
3422 * Session ticket and associated data
3423 */
3424#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3425#if defined(MBEDTLS_SSL_CLI_C)
3426 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3427 if (3 > (size_t) (end - p)) {
3428 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3429 }
3430
3431 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3432 p += 3;
3433
3434 if (session->ticket_len != 0) {
3435 if (session->ticket_len > (size_t) (end - p)) {
3436 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3437 }
3438
3439 session->ticket = mbedtls_calloc(1, session->ticket_len);
3440 if (session->ticket == NULL) {
3441 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3442 }
3443
3444 memcpy(session->ticket, p, session->ticket_len);
3445 p += session->ticket_len;
3446 }
3447
3448 if (4 > (size_t) (end - p)) {
3449 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3450 }
3451
3452 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3453 p += 4;
3454 }
3455#endif /* MBEDTLS_SSL_CLI_C */
3456#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3457 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3458 if (8 > (size_t) (end - p)) {
3459 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3460 }
3461 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3462 p += 8;
3463 }
3464#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3465#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3466
3467 /*
3468 * Misc extension-related info
3469 */
3470#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3471 if (1 > (size_t) (end - p)) {
3472 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3473 }
3474
3475 session->mfl_code = *p++;
3476#endif
3477
3478#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3479 if (1 > (size_t) (end - p)) {
3480 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3481 }
3482
3483 session->encrypt_then_mac = *p++;
3484#endif
3485
3486 /* Done, should have consumed entire buffer */
3487 if (p != end) {
3488 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3489 }
3490
3491 return 0;
3492}
3493
3494#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3495
3496#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3497/* Serialization of TLS 1.3 sessions:
3498 *
David Horstmanncb01b362024-02-29 17:31:46 +00003499 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003500 */
3501#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3502MBEDTLS_CHECK_RETURN_CRITICAL
3503static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3504 unsigned char *buf,
3505 size_t buf_len,
3506 size_t *olen)
3507{
3508 unsigned char *p = buf;
3509#if defined(MBEDTLS_SSL_CLI_C) && \
3510 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3511 size_t hostname_len = (session->hostname == NULL) ?
3512 0 : strlen(session->hostname) + 1;
3513#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003514
3515#if defined(MBEDTLS_SSL_SRV_C) && \
3516 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003517 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003518 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003519#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003520 size_t needed = 4 /* ticket_age_add */
3521 + 1 /* ticket_flags */
3522 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003523
David Horstmanne59f9702024-02-29 16:08:57 +00003524 *olen = 0;
3525
3526 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3527 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3528 }
3529 needed += session->resumption_key_len; /* resumption_key */
3530
3531#if defined(MBEDTLS_SSL_EARLY_DATA)
3532 needed += 4; /* max_early_data_size */
3533#endif
3534#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3535 needed += 2; /* record_size_limit */
3536#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3537
3538#if defined(MBEDTLS_HAVE_TIME)
3539 needed += 8; /* ticket_creation_time or ticket_reception_time */
3540#endif
3541
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003542#if defined(MBEDTLS_SSL_SRV_C)
3543 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3544#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003545 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003546 + alpn_len; /* alpn */
3547#endif
3548 }
3549#endif /* MBEDTLS_SSL_SRV_C */
3550
David Horstmanne59f9702024-02-29 16:08:57 +00003551#if defined(MBEDTLS_SSL_CLI_C)
3552 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3553#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3554 needed += 2 /* hostname_len */
3555 + hostname_len; /* hostname */
3556#endif
3557
3558 needed += 4 /* ticket_lifetime */
3559 + 2; /* ticket_len */
3560
3561 /* Check size_t overflow */
3562 if (session->ticket_len > SIZE_MAX - needed) {
3563 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3564 }
3565
3566 needed += session->ticket_len; /* ticket */
3567 }
3568#endif /* MBEDTLS_SSL_CLI_C */
3569
3570 *olen = needed;
3571 if (needed > buf_len) {
3572 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3573 }
3574
3575 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3576 p[4] = session->ticket_flags;
3577
3578 /* save resumption_key */
3579 p[5] = session->resumption_key_len;
3580 p += 6;
3581 memcpy(p, session->resumption_key, session->resumption_key_len);
3582 p += session->resumption_key_len;
3583
3584#if defined(MBEDTLS_SSL_EARLY_DATA)
3585 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3586 p += 4;
3587#endif
3588#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3589 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3590 p += 2;
3591#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3592
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003593#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003594 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003595#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003596 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3597 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003598#endif /* MBEDTLS_HAVE_TIME */
3599
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003600#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003601 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3602 p += 2;
3603
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003604 if (alpn_len > 0) {
3605 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003606 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003607 p += alpn_len;
3608 }
3609#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3610 }
3611#endif /* MBEDTLS_SSL_SRV_C */
3612
David Horstmanne59f9702024-02-29 16:08:57 +00003613#if defined(MBEDTLS_SSL_CLI_C)
3614 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3615#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3616 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3617 p += 2;
3618 if (hostname_len > 0) {
3619 /* save host name */
3620 memcpy(p, session->hostname, hostname_len);
3621 p += hostname_len;
3622 }
3623#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3624
3625#if defined(MBEDTLS_HAVE_TIME)
3626 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3627 p += 8;
3628#endif
3629 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3630 p += 4;
3631
3632 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3633 p += 2;
3634
3635 if (session->ticket != NULL && session->ticket_len > 0) {
3636 memcpy(p, session->ticket, session->ticket_len);
3637 p += session->ticket_len;
3638 }
3639 }
3640#endif /* MBEDTLS_SSL_CLI_C */
3641 return 0;
3642}
3643
3644MBEDTLS_CHECK_RETURN_CRITICAL
3645static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3646 const unsigned char *buf,
3647 size_t len)
3648{
3649 const unsigned char *p = buf;
3650 const unsigned char *end = buf + len;
3651
3652 if (end - p < 6) {
3653 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3654 }
3655 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3656 session->ticket_flags = p[4];
3657
3658 /* load resumption_key */
3659 session->resumption_key_len = p[5];
3660 p += 6;
3661
3662 if (end - p < session->resumption_key_len) {
3663 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3664 }
3665
3666 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3667 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3668 }
3669 memcpy(session->resumption_key, p, session->resumption_key_len);
3670 p += session->resumption_key_len;
3671
3672#if defined(MBEDTLS_SSL_EARLY_DATA)
3673 if (end - p < 4) {
3674 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3675 }
3676 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3677 p += 4;
3678#endif
3679#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3680 if (end - p < 2) {
3681 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3682 }
3683 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3684 p += 2;
3685#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3686
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003687#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003688 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003689#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003690 if (end - p < 8) {
3691 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3692 }
3693 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3694 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003695#endif /* MBEDTLS_HAVE_TIME */
3696
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003697#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003698 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003699
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003700 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003701 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3702 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003703
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003704 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3705 p += 2;
3706
3707 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003708 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3709 }
3710
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003711 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003712 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3713 if (ret != 0) {
3714 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003715 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003716 p += alpn_len;
3717 }
3718#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3719 }
3720#endif /* MBEDTLS_SSL_SRV_C */
3721
David Horstmanne59f9702024-02-29 16:08:57 +00003722#if defined(MBEDTLS_SSL_CLI_C)
3723 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3724#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3725 size_t hostname_len;
3726 /* load host name */
3727 if (end - p < 2) {
3728 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3729 }
3730 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3731 p += 2;
3732
3733 if (end - p < (long int) hostname_len) {
3734 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3735 }
3736 if (hostname_len > 0) {
3737 session->hostname = mbedtls_calloc(1, hostname_len);
3738 if (session->hostname == NULL) {
3739 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3740 }
3741 memcpy(session->hostname, p, hostname_len);
3742 p += hostname_len;
3743 }
3744#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3745
3746#if defined(MBEDTLS_HAVE_TIME)
3747 if (end - p < 8) {
3748 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3749 }
3750 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3751 p += 8;
3752#endif
3753 if (end - p < 4) {
3754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3755 }
3756 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3757 p += 4;
3758
3759 if (end - p < 2) {
3760 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3761 }
3762 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3763 p += 2;
3764
3765 if (end - p < (long int) session->ticket_len) {
3766 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3767 }
3768 if (session->ticket_len > 0) {
3769 session->ticket = mbedtls_calloc(1, session->ticket_len);
3770 if (session->ticket == NULL) {
3771 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3772 }
3773 memcpy(session->ticket, p, session->ticket_len);
3774 p += session->ticket_len;
3775 }
3776 }
3777#endif /* MBEDTLS_SSL_CLI_C */
3778
3779 return 0;
3780
3781}
3782#else /* MBEDTLS_SSL_SESSION_TICKETS */
3783MBEDTLS_CHECK_RETURN_CRITICAL
3784static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3785 unsigned char *buf,
3786 size_t buf_len,
3787 size_t *olen)
3788{
3789 ((void) session);
3790 ((void) buf);
3791 ((void) buf_len);
3792 *olen = 0;
3793 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3794}
3795
3796static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003797 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003798 size_t buf_len)
3799{
3800 ((void) session);
3801 ((void) buf);
3802 ((void) buf_len);
3803 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3804}
3805#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3806#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3807
Paul Bakker5121ce52009-01-03 21:22:43 +00003808/*
Hanno Beckera835da52019-05-16 12:39:07 +01003809 * Define ticket header determining Mbed TLS version
3810 * and structure of the ticket.
3811 */
3812
Hanno Becker94ef3b32019-05-16 12:50:45 +01003813/*
Hanno Becker50b59662019-05-28 14:30:45 +01003814 * Define bitflag determining compile-time settings influencing
3815 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003816 */
3817
Hanno Becker50b59662019-05-28 14:30:45 +01003818#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003819#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003820#else
Hanno Becker3e088662019-05-29 11:10:18 +01003821#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003822#endif /* MBEDTLS_HAVE_TIME */
3823
3824#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003825#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003826#else
Hanno Becker3e088662019-05-29 11:10:18 +01003827#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003828#endif /* MBEDTLS_X509_CRT_PARSE_C */
3829
David Horstmann5c5a32f2024-02-13 17:53:35 +00003830#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003831#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003832#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003833#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003834#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3835
Hanno Becker94ef3b32019-05-16 12:50:45 +01003836#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003837#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003838#else
Hanno Becker3e088662019-05-29 11:10:18 +01003839#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003840#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3841
3842#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003843#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003844#else
Hanno Becker3e088662019-05-29 11:10:18 +01003845#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003846#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3847
Hanno Becker94ef3b32019-05-16 12:50:45 +01003848#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003849#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003850#else
Hanno Becker3e088662019-05-29 11:10:18 +01003851#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003852#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3853
Hanno Becker94ef3b32019-05-16 12:50:45 +01003854#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3855#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3856#else
3857#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3858#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3859
David Horstmann92b258b2024-02-13 17:23:34 +00003860#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3861#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3862#else
3863#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3864#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3865
3866#if defined(MBEDTLS_SSL_EARLY_DATA)
3867#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3868#else
3869#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3870#endif /* MBEDTLS_SSL_EARLY_DATA */
3871
3872#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3873#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3874#else
3875#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3876#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3877
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003878#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3879 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003880#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3881#else
3882#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3883#endif /* MBEDTLS_SSL_ALPN */
3884
Hanno Becker3e088662019-05-29 11:10:18 +01003885#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3886#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3887#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3888#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003889#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3890#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003891#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003892#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3893#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3894#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003895#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003896
Hanno Becker50b59662019-05-28 14:30:45 +01003897#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003898 ((uint16_t) ( \
3899 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3900 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3901 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3902 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3903 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3904 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003905 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003906 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3907 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003908 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3909 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3910 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3911 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003912 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003913 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003914 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003915
Chien Wong4e9683e2023-12-28 17:07:43 +08003916static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003917 MBEDTLS_VERSION_MAJOR,
3918 MBEDTLS_VERSION_MINOR,
3919 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003920 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3921 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003922};
Hanno Beckera835da52019-05-16 12:39:07 +01003923
3924/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003925 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003926 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003927 *
David Horstmanncb01b362024-02-29 17:31:46 +00003928 * TLS 1.2 session:
3929 *
3930 * struct {
3931 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3932 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3933 * uint32 ticket_lifetime;
3934 * #endif
3935 * } ClientOnlyData;
3936 *
3937 * struct {
3938 * #if defined(MBEDTLS_HAVE_TIME)
3939 * uint64 start_time;
3940 * #endif
3941 * uint8 session_id_len; // at most 32
3942 * opaque session_id[32];
3943 * opaque master[48]; // fixed length in the standard
3944 * uint32 verify_result;
3945 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3946 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3947 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003948 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003949 * opaque peer_cert_digest<0..2^8-1>
3950 * #endif
3951 * select (endpoint) {
3952 * case client: ClientOnlyData;
3953 * case server: uint64 ticket_creation_time;
3954 * };
3955 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3956 * uint8 mfl_code; // up to 255 according to standard
3957 * #endif
3958 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3959 * uint8 encrypt_then_mac; // 0 or 1
3960 * #endif
3961 * } serialized_session_tls12;
3962 *
3963 *
3964 * TLS 1.3 Session:
3965 *
3966 * struct {
3967 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3968 * opaque hostname<0..2^16-1>;
3969 * #endif
3970 * #if defined(MBEDTLS_HAVE_TIME)
3971 * uint64 ticket_reception_time;
3972 * #endif
3973 * uint32 ticket_lifetime;
3974 * opaque ticket<1..2^16-1>;
3975 * } ClientOnlyData;
3976 *
3977 * struct {
3978 * uint32 ticket_age_add;
3979 * uint8 ticket_flags;
3980 * opaque resumption_key<0..255>;
3981 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3982 * uint32 max_early_data_size;
3983 * #endif
3984 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3985 * uint16 record_size_limit;
3986 * #endif
3987 * select ( endpoint ) {
3988 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003989 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003990 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003991 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003992 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003993 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003994 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003995 * #endif
3996 * };
3997 * } serialized_session_tls13;
3998 *
3999 *
4000 * SSL session:
4001 *
4002 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004003 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004004 * opaque mbedtls_version[3]; // library version: major, minor, patch
4005 * opaque session_format[2]; // library-version specific 16-bit field
4006 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004007 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004008 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004009 * Note: When updating the format, remember to keep
4010 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004011 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004012 * // In this version, `session_format` determines
4013 * // the setting of those compile-time
4014 * // configuration options which influence
4015 * // the structure of mbedtls_ssl_session.
4016 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004017 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004018 * // - TLS 1.2 (0x0303)
4019 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004020 * uint8_t endpoint;
4021 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004022 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004023 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004024 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004025 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004026 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004027 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004028 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004029 *
4030 * };
4031 *
4032 * } serialized_session;
4033 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004034 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004035
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004036MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004037static int ssl_session_save(const mbedtls_ssl_session *session,
4038 unsigned char omit_header,
4039 unsigned char *buf,
4040 size_t buf_len,
4041 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004042{
4043 unsigned char *p = buf;
4044 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004045 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004046#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4047 size_t out_len;
4048 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4049#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 if (session == NULL) {
4051 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4052 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004053
Gilles Peskine449bd832023-01-11 14:50:10 +01004054 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004055 /*
4056 * Add Mbed TLS version identifier
4057 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004059
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 if (used <= buf_len) {
4061 memcpy(p, ssl_serialized_session_header,
4062 sizeof(ssl_serialized_session_header));
4063 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004064 }
4065 }
4066
4067 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004068 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004069 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004070 used += 1 /* TLS version */
4071 + 1 /* endpoint */
4072 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004073 if (used <= buf_len) {
4074 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004075 *p++ = session->endpoint;
4076 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4077 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004078 }
4079
4080 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004081 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004083#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 case MBEDTLS_SSL_VERSION_TLS1_2:
4085 used += ssl_tls12_session_save(session, p, remaining_len);
4086 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004087#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4088
Jerry Yu251a12e2022-07-13 15:15:48 +08004089#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004090 case MBEDTLS_SSL_VERSION_TLS1_3:
4091 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4092 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4093 return ret;
4094 }
4095 used += out_len;
4096 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004097#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4098
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 default:
4100 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004101 }
4102
4103 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 if (used > buf_len) {
4105 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4106 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004107
Gilles Peskine449bd832023-01-11 14:50:10 +01004108 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004109}
4110
4111/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004112 * Public wrapper for ssl_session_save()
4113 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004114int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4115 unsigned char *buf,
4116 size_t buf_len,
4117 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004118{
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004120}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004121
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004122/*
4123 * Deserialize session, see mbedtls_ssl_session_save() for format.
4124 *
4125 * This internal version is wrapped by a public function that cleans up in
4126 * case of error, and has an extra option omit_header.
4127 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004128MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004129static int ssl_session_load(mbedtls_ssl_session *session,
4130 unsigned char omit_header,
4131 const unsigned char *buf,
4132 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004133{
4134 const unsigned char *p = buf;
4135 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004136 size_t remaining_len;
4137
4138
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 if (session == NULL) {
4140 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4141 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004142
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004144 /*
4145 * Check Mbed TLS version identifier
4146 */
4147
Gilles Peskine449bd832023-01-11 14:50:10 +01004148 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4149 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004150 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004151
4152 if (memcmp(p, ssl_serialized_session_header,
4153 sizeof(ssl_serialized_session_header)) != 0) {
4154 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4155 }
4156 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004157 }
4158
4159 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004160 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004161 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004162 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4164 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004165 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004166 session->endpoint = *p++;
4167 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4168 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004169
4170 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004171 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004173#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004174 case MBEDTLS_SSL_VERSION_TLS1_2:
4175 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004176#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4177
Jerry Yu438ddd82022-07-07 06:55:50 +00004178#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 case MBEDTLS_SSL_VERSION_TLS1_3:
4180 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004181#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4182
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 default:
4184 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004185 }
4186}
4187
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004188/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004189 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004190 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004191int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4192 const unsigned char *buf,
4193 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004194{
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004196
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 if (ret != 0) {
4198 mbedtls_ssl_session_free(session);
4199 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004200
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004202}
4203
4204/*
Paul Bakker1961b702013-01-25 14:49:24 +01004205 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004206 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004207MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004208static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004209{
4210 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4211
Ronald Cron66dbf912022-02-02 15:33:46 +01004212 /*
4213 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004214 * that were written into the output buffer by the previous handshake step,
4215 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004216 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4217 * We proceed to the next handshake step only when all data from the
4218 * previous one have been sent to the peer, thus we make sure that this is
4219 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4220 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4221 * we have to wait before to go ahead.
4222 * In the case of TLS 1.3, handshake step handlers do not send data to the
4223 * peer. Data are only sent here and through
4224 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004225 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004226 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4228 return ret;
4229 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004230
4231#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004232 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4233 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4234 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4235 return ret;
4236 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004237 }
4238#endif /* MBEDTLS_SSL_PROTO_DTLS */
4239
Gilles Peskine449bd832023-01-11 14:50:10 +01004240 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004241}
4242
Gilles Peskine449bd832023-01-11 14:50:10 +01004243int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004244{
Hanno Becker41934dd2021-08-07 19:13:43 +01004245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004246
Gilles Peskine449bd832023-01-11 14:50:10 +01004247 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004248 ssl->conf == NULL ||
4249 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004250 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4251 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004252 }
4253
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 ret = ssl_prepare_handshake_step(ssl);
4255 if (ret != 0) {
4256 return ret;
4257 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004258
Gilles Peskine449bd832023-01-11 14:50:10 +01004259 ret = mbedtls_ssl_handle_pending_alert(ssl);
4260 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004261 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 }
Jerry Yue7047812021-09-13 19:26:39 +08004263
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004264 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4265 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4266 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4267
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004268#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004269 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4270 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004271 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004272
Gilles Peskine449bd832023-01-11 14:50:10 +01004273 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004274 case MBEDTLS_SSL_HELLO_REQUEST:
4275 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004276 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004277 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004278
Ronald Cron9f0fba32022-02-10 16:45:15 +01004279 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004280 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004281 break;
4282
4283 default:
4284#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004285 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4286 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4287 } else {
4288 ret = mbedtls_ssl_handshake_client_step(ssl);
4289 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004290#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004292#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004294#endif
4295 }
Jerry Yub9930e72021-08-06 17:11:51 +08004296 }
Ronald Cron6291b232023-03-08 15:51:25 +01004297#endif /* MBEDTLS_SSL_CLI_C */
4298
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004299#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004301#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4302 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004304 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 ret = mbedtls_ssl_handshake_server_step(ssl);
4306 }
Ronald Cron6291b232023-03-08 15:51:25 +01004307#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4308 ret = mbedtls_ssl_handshake_server_step(ssl);
4309#else
4310 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004311#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004312 }
4313#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004314
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004316 /* handshake_step return error. And it is same
4317 * with alert_reason.
4318 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 if (ssl->send_alert) {
4320 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004321 goto cleanup;
4322 }
4323 }
4324
4325cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004327}
4328
4329/*
4330 * Perform the SSL handshake
4331 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004332int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004333{
4334 int ret = 0;
4335
Hanno Beckera817ea42020-10-20 15:20:23 +01004336 /* Sanity checks */
4337
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 if (ssl == NULL || ssl->conf == NULL) {
4339 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4340 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004341
Hanno Beckera817ea42020-10-20 15:20:23 +01004342#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4344 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4345 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4346 "mbedtls_ssl_set_timer_cb() for DTLS"));
4347 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004348 }
4349#endif /* MBEDTLS_SSL_PROTO_DTLS */
4350
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004352
Hanno Beckera817ea42020-10-20 15:20:23 +01004353 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4355 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004356
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004358 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 }
Paul Bakker1961b702013-01-25 14:49:24 +01004360 }
4361
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004363
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004365}
4366
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004367#if defined(MBEDTLS_SSL_RENEGOTIATION)
4368#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004369/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004370 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004371 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004372MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004373static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004374{
Janos Follath865b3eb2019-12-16 11:46:15 +00004375 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004376
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004378
4379 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004380 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4381 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004382
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4384 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4385 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004386 }
4387
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004389
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004391}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004392#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004393
4394/*
4395 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004396 * - any side: calling mbedtls_ssl_renegotiate(),
4397 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4398 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004399 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004400 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004401 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004402 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004403int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004404{
Janos Follath865b3eb2019-12-16 11:46:15 +00004405 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004406
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004408
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 if ((ret = ssl_handshake_init(ssl)) != 0) {
4410 return ret;
4411 }
Paul Bakker48916f92012-09-16 19:57:18 +00004412
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004413 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4414 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004415#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4417 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4418 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004419 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004421 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004423 }
4424#endif
4425
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004426 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4427 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004428
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4430 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4431 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004432 }
4433
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004435
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004437}
4438
4439/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004440 * Renegotiate current connection on client,
4441 * or request renegotiation on server
4442 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004443int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004444{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004445 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 if (ssl == NULL || ssl->conf == NULL) {
4448 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4449 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004450
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004451#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004452 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4454 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4455 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4456 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004457
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004458 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004459
4460 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 if (ssl->out_left != 0) {
4462 return mbedtls_ssl_flush_output(ssl);
4463 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004464
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004466 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004467#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004468
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004469#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004470 /*
4471 * On client, either start the renegotiation process or,
4472 * if already in progress, continue the handshake
4473 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4475 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4476 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004477 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004478
4479 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4480 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4481 return ret;
4482 }
4483 } else {
4484 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4485 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4486 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004487 }
4488 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004489#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004490
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004492}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004493#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004494
Gilles Peskine449bd832023-01-11 14:50:10 +01004495void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004496{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004497 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4498
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004500 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004502
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004503#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004504#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 if (ssl->handshake->group_list_heap_allocated) {
4506 mbedtls_free((void *) handshake->group_list);
4507 }
Brett Warrene0edc842021-08-17 09:53:13 +01004508 handshake->group_list = NULL;
4509#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004510#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004511
Ronald Crone68ab4f2022-10-05 12:46:29 +02004512#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004513#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 if (ssl->handshake->sig_algs_heap_allocated) {
4515 mbedtls_free((void *) handshake->sig_algs);
4516 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004517 handshake->sig_algs = NULL;
4518#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004519#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004520 if (ssl->handshake->certificate_request_context) {
4521 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004522 }
4523#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004524#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004525
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004526#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4528 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004529 handshake->async_in_progress = 0;
4530 }
4531#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4532
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004533#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004535#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004536#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004538#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004540#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004542#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004543
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004544#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004546 /*
4547 * Opaque keys are not stored in the handshake's data and it's the user
4548 * responsibility to destroy them. Clear ones, instead, are created by
4549 * the TLS library and should be destroyed at the same level
4550 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4552 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004553 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004554 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004555#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004557 handshake->ecjpake_cache = NULL;
4558 handshake->ecjpake_cache_len = 0;
4559#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004560#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004561
Valerio Setti7aeec542023-07-05 18:57:21 +02004562#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004563 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004564 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004565 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004567#endif
4568
Ronald Cron73fe8df2022-10-05 14:31:43 +02004569#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004571 /* The maintenance of the external PSK key slot is the
4572 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 if (ssl->handshake->psk_opaque_is_internal) {
4574 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004575 ssl->handshake->psk_opaque_is_internal = 0;
4576 }
4577 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4578 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004579#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004580
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004581#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4582 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004583 /*
4584 * Free only the linked list wrapper, not the keys themselves
4585 * since the belong to the SNI callback
4586 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004588#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004589
Gilles Peskineeccd8882020-03-10 12:19:08 +01004590#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4592 if (handshake->ecrs_peer_cert != NULL) {
4593 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4594 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004595 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004596#endif
4597
Hanno Becker75173122019-02-06 16:18:31 +00004598#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4599 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004601#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4602
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004603#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4605 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004606#endif /* MBEDTLS_SSL_CLI_C &&
4607 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004608
4609#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 mbedtls_ssl_flight_free(handshake->flight);
4611 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004612#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004613
Valerio Settiea59c432023-07-25 11:14:03 +02004614#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004615 if (handshake->xxdh_psa_privkey_is_external == 0) {
4616 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 }
Valerio Settiea59c432023-07-25 11:14:03 +02004618#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004619
Ronald Cron6f135e12021-12-08 16:57:54 +01004620#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 mbedtls_ssl_transform_free(handshake->transform_handshake);
4622 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004623#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4625 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004626#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004627#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004628
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004629
4630#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4631 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4632 * processes datagrams and the fact that a datagram is allowed to have
4633 * several records in it, it is possible that the I/O buffers are not
4634 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4636 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004637#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004638
Jerry Yuba9c7272021-10-30 11:54:10 +08004639 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 mbedtls_platform_zeroize(handshake,
4641 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004642}
4643
Gilles Peskine449bd832023-01-11 14:50:10 +01004644void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004645{
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004647 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004650#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004652#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004653
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004654#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004655#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4656 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004658#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004660#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004661
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004662#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4663 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004664 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004665#endif
4666
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004668}
4669
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004670#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004671
4672#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4673#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4674#else
4675#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4676#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4677
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004678#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004679
4680#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4681#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4682#else
4683#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4684#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4685
4686#if defined(MBEDTLS_SSL_ALPN)
4687#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4688#else
4689#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4690#endif /* MBEDTLS_SSL_ALPN */
4691
4692#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4693#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4694#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4695#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4696
4697#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 ((uint32_t) ( \
4699 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4700 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4701 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4702 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4703 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4704 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4705 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4706 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004707
Chien Wong4e9683e2023-12-28 17:07:43 +08004708static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004709 MBEDTLS_VERSION_MAJOR,
4710 MBEDTLS_VERSION_MINOR,
4711 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4713 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4714 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4715 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4716 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004717};
4718
Paul Bakker5121ce52009-01-03 21:22:43 +00004719/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004720 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004721 *
4722 * The format of the serialized data is:
4723 * (in the presentation language of TLS, RFC 8446 section 3)
4724 *
4725 * // header
4726 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004727 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004728 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004729 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004730 * Note: When updating the format, remember to keep these
4731 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004732 *
4733 * // session sub-structure
4734 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4735 * // transform sub-structure
4736 * uint8 random[64]; // ServerHello.random+ClientHello.random
4737 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4738 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4739 * // fields from ssl_context
4740 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4741 * uint64 in_window_top; // DTLS: last validated record seq_num
4742 * uint64 in_window; // DTLS: bitmask for replay protection
4743 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4744 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4745 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4746 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4747 *
4748 * Note that many fields of the ssl_context or sub-structures are not
4749 * serialized, as they fall in one of the following categories:
4750 *
4751 * 1. forced value (eg in_left must be 0)
4752 * 2. pointer to dynamically-allocated memory (eg session, transform)
4753 * 3. value can be re-derived from other data (eg session keys from MS)
4754 * 4. value was temporary (eg content of input buffer)
4755 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004756 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004757int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4758 unsigned char *buf,
4759 size_t buf_len,
4760 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004761{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004762 unsigned char *p = buf;
4763 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004764 size_t session_len;
4765 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004766
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004767 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004768 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4769 * this function's documentation.
4770 *
4771 * These are due to assumptions/limitations in the implementation. Some of
4772 * them are likely to stay (no handshake in progress) some might go away
4773 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004774 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004775 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4777 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4778 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004779 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 if (ssl->handshake != NULL) {
4781 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4782 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004783 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004784 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 if (ssl->transform == NULL || ssl->session == NULL) {
4786 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4787 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004788 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004789 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 if (mbedtls_ssl_check_pending(ssl) != 0) {
4791 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4792 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004793 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 if (ssl->out_left != 0) {
4795 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4796 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004797 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004798 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4800 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4801 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004802 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004803 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4805 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4806 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004807 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004808 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004809 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4810 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4811 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004812 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004813 /* Renegotiation must not be enabled */
4814#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4816 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4817 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004818 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004819#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004820
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004821 /*
4822 * Version and format identifier
4823 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004825
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (used <= buf_len) {
4827 memcpy(p, ssl_serialized_context_header,
4828 sizeof(ssl_serialized_context_header));
4829 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004830 }
4831
4832 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004833 * Session (length + data)
4834 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4836 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4837 return ret;
4838 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004839
4840 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (used <= buf_len) {
4842 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004843 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004844
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 ret = ssl_session_save(ssl->session, 1,
4846 p, session_len, &session_len);
4847 if (ret != 0) {
4848 return ret;
4849 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004850
4851 p += session_len;
4852 }
4853
4854 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004855 * Transform
4856 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 used += sizeof(ssl->transform->randbytes);
4858 if (used <= buf_len) {
4859 memcpy(p, ssl->transform->randbytes,
4860 sizeof(ssl->transform->randbytes));
4861 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004862 }
4863
4864#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004865 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004867 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004869 p += ssl->transform->in_cid_len;
4870
4871 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004873 p += ssl->transform->out_cid_len;
4874 }
4875#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4876
4877 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004878 * Saved fields from top-level ssl_context structure
4879 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004880 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if (used <= buf_len) {
4882 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004883 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004884 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004885
4886#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4887 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 if (used <= buf_len) {
4889 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004890 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004891
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004893 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004894 }
4895#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4896
4897#if defined(MBEDTLS_SSL_PROTO_DTLS)
4898 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004900 *p++ = ssl->disable_datagram_packing;
4901 }
4902#endif /* MBEDTLS_SSL_PROTO_DTLS */
4903
Jerry Yuae0b2e22021-10-08 15:21:19 +08004904 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 if (used <= buf_len) {
4906 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004907 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004908 }
4909
4910#if defined(MBEDTLS_SSL_PROTO_DTLS)
4911 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 if (used <= buf_len) {
4913 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004914 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004915 }
4916#endif /* MBEDTLS_SSL_PROTO_DTLS */
4917
4918#if defined(MBEDTLS_SSL_ALPN)
4919 {
4920 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004922 : 0;
4923
4924 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004926 *p++ = alpn_len;
4927
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 if (ssl->alpn_chosen != NULL) {
4929 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004930 p += alpn_len;
4931 }
4932 }
4933 }
4934#endif /* MBEDTLS_SSL_ALPN */
4935
4936 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004937 * Done
4938 */
4939 *olen = used;
4940
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 if (used > buf_len) {
4942 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4943 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004944
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004946
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004948}
4949
4950/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004951 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004952 *
4953 * This internal version is wrapped by a public function that cleans up in
4954 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004955 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004956MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004957static int ssl_context_load(mbedtls_ssl_context *ssl,
4958 const unsigned char *buf,
4959 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004960{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004961 const unsigned char *p = buf;
4962 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004963 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004964 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004965#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004966 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004967#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004968
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004969 /*
4970 * The context should have been freshly setup or reset.
4971 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004972 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004973 * renegotiating, or if the user mistakenly loaded a session first.)
4974 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4976 ssl->session != NULL) {
4977 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004978 }
4979
4980 /*
4981 * We can't check that the config matches the initial one, but we can at
4982 * least check it matches the requirements for serializing.
4983 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004984 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004985#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004986 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004987#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004988 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4989 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4990 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4991 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004992 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004993 }
4994
Gilles Peskine449bd832023-01-11 14:50:10 +01004995 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004996
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004997 /*
4998 * Check version identifier
4999 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5001 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005002 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005003
5004 if (memcmp(p, ssl_serialized_context_header,
5005 sizeof(ssl_serialized_context_header)) != 0) {
5006 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5007 }
5008 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005009
5010 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005011 * Session
5012 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 if ((size_t) (end - p) < 4) {
5014 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5015 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005016
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005017 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005018 p += 4;
5019
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005020 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005021 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005022 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005023 ssl->session_in = ssl->session;
5024 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005025 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005026
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 if ((size_t) (end - p) < session_len) {
5028 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5029 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005030
Gilles Peskine449bd832023-01-11 14:50:10 +01005031 ret = ssl_session_load(ssl->session, 1, p, session_len);
5032 if (ret != 0) {
5033 mbedtls_ssl_session_free(ssl->session);
5034 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005035 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005036
5037 p += session_len;
5038
5039 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005040 * Transform
5041 */
5042
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005043 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005044 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005045#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005046 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005047 ssl->transform_in = ssl->transform;
5048 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005049 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005050#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005051
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005052#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5054 if (prf_func == NULL) {
5055 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5056 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005057
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005058 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5060 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5061 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005062
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 ret = ssl_tls12_populate_transform(ssl->transform,
5064 ssl->session->ciphersuite,
5065 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005066#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005068#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 prf_func,
5070 p, /* currently pointing to randbytes */
5071 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5072 ssl->conf->endpoint,
5073 ssl);
5074 if (ret != 0) {
5075 return ret;
5076 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005077#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005079
5080#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5081 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005082 if ((size_t) (end - p) < 1) {
5083 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5084 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005085
5086 ssl->transform->in_cid_len = *p++;
5087
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5089 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5090 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005091
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005093 p += ssl->transform->in_cid_len;
5094
5095 ssl->transform->out_cid_len = *p++;
5096
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5098 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5099 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005100
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005102 p += ssl->transform->out_cid_len;
5103#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5104
5105 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005106 * Saved fields from top-level ssl_context structure
5107 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 if ((size_t) (end - p) < 4) {
5109 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5110 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005111
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005112 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005113 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005114
5115#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 if ((size_t) (end - p) < 16) {
5117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5118 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005119
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005120 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005121 p += 8;
5122
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005123 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005124 p += 8;
5125#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5126
5127#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 if ((size_t) (end - p) < 1) {
5129 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5130 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005131
5132 ssl->disable_datagram_packing = *p++;
5133#endif /* MBEDTLS_SSL_PROTO_DTLS */
5134
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5136 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5137 }
5138 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5139 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005140
5141#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 if ((size_t) (end - p) < 2) {
5143 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5144 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005145
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005146 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005147 p += 2;
5148#endif /* MBEDTLS_SSL_PROTO_DTLS */
5149
5150#if defined(MBEDTLS_SSL_ALPN)
5151 {
5152 uint8_t alpn_len;
5153 const char **cur;
5154
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 if ((size_t) (end - p) < 1) {
5156 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5157 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005158
5159 alpn_len = *p++;
5160
Gilles Peskine449bd832023-01-11 14:50:10 +01005161 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005162 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5164 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005165 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005166 ssl->alpn_chosen = *cur;
5167 break;
5168 }
5169 }
5170 }
5171
5172 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5175 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005176
5177 p += alpn_len;
5178 }
5179#endif /* MBEDTLS_SSL_ALPN */
5180
5181 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005182 * Forced fields from top-level ssl_context structure
5183 *
5184 * Most of them already set to the correct value by mbedtls_ssl_init() and
5185 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5186 */
5187 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005188 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005189
Hanno Becker361b10d2019-08-30 10:42:49 +01005190 /* Adjust pointers for header fields of outgoing records to
5191 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005193
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005194#if defined(MBEDTLS_SSL_PROTO_DTLS)
5195 ssl->in_epoch = 1;
5196#endif
5197
5198 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5199 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005200 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5201 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 if (ssl->handshake != NULL) {
5203 mbedtls_ssl_handshake_free(ssl);
5204 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005205 ssl->handshake = NULL;
5206 }
5207
5208 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005209 * Done - should have consumed entire buffer
5210 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 if (p != end) {
5212 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5213 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005214
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005216}
5217
5218/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005219 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005220 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005221int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5222 const unsigned char *buf,
5223 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005224{
Gilles Peskine449bd832023-01-11 14:50:10 +01005225 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005226
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 if (ret != 0) {
5228 mbedtls_ssl_free(context);
5229 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005230
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005232}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005233#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005234
5235/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005236 * Free an SSL context
5237 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005238void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005239{
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005241 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005242 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005243
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005245
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005247#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5248 size_t out_buf_len = ssl->out_buf_len;
5249#else
5250 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5251#endif
5252
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005253 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005254 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005255 }
5256
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005258#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5259 size_t in_buf_len = ssl->in_buf_len;
5260#else
5261 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5262#endif
5263
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005264 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005265 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005266 }
5267
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 if (ssl->transform) {
5269 mbedtls_ssl_transform_free(ssl->transform);
5270 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005271 }
5272
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 if (ssl->handshake) {
5274 mbedtls_ssl_handshake_free(ssl);
5275 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005276
5277#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5279 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005280#endif
5281
Gilles Peskine449bd832023-01-11 14:50:10 +01005282 mbedtls_ssl_session_free(ssl->session_negotiate);
5283 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005284 }
5285
Ronald Cron6f135e12021-12-08 16:57:54 +01005286#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 mbedtls_ssl_transform_free(ssl->transform_application);
5288 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005289#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005290
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 if (ssl->session) {
5292 mbedtls_ssl_session_free(ssl->session);
5293 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005294 }
5295
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005296#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005298 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005299 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005300#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005301
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005302#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005304#endif
5305
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005307
Paul Bakker86f04f42013-02-14 11:20:09 +01005308 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005310}
5311
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005312/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005313 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005314 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005315void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005316{
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005318}
5319
Gilles Peskineae270bf2021-06-02 00:05:29 +02005320/* The selection should be the same as mbedtls_x509_crt_profile_default in
5321 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005322 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005323 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005324 * about this list.
5325 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005326static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005327#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005328 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005329#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005330#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005331 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005332#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005333#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005334 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005335#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005336#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005337 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005338#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005339#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005340 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005341#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005342#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005343 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005344#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005345#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005346 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005347#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005348#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005349 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005350#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005351#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005352 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5353 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5354 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5355 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5356 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5357#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005358 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005359};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005360
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005361static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005362 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5363 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5364 0
5365};
5366
Ronald Crone68ab4f2022-10-05 12:46:29 +02005367#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005368
Jerry Yu909df7b2022-01-22 11:56:27 +08005369/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005370 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005371 * rules SHOULD be upheld.
5372 * - No duplicate entries.
5373 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005374 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005375 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005376 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005377static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005378
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005379#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005380 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005381 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005382 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005383 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5384#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005385
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005386#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005387 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005388 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005389 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005390 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5391#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005392
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005393#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005394 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005395 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005396 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005397 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5398#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005399
Gabor Mezeic15ef932024-06-13 12:53:54 +02005400#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005401 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005402#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005403
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005404#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005405 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005406#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005407
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005408#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005409 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005410#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005411
Gabor Mezeic15ef932024-06-13 12:53:54 +02005412#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005413 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005414#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005415
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005416#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005417 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005418#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005419
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005420#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005421 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005422#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005423
Gabor Mezei15b95a62022-05-09 16:37:58 +02005424 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005425};
5426
5427/* NOTICE: see above */
5428#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5429static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005430
Gabor Mezeic15ef932024-06-13 12:53:54 +02005431#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005432#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005434#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005435#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5436 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005437#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005438#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005440#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005441#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005442
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005443#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005444#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005446#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005447#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5448 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005449#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005450#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005452#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005453#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005454
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005455#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005456#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005458#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005459#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5460 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005461#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005462#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005464#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005465#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005466
Gabor Mezei15b95a62022-05-09 16:37:58 +02005467 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005468};
5469#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005470
Jerry Yu909df7b2022-01-22 11:56:27 +08005471/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005472static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005473
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005474#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005475 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005476 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005477 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005478 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5479#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005480
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005481#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005482 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005483 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005484 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005485 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5486#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005487
Gabor Mezei15b95a62022-05-09 16:37:58 +02005488 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005489};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005490
Jerry Yu909df7b2022-01-22 11:56:27 +08005491/* NOTICE: see above */
5492#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5493static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005494
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005495#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005496#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005498#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005499#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005500
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005501#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005502#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005504#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005505#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005506
Gabor Mezei15b95a62022-05-09 16:37:58 +02005507 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005508};
Jerry Yu909df7b2022-01-22 11:56:27 +08005509#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5510
Ronald Crone68ab4f2022-10-05 12:46:29 +02005511#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005512
Chien Wong4e9683e2023-12-28 17:07:43 +08005513static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005514#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005515 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005516#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005517#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005518 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005519#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005520 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005521};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005522
Ronald Crone68ab4f2022-10-05 12:46:29 +02005523#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005524/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005525 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005526MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005527static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005528{
5529 size_t i, j;
5530 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005531
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5533 for (j = 0; j < i; j++) {
5534 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005535 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 }
5537 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5538 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5539 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005540 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005541 }
5542 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005544}
5545
Ronald Crone68ab4f2022-10-05 12:46:29 +02005546#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005547
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005548/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005549 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005550 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005551int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5552 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005553{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005554#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005555 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005556#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005557
Ronald Crone68ab4f2022-10-05 12:46:29 +02005558#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5560 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5561 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005562 }
5563
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5565 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5566 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005567 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005568
5569#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5571 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5572 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005573 }
5574
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5576 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5577 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005578 }
5579#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005580#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005581
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005582 /* Use the functions here so that they are covered in tests,
5583 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 mbedtls_ssl_conf_endpoint(conf, endpoint);
5585 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005586
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005587 /*
5588 * Things that are common to all presets
5589 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005590#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005592 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5593#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5594 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5595#endif
5596 }
5597#endif
5598
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005599#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5600 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5601#endif
5602
5603#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5604 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5605#endif
5606
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005607#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005608 conf->f_cookie_write = ssl_cookie_write_dummy;
5609 conf->f_cookie_check = ssl_cookie_check_dummy;
5610#endif
5611
5612#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5613 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5614#endif
5615
Janos Follath088ce432017-04-10 12:42:31 +01005616#if defined(MBEDTLS_SSL_SRV_C)
5617 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005618 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005619#endif
5620
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005621#if defined(MBEDTLS_SSL_PROTO_DTLS)
5622 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5623 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5624#endif
5625
5626#if defined(MBEDTLS_SSL_RENEGOTIATION)
5627 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 memset(conf->renego_period, 0x00, 2);
5629 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005630#endif
5631
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005632#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005634 const unsigned char dhm_p[] =
5635 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5636 const unsigned char dhm_g[] =
5637 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005638
Gilles Peskine449bd832023-01-11 14:50:10 +01005639 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5640 dhm_p, sizeof(dhm_p),
5641 dhm_g, sizeof(dhm_g))) != 0) {
5642 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005643 }
5644 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005645#endif
5646
Ronald Cron6f135e12021-12-08 16:57:54 +01005647#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005648
5649#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005650 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005651#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005652 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005653#endif
5654#endif /* MBEDTLS_SSL_EARLY_DATA */
5655
Jerry Yud0766ec2022-09-22 10:46:57 +08005656#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005657 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005659#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005660 /*
5661 * Allow all TLS 1.3 key exchange modes by default.
5662 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005663 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005664#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005665
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005667#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005668 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005669 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005670#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005672#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005674#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005675 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5676 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005677#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5678 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5679 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5680#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5681 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5682 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5683#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005685#endif
5686 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005687
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005688 /*
5689 * Preset-specific defaults
5690 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005692 /*
5693 * NSA Suite B
5694 */
5695 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005696
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005697 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005698
5699#if defined(MBEDTLS_X509_CRT_PARSE_C)
5700 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005701#endif
5702
Ronald Crone68ab4f2022-10-05 12:46:29 +02005703#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005704#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005705 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005706 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005708#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005710#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005711
Brett Warrene0edc842021-08-17 09:53:13 +01005712 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005713 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005714
5715 /*
5716 * Default
5717 */
5718 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005719
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005720 conf->ciphersuite_list = mbedtls_ssl_list_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_default;
5724#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_default_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_default_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_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005736
5737#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5738 conf->dhm_min_bitlen = 1024;
5739#endif
5740 }
5741
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005743}
5744
5745/*
5746 * Free mbedtls_ssl_config
5747 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005748void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005749{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005750 if (conf == NULL) {
5751 return;
5752 }
5753
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005754#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 mbedtls_mpi_free(&conf->dhm_P);
5756 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005757#endif
5758
Ronald Cron73fe8df2022-10-05 14:31:43 +02005759#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005761 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5762 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005763 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005764 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005765 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005766 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005767 }
5768
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005770 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005771 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005772 conf->psk_identity_len = 0;
5773 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005774#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005775
5776#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005777 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005778#endif
5779
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005781}
5782
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005783#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005784 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005785/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005786 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005787 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005788unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005789{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005790#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5792 return MBEDTLS_SSL_SIG_RSA;
5793 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005794#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005795#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005796 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5797 return MBEDTLS_SSL_SIG_ECDSA;
5798 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005799#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005801}
5802
Gilles Peskine449bd832023-01-11 14:50:10 +01005803unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005804{
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005806 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005807 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005808 case MBEDTLS_PK_ECDSA:
5809 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005811 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005813 }
5814}
5815
Gilles Peskine449bd832023-01-11 14:50:10 +01005816mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005817{
Gilles Peskine449bd832023-01-11 14:50:10 +01005818 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005819#if defined(MBEDTLS_RSA_C)
5820 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005822#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005823#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005824 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005826#endif
5827 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005829 }
5830}
Valerio Settie9646ec2023-08-02 20:02:28 +02005831#endif /* MBEDTLS_PK_C &&
5832 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005833
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005834/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005835 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005836 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005837mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005838{
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005840#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005841 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005842 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005843#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005844#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005845 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005847#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005848#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005849 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005851#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005852#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005853 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005855#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005856#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005857 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005858 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005859#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005860#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005861 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005863#endif
5864 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005866 }
5867}
5868
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005869/*
5870 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5871 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005872unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005873{
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005875#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005876 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005877 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005878#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005879#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005880 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005881 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005882#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005883#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005884 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005886#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005887#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005888 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005890#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005891#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005892 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005894#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005895#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005896 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005898#endif
5899 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005901 }
5902}
5903
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005904/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005905 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005906 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005907 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005908int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005909{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005910 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005911
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 if (group_list == NULL) {
5913 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005914 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005915
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 for (; *group_list != 0; group_list++) {
5917 if (*group_list == tls_id) {
5918 return 0;
5919 }
5920 }
5921
5922 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005923}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005924
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005925#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005926/*
5927 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5928 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005929int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005930{
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005932
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005934 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005935 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005936
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005938}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005939#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005940
Valerio Setti18c9fed2022-12-30 17:44:24 +01005941static const struct {
5942 uint16_t tls_id;
5943 mbedtls_ecp_group_id ecp_group_id;
5944 psa_ecc_family_t psa_family;
5945 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005946} tls_id_match_table[] =
5947{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005948#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005949 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005950#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005951#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005952 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005953#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005954#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005955 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005956#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005957#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005958 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005959#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005960#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005961 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005962#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005963#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005964 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005965#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005966#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005967 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005968#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005969#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005970 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005971#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005972#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005973 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005974#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005975#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005976 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005977#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005978#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005979 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005980#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005981#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005982 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005983#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005984 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005985};
5986
Gilles Peskine449bd832023-01-11 14:50:10 +01005987int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005988 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005990{
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5992 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005993 if (type != NULL) {
5994 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 }
5996 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005997 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005999 return PSA_SUCCESS;
6000 }
6001 }
6002
6003 return PSA_ERROR_NOT_SUPPORTED;
6004}
6005
Gilles Peskine449bd832023-01-11 14:50:10 +01006006mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006007{
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6009 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006010 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006012 }
6013
6014 return MBEDTLS_ECP_DP_NONE;
6015}
6016
Gilles Peskine449bd832023-01-11 14:50:10 +01006017uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006018{
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6020 i++) {
6021 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006022 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006024 }
6025
6026 return 0;
6027}
6028
Valerio Setti67419f02023-01-04 16:12:42 +01006029#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006030static const struct {
6031 uint16_t tls_id;
6032 const char *name;
6033} tls_id_curve_name_table[] =
6034{
Valerio Setti54e23792023-07-07 10:49:27 +02006035 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6036 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6037 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6038 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6039 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6040 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6041 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6042 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6043 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6044 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6045 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6046 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6047 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006048 { 0, NULL },
6049};
6050
Gilles Peskine449bd832023-01-11 14:50:10 +01006051const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006052{
Valerio Settiacd32c02023-06-29 18:06:29 +02006053 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6054 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6055 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006057 }
6058
6059 return NULL;
6060}
Valerio Setti67419f02023-01-04 16:12:42 +01006061#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006062
Gilles Peskine449bd832023-01-11 14:50:10 +01006063int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6064 const mbedtls_md_type_t md,
6065 unsigned char *dst,
6066 size_t dst_len,
6067 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006068{
Ronald Cronf6893e12022-01-07 22:09:01 +01006069 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6070 psa_hash_operation_t *hash_operation_to_clone;
6071 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6072
Jerry Yu148165c2021-09-24 23:20:59 +08006073 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006074
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006076#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 case MBEDTLS_MD_SHA384:
6078 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6079 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006080#endif
6081
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006082#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 case MBEDTLS_MD_SHA256:
6084 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6085 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006086#endif
6087
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 default:
6089 goto exit;
6090 }
6091
6092 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6093 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006094 goto exit;
6095 }
6096
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6098 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006099 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006101
6102exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006103#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006104 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006105 (void) ssl;
6106#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006107 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006108}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006109
Ronald Crone68ab4f2022-10-05 12:46:29 +02006110#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006111/* mbedtls_ssl_parse_sig_alg_ext()
6112 *
6113 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6114 * value (TLS 1.3 RFC8446):
6115 * enum {
6116 * ....
6117 * ecdsa_secp256r1_sha256( 0x0403 ),
6118 * ecdsa_secp384r1_sha384( 0x0503 ),
6119 * ecdsa_secp521r1_sha512( 0x0603 ),
6120 * ....
6121 * } SignatureScheme;
6122 *
6123 * struct {
6124 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6125 * } SignatureSchemeList;
6126 *
6127 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6128 * value (TLS 1.2 RFC5246):
6129 * enum {
6130 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6131 * sha512(6), (255)
6132 * } HashAlgorithm;
6133 *
6134 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6135 * SignatureAlgorithm;
6136 *
6137 * struct {
6138 * HashAlgorithm hash;
6139 * SignatureAlgorithm signature;
6140 * } SignatureAndHashAlgorithm;
6141 *
6142 * SignatureAndHashAlgorithm
6143 * supported_signature_algorithms<2..2^16-2>;
6144 *
6145 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6146 * generalization of the TLS 1.2 signature algorithm extension.
6147 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6148 * `SignatureScheme` field of TLS 1.3
6149 *
6150 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006151int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6152 const unsigned char *buf,
6153 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006154{
6155 const unsigned char *p = buf;
6156 size_t supported_sig_algs_len = 0;
6157 const unsigned char *supported_sig_algs_end;
6158 uint16_t sig_alg;
6159 uint32_t common_idx = 0;
6160
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6162 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006163 p += 2;
6164
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 memset(ssl->handshake->received_sig_algs, 0,
6166 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006167
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006169 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 while (p < supported_sig_algs_end) {
6171 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6172 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006173 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6175 sig_alg,
6176 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006177#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6179 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6180 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006181 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006182 }
6183#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006184
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6186 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006187
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006189 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6190 common_idx += 1;
6191 }
6192 }
6193 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 if (p != end) {
6195 MBEDTLS_SSL_DEBUG_MSG(1,
6196 ("Signature algorithms extension length misaligned"));
6197 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6198 MBEDTLS_ERR_SSL_DECODE_ERROR);
6199 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006200 }
6201
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 if (common_idx == 0) {
6203 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6204 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6205 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6206 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006207 }
6208
Gabor Mezei15b95a62022-05-09 16:37:58 +02006209 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006211}
6212
Ronald Crone68ab4f2022-10-05 12:46:29 +02006213#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006214
Jerry Yudc7bd172022-02-17 13:44:15 +08006215#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6216
Jerry Yudc7bd172022-02-17 13:44:15 +08006217
Gilles Peskine449bd832023-01-11 14:50:10 +01006218static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6219 mbedtls_svc_key_id_t key,
6220 psa_algorithm_t alg,
6221 const unsigned char *raw_psk, size_t raw_psk_length,
6222 const unsigned char *seed, size_t seed_length,
6223 const unsigned char *label, size_t label_length,
6224 const unsigned char *other_secret,
6225 size_t other_secret_length,
6226 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006227{
6228 psa_status_t status;
6229
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 status = psa_key_derivation_setup(derivation, alg);
6231 if (status != PSA_SUCCESS) {
6232 return status;
6233 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006234
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6236 status = psa_key_derivation_input_bytes(derivation,
6237 PSA_KEY_DERIVATION_INPUT_SEED,
6238 seed, seed_length);
6239 if (status != PSA_SUCCESS) {
6240 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006241 }
6242
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 if (other_secret != NULL) {
6244 status = psa_key_derivation_input_bytes(derivation,
6245 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6246 other_secret, other_secret_length);
6247 if (status != PSA_SUCCESS) {
6248 return status;
6249 }
6250 }
6251
6252 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006253 status = psa_key_derivation_input_bytes(
6254 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 raw_psk, raw_psk_length);
6256 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006257 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006259 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 if (status != PSA_SUCCESS) {
6261 return status;
6262 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006263
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 status = psa_key_derivation_input_bytes(derivation,
6265 PSA_KEY_DERIVATION_INPUT_LABEL,
6266 label, label_length);
6267 if (status != PSA_SUCCESS) {
6268 return status;
6269 }
6270 } else {
6271 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006272 }
6273
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 status = psa_key_derivation_set_capacity(derivation, capacity);
6275 if (status != PSA_SUCCESS) {
6276 return status;
6277 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006278
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006280}
6281
Andrzej Kurek57d10632022-10-24 10:32:01 -04006282#if defined(PSA_WANT_ALG_SHA_384) || \
6283 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006284MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006285static int tls_prf_generic(mbedtls_md_type_t md_type,
6286 const unsigned char *secret, size_t slen,
6287 const char *label,
6288 const unsigned char *random, size_t rlen,
6289 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006290{
6291 psa_status_t status;
6292 psa_algorithm_t alg;
6293 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6294 psa_key_derivation_operation_t derivation =
6295 PSA_KEY_DERIVATION_OPERATION_INIT;
6296
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006298 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006300 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006302
6303 /* Normally a "secret" should be long enough to be impossible to
6304 * find by brute force, and in particular should not be empty. But
6305 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6306 * and for this use case it makes sense to have a 0-length "secret".
6307 * Since the key API doesn't allow importing a key of length 0,
6308 * keep master_key=0, which setup_psa_key_derivation() understands
6309 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006311 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6313 psa_set_key_algorithm(&key_attributes, alg);
6314 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006315
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6317 if (status != PSA_SUCCESS) {
6318 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6319 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006320 }
6321
Gilles Peskine449bd832023-01-11 14:50:10 +01006322 status = setup_psa_key_derivation(&derivation,
6323 master_key, alg,
6324 NULL, 0,
6325 random, rlen,
6326 (unsigned char const *) label,
6327 (size_t) strlen(label),
6328 NULL, 0,
6329 dlen);
6330 if (status != PSA_SUCCESS) {
6331 psa_key_derivation_abort(&derivation);
6332 psa_destroy_key(master_key);
6333 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006334 }
6335
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6337 if (status != PSA_SUCCESS) {
6338 psa_key_derivation_abort(&derivation);
6339 psa_destroy_key(master_key);
6340 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006341 }
6342
Gilles Peskine449bd832023-01-11 14:50:10 +01006343 status = psa_key_derivation_abort(&derivation);
6344 if (status != PSA_SUCCESS) {
6345 psa_destroy_key(master_key);
6346 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006347 }
6348
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 if (!mbedtls_svc_key_id_is_null(master_key)) {
6350 status = psa_destroy_key(master_key);
6351 }
6352 if (status != PSA_SUCCESS) {
6353 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6354 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006355
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006357}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006358#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006359
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006360#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006361MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006362static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6363 const char *label,
6364 const unsigned char *random, size_t rlen,
6365 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006366{
Gilles Peskine449bd832023-01-11 14:50:10 +01006367 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6368 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006369}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006370#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006371
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006372#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006373MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006374static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6375 const char *label,
6376 const unsigned char *random, size_t rlen,
6377 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006378{
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6380 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006381}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006382#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006383
Jerry Yuf009d862022-02-17 14:01:37 +08006384/*
6385 * Set appropriate PRF function and other SSL / TLS1.2 functions
6386 *
6387 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006388 * - hash associated with the ciphersuite (only used by TLS 1.2)
6389 *
6390 * Outputs:
6391 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6392 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006393MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006394static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6395 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006396{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006397#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006398 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006399 handshake->tls_prf = tls_prf_sha384;
6400 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6401 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006403#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006404#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006405 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006406 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006407 handshake->tls_prf = tls_prf_sha256;
6408 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6409 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6410 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006411#else
Jerry Yuf009d862022-02-17 14:01:37 +08006412 {
Jerry Yuf009d862022-02-17 14:01:37 +08006413 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006414 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006416 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006417#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006418
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006420}
Jerry Yud6ab2352022-02-17 14:03:43 +08006421
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006422/*
6423 * Compute master secret if needed
6424 *
6425 * Parameters:
6426 * [in/out] handshake
6427 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6428 * (PSA-PSK) ciphersuite_info, psk_opaque
6429 * [out] premaster (cleared)
6430 * [out] master
6431 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6432 * debug: conf->f_dbg, conf->p_dbg
6433 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006434 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006435 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006436MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006437static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6438 unsigned char *master,
6439 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006440{
6441 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6442
6443 /* cf. RFC 5246, Section 8.1:
6444 * "The master secret is always exactly 48 bytes in length." */
6445 size_t const master_secret_len = 48;
6446
6447#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6448 unsigned char session_hash[48];
6449#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6450
6451 /* The label for the KDF used for key expansion.
6452 * This is either "master secret" or "extended master secret"
6453 * depending on whether the Extended Master Secret extension
6454 * is used. */
6455 char const *lbl = "master secret";
6456
Przemek Stekielae4ed302022-04-05 17:15:55 +02006457 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006458 * - If the Extended Master Secret extension is not used,
6459 * this is ClientHello.Random + ServerHello.Random
6460 * (see Sect. 8.1 in RFC 5246).
6461 * - If the Extended Master Secret extension is used,
6462 * this is the transcript of the handshake so far.
6463 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006464 unsigned char const *seed = handshake->randbytes;
6465 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006466
6467#if !defined(MBEDTLS_DEBUG_C) && \
6468 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006469 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006470 ssl = NULL; /* make sure we don't use it except for those cases */
6471 (void) ssl;
6472#endif
6473
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 if (handshake->resume != 0) {
6475 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6476 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006477 }
6478
6479#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006481 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006482 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006483 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6484 if (ret != 0) {
6485 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6486 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006487
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6489 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006490 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006491#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006492
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006493#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006495 /* Perform PSK-to-MS expansion in a single step. */
6496 psa_status_t status;
6497 psa_algorithm_t alg;
6498 mbedtls_svc_key_id_t psk;
6499 psa_key_derivation_operation_t derivation =
6500 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006501 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006502
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006504
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006506
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006508 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006510 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006512
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006513 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006515
Gilles Peskine449bd832023-01-11 14:50:10 +01006516 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006517 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006518 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006519 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006520 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006521 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6522 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6523 other_secret = handshake->premaster + 2;
6524 break;
6525 default:
6526 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006527 }
6528
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 status = setup_psa_key_derivation(&derivation, psk, alg,
6530 ssl->conf->psk, ssl->conf->psk_len,
6531 seed, seed_len,
6532 (unsigned char const *) lbl,
6533 (size_t) strlen(lbl),
6534 other_secret, other_secret_len,
6535 master_secret_len);
6536 if (status != PSA_SUCCESS) {
6537 psa_key_derivation_abort(&derivation);
6538 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006539 }
6540
Gilles Peskine449bd832023-01-11 14:50:10 +01006541 status = psa_key_derivation_output_bytes(&derivation,
6542 master,
6543 master_secret_len);
6544 if (status != PSA_SUCCESS) {
6545 psa_key_derivation_abort(&derivation);
6546 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006547 }
6548
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 status = psa_key_derivation_abort(&derivation);
6550 if (status != PSA_SUCCESS) {
6551 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6552 }
6553 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006554#endif
6555 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006556#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006558 psa_status_t status;
6559 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6560 psa_key_derivation_operation_t derivation =
6561 PSA_KEY_DERIVATION_OPERATION_INIT;
6562
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006564
6565 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6566
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 status = psa_key_derivation_setup(&derivation, alg);
6568 if (status != PSA_SUCCESS) {
6569 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006570 }
6571
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 status = psa_key_derivation_set_capacity(&derivation,
6573 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6574 if (status != PSA_SUCCESS) {
6575 psa_key_derivation_abort(&derivation);
6576 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006577 }
6578
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6580 &derivation);
6581 if (status != PSA_SUCCESS) {
6582 psa_key_derivation_abort(&derivation);
6583 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006584 }
6585
Gilles Peskine449bd832023-01-11 14:50:10 +01006586 status = psa_key_derivation_output_bytes(&derivation,
6587 handshake->premaster,
6588 handshake->pmslen);
6589 if (status != PSA_SUCCESS) {
6590 psa_key_derivation_abort(&derivation);
6591 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6592 }
6593
6594 status = psa_key_derivation_abort(&derivation);
6595 if (status != PSA_SUCCESS) {
6596 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006597 }
6598 }
6599#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6601 lbl, seed, seed_len,
6602 master,
6603 master_secret_len);
6604 if (ret != 0) {
6605 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6606 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006607 }
6608
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6610 handshake->premaster,
6611 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006612
Gilles Peskine449bd832023-01-11 14:50:10 +01006613 mbedtls_platform_zeroize(handshake->premaster,
6614 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006615 }
6616
Gilles Peskine449bd832023-01-11 14:50:10 +01006617 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006618}
6619
Gilles Peskine449bd832023-01-11 14:50:10 +01006620int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006621{
6622 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6623 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6624 ssl->handshake->ciphersuite_info;
6625
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006627
6628 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006630 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006631 if (ret != 0) {
6632 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6633 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006634 }
6635
6636 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006637 ret = ssl_compute_master(ssl->handshake,
6638 ssl->session_negotiate->master,
6639 ssl);
6640 if (ret != 0) {
6641 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6642 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006643 }
6644
6645 /* Swap the client and server random values:
6646 * - MS derivation wanted client+server (RFC 5246 8.1)
6647 * - key derivation wants server+client (RFC 5246 6.3) */
6648 {
6649 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006650 memcpy(tmp, ssl->handshake->randbytes, 64);
6651 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6652 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6653 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006654 }
6655
6656 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006657 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6658 ssl->session_negotiate->ciphersuite,
6659 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006660#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006661 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006662#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 ssl->handshake->tls_prf,
6664 ssl->handshake->randbytes,
6665 ssl->tls_version,
6666 ssl->conf->endpoint,
6667 ssl);
6668 if (ret != 0) {
6669 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6670 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006671 }
6672
6673 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6675 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006676
Gilles Peskine449bd832023-01-11 14:50:10 +01006677 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006678
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006680}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006681
Gilles Peskine449bd832023-01-11 14:50:10 +01006682int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006683{
Gilles Peskine449bd832023-01-11 14:50:10 +01006684 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006685#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006686 case MBEDTLS_SSL_HASH_SHA384:
6687 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6688 break;
6689#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006690#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006691 case MBEDTLS_SSL_HASH_SHA256:
6692 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6693 break;
6694#endif
6695 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006696 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006697 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006698#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006699 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006700 (void) ssl;
6701#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006703}
6704
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006705static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6706 const psa_hash_operation_t *hs_op,
6707 size_t buffer_size,
6708 unsigned char *hash,
6709 size_t *hlen)
6710{
6711 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006712 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006713
6714#if !defined(MBEDTLS_DEBUG_C)
6715 (void) ssl;
6716#endif
6717 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006718 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006719 if (status != PSA_SUCCESS) {
6720 goto exit;
6721 }
6722
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006723 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006724 if (status != PSA_SUCCESS) {
6725 goto exit;
6726 }
6727
6728 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6729 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6730
6731exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006732 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006733 return mbedtls_md_error_from_psa(status);
6734}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006735
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006736#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006737int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6738 unsigned char *hash,
6739 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006740{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006741 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6742 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006743}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006744#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006745
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006746#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006747int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6748 unsigned char *hash,
6749 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006750{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006751 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6752 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006753}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006754#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006755
Jerry Yuc2c673d2022-02-17 14:20:39 +08006756#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006757MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006758static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006759
6760#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006761int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006762{
6763 /* If renegotiation is not enforced, retransmit until we would reach max
6764 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006766 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6767 unsigned char doublings = 1;
6768
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006770 ++doublings;
6771 ratio >>= 1;
6772 }
6773
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 if (++ssl->renego_records_seen > doublings) {
6775 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6776 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006777 }
6778 }
6779
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006781}
6782#endif
6783#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006784
Jerry Yud9526692022-02-17 14:23:47 +08006785/*
6786 * Handshake functions
6787 */
6788#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6789/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006790int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006791{
6792 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6793 ssl->handshake->ciphersuite_info;
6794
Gilles Peskine449bd832023-01-11 14:50:10 +01006795 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006796
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6798 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006799 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006801 }
6802
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6804 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006805}
6806
Gilles Peskine449bd832023-01-11 14:50:10 +01006807int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006808{
6809 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6810 ssl->handshake->ciphersuite_info;
6811
Gilles Peskine449bd832023-01-11 14:50:10 +01006812 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006813
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6815 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006816 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006817 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006818 }
6819
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6821 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006822}
6823
6824#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6825/* Some certificate support -> implement write and parse */
6826
Gilles Peskine449bd832023-01-11 14:50:10 +01006827int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006828{
6829 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6830 size_t i, n;
6831 const mbedtls_x509_crt *crt;
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, ("=> write 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 write 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
6843#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006844 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6845 if (ssl->handshake->client_auth == 0) {
6846 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006847 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006848 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006849 }
6850 }
6851#endif /* MBEDTLS_SSL_CLI_C */
6852#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006853 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6854 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006855 /* Should never happen because we shouldn't have picked the
6856 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006858 }
6859 }
6860#endif
6861
Gilles Peskine449bd832023-01-11 14:50:10 +01006862 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006863
6864 /*
6865 * 0 . 0 handshake type
6866 * 1 . 3 handshake length
6867 * 4 . 6 length of all certs
6868 * 7 . 9 length of cert. 1
6869 * 10 . n-1 peer certificate
6870 * n . n+2 length of cert. 2
6871 * n+3 . ... upper level cert, etc.
6872 */
6873 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006875
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006877 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6879 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6880 " > %" MBEDTLS_PRINTF_SIZET,
6881 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6882 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006883 }
6884
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6886 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6887 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006888
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006890 i += n; crt = crt->next;
6891 }
6892
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6894 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6895 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006896
6897 ssl->out_msglen = i;
6898 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6899 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6900
6901 ssl->state++;
6902
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6904 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6905 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006906 }
6907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006911}
6912
6913#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6914
6915#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006916MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006917static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6918 unsigned char *crt_buf,
6919 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006920{
6921 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6922
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 if (peer_crt == NULL) {
6924 return -1;
6925 }
Jerry Yud9526692022-02-17 14:23:47 +08006926
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 if (peer_crt->raw.len != crt_buf_len) {
6928 return -1;
6929 }
Jerry Yud9526692022-02-17 14:23:47 +08006930
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006932}
6933#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006934MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006935static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6936 unsigned char *crt_buf,
6937 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006938{
6939 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6940 unsigned char const * const peer_cert_digest =
6941 ssl->session->peer_cert_digest;
6942 mbedtls_md_type_t const peer_cert_digest_type =
6943 ssl->session->peer_cert_digest_type;
6944 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006946 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6947 size_t digest_len;
6948
Gilles Peskine449bd832023-01-11 14:50:10 +01006949 if (peer_cert_digest == NULL || digest_info == NULL) {
6950 return -1;
6951 }
Jerry Yud9526692022-02-17 14:23:47 +08006952
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 digest_len = mbedtls_md_get_size(digest_info);
6954 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6955 return -1;
6956 }
Jerry Yud9526692022-02-17 14:23:47 +08006957
Gilles Peskine449bd832023-01-11 14:50:10 +01006958 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6959 if (ret != 0) {
6960 return -1;
6961 }
Jerry Yud9526692022-02-17 14:23:47 +08006962
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006964}
6965#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6966#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6967
6968/*
6969 * Once the certificate message is read, parse it into a cert chain and
6970 * perform basic checks, but leave actual verification to the caller
6971 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006972MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006973static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6974 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006975{
6976 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6977#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006978 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006979#endif
6980 size_t i, n;
6981 uint8_t alert;
6982
Gilles Peskine449bd832023-01-11 14:50:10 +01006983 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6984 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6985 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6986 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6987 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006988 }
6989
Gilles Peskine449bd832023-01-11 14:50:10 +01006990 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6991 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6992 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6993 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006994 }
6995
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6997 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6998 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6999 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7000 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007001 }
7002
Gilles Peskine449bd832023-01-11 14:50:10 +01007003 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007004
7005 /*
7006 * Same message structure as in mbedtls_ssl_write_certificate()
7007 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007008 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007009
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 if (ssl->in_msg[i] != 0 ||
7011 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7012 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7013 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7014 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7015 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007016 }
7017
7018 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7019 i += 3;
7020
7021 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007023 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007024 if (i + 3 > ssl->in_hslen) {
7025 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7026 mbedtls_ssl_send_alert_message(ssl,
7027 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7028 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7029 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007030 }
7031 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7032 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 if (ssl->in_msg[i] != 0) {
7034 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7035 mbedtls_ssl_send_alert_message(ssl,
7036 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7037 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7038 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007039 }
7040
7041 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007042 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007043 i += 3;
7044
Gilles Peskine449bd832023-01-11 14:50:10 +01007045 if (n < 128 || i + n > ssl->in_hslen) {
7046 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7047 mbedtls_ssl_send_alert_message(ssl,
7048 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7049 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7050 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007051 }
7052
7053 /* Check if we're handling the first CRT in the chain. */
7054#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007056 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007058 /* During client-side renegotiation, check that the server's
7059 * end-CRTs hasn't changed compared to the initial handshake,
7060 * mitigating the triple handshake attack. On success, reuse
7061 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7063 if (ssl_check_peer_crt_unchanged(ssl,
7064 &ssl->in_msg[i],
7065 n) != 0) {
7066 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7067 mbedtls_ssl_send_alert_message(ssl,
7068 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7069 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7070 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007071 }
7072
7073 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007075 }
7076#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7077
7078 /* Parse the next certificate in the chain. */
7079#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007081#else
7082 /* If we don't need to store the CRT chain permanently, parse
7083 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007085#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007086 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007087 case 0: /*ok*/
7088 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7089 /* Ignore certificate with an unknown algorithm: maybe a
7090 prior certificate was already trusted. */
7091 break;
7092
7093 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7094 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7095 goto crt_parse_der_failed;
7096
7097 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7098 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7099 goto crt_parse_der_failed;
7100
7101 default:
7102 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007103crt_parse_der_failed:
7104 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7105 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7106 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007107 }
7108
7109 i += n;
7110 }
7111
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7113 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007114}
7115
7116#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007117MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007118static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007119{
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7121 return -1;
7122 }
Jerry Yud9526692022-02-17 14:23:47 +08007123
Gilles Peskine449bd832023-01-11 14:50:10 +01007124 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007125 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7126 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7128 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7129 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007130 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007132}
7133#endif /* MBEDTLS_SSL_SRV_C */
7134
7135/* Check if a certificate message is expected.
7136 * Return either
7137 * - SSL_CERTIFICATE_EXPECTED, or
7138 * - SSL_CERTIFICATE_SKIP
7139 * indicating whether a Certificate message is expected or not.
7140 */
7141#define SSL_CERTIFICATE_EXPECTED 0
7142#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007143MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007144static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7145 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007146{
7147 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7148 ssl->handshake->ciphersuite_info;
7149
Gilles Peskine449bd832023-01-11 14:50:10 +01007150 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7151 return SSL_CERTIFICATE_SKIP;
7152 }
Jerry Yud9526692022-02-17 14:23:47 +08007153
7154#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007157 ssl->session_negotiate->verify_result =
7158 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007160 }
7161 }
7162#else
7163 ((void) authmode);
7164#endif /* MBEDTLS_SSL_SRV_C */
7165
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007167}
7168
Jerry Yud9526692022-02-17 14:23:47 +08007169#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007170MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007171static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7172 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007173{
7174 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7175 /* Remember digest of the peer's end-CRT. */
7176 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007177 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7178 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7179 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7180 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7181 mbedtls_ssl_send_alert_message(ssl,
7182 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7183 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007184
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007186 }
7187
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 ret = mbedtls_md(mbedtls_md_info_from_type(
7189 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7190 start, len,
7191 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007192
7193 ssl->session_negotiate->peer_cert_digest_type =
7194 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7195 ssl->session_negotiate->peer_cert_digest_len =
7196 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7197
Gilles Peskine449bd832023-01-11 14:50:10 +01007198 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007199}
7200
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007201MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007202static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7203 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007204{
7205 unsigned char *end = start + len;
7206 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7207
7208 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7210 ret = mbedtls_pk_parse_subpubkey(&start, end,
7211 &ssl->handshake->peer_pubkey);
7212 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007213 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007215 }
7216
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007218}
7219#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7220
Gilles Peskine449bd832023-01-11 14:50:10 +01007221int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007222{
7223 int ret = 0;
7224 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007225 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007226#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7227 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7228 ? ssl->handshake->sni_authmode
7229 : ssl->conf->authmode;
7230#else
7231 const int authmode = ssl->conf->authmode;
7232#endif
7233 void *rs_ctx = NULL;
7234 mbedtls_x509_crt *chain = NULL;
7235
Gilles Peskine449bd832023-01-11 14:50:10 +01007236 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007237
Gilles Peskine449bd832023-01-11 14:50:10 +01007238 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7239 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7240 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007241 goto exit;
7242 }
7243
7244#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 if (ssl->handshake->ecrs_enabled &&
7246 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007247 chain = ssl->handshake->ecrs_peer_cert;
7248 ssl->handshake->ecrs_peer_cert = NULL;
7249 goto crt_verify;
7250 }
7251#endif
7252
Gilles Peskine449bd832023-01-11 14:50:10 +01007253 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007254 /* mbedtls_ssl_read_record may have sent an alert already. We
7255 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007256 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007257 goto exit;
7258 }
7259
7260#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007262 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7263
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007265 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007266 }
Jerry Yud9526692022-02-17 14:23:47 +08007267
7268 goto exit;
7269 }
7270#endif /* MBEDTLS_SSL_SRV_C */
7271
7272 /* Clear existing peer CRT structure in case we tried to
7273 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007274 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007275
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7277 if (chain == NULL) {
7278 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7279 sizeof(mbedtls_x509_crt)));
7280 mbedtls_ssl_send_alert_message(ssl,
7281 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7282 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007283
7284 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7285 goto exit;
7286 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007288
Gilles Peskine449bd832023-01-11 14:50:10 +01007289 ret = ssl_parse_certificate_chain(ssl, chain);
7290 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007291 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007292 }
Jerry Yud9526692022-02-17 14:23:47 +08007293
7294#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007295 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007296 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 }
Jerry Yud9526692022-02-17 14:23:47 +08007298
7299crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007300 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007301 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 }
Jerry Yud9526692022-02-17 14:23:47 +08007303#endif
7304
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007305 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7306 ssl->handshake->ciphersuite_info,
7307 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007308 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007309 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007310 }
Jerry Yud9526692022-02-17 14:23:47 +08007311
7312#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7313 {
7314 unsigned char *crt_start, *pk_start;
7315 size_t crt_len, pk_len;
7316
7317 /* We parse the CRT chain without copying, so
7318 * these pointers point into the input buffer,
7319 * and are hence still valid after freeing the
7320 * CRT chain. */
7321
7322 crt_start = chain->raw.p;
7323 crt_len = chain->raw.len;
7324
7325 pk_start = chain->pk_raw.p;
7326 pk_len = chain->pk_raw.len;
7327
7328 /* Free the CRT structures before computing
7329 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007330 mbedtls_x509_crt_free(chain);
7331 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007332 chain = NULL;
7333
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7335 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007336 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007337 }
Jerry Yud9526692022-02-17 14:23:47 +08007338
Gilles Peskine449bd832023-01-11 14:50:10 +01007339 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7340 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007341 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007342 }
Jerry Yud9526692022-02-17 14:23:47 +08007343 }
7344#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7345 /* Pass ownership to session structure. */
7346 ssl->session_negotiate->peer_cert = chain;
7347 chain = NULL;
7348#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7349
Gilles Peskine449bd832023-01-11 14:50:10 +01007350 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007351
7352exit:
7353
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007355 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 }
Jerry Yud9526692022-02-17 14:23:47 +08007357
7358#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007359 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007360 ssl->handshake->ecrs_peer_cert = chain;
7361 chain = NULL;
7362 }
7363#endif
7364
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 if (chain != NULL) {
7366 mbedtls_x509_crt_free(chain);
7367 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007368 }
7369
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007371}
7372#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7373
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007374static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7375 unsigned char *padbuf, size_t hlen,
7376 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007377{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007378 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007379 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007380 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007381 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007382 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007383 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007384
7385 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007387 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007389
Gilles Peskine449bd832023-01-11 14:50:10 +01007390 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007391 ? "client finished"
7392 : "server finished";
7393
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007394 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007395
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007396 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007398 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007399 }
7400
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007401 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007402 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007403 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007404 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007405 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007406
7407 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7408
Jerry Yu615bd6f2022-02-17 14:25:15 +08007409 /*
7410 * TLSv1.2:
7411 * hash = PRF( master, finished_label,
7412 * Hash( handshake ) )[0.11]
7413 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007415 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007416
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007418
Paul Elliottecb95be2023-08-11 16:41:04 +01007419 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007420
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007421 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007422
7423exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007424 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007425 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007426}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007427
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007428#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007429static int ssl_calc_finished_tls_sha256(
7430 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7431{
7432 unsigned char padbuf[32];
7433 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007434 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007435 padbuf, sizeof(padbuf),
7436 buf, from);
7437}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007438#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007439
Jerry Yub7ba49e2022-02-17 14:25:53 +08007440
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007441#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007442static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007444{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007445 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007446 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007447 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007448 padbuf, sizeof(padbuf),
7449 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007450}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007451#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007452
Gilles Peskine449bd832023-01-11 14:50:10 +01007453void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007454{
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007456
7457 /*
7458 * Free our handshake params
7459 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 mbedtls_ssl_handshake_free(ssl);
7461 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007462 ssl->handshake = NULL;
7463
7464 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007465 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007466 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 if (ssl->transform) {
7468 mbedtls_ssl_transform_free(ssl->transform);
7469 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007470 }
7471 ssl->transform = ssl->transform_negotiate;
7472 ssl->transform_negotiate = NULL;
7473
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007475}
7476
Gilles Peskine449bd832023-01-11 14:50:10 +01007477void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007478{
7479 int resume = ssl->handshake->resume;
7480
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007482
7483#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007485 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7486 ssl->renego_records_seen = 0;
7487 }
7488#endif
7489
7490 /*
7491 * Free the previous session and switch in the current one
7492 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007494#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7495 /* RFC 7366 3.1: keep the EtM state */
7496 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007498#endif
7499
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 mbedtls_ssl_session_free(ssl->session);
7501 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007502 }
7503 ssl->session = ssl->session_negotiate;
7504 ssl->session_negotiate = NULL;
7505
7506 /*
7507 * Add cache entry
7508 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007510 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 resume == 0) {
7512 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7513 ssl->session->id,
7514 ssl->session->id_len,
7515 ssl->session) != 0) {
7516 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7517 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007518 }
7519
7520#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7522 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007523 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007524 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007525
7526 /* Keep last flight around in case we need to resend it:
7527 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7529 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007530#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007532
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007533 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007534
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007536}
7537
Gilles Peskine449bd832023-01-11 14:50:10 +01007538int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007539{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007540 int ret;
7541 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007542
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007544
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007546
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007547 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7548 if (ret != 0) {
7549 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7550 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007551
7552 /*
7553 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7554 * may define some other value. Currently (early 2016), no defined
7555 * ciphersuite does this (and this is unlikely to change as activity has
7556 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7557 */
7558 hash_len = 12;
7559
7560#if defined(MBEDTLS_SSL_RENEGOTIATION)
7561 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007563#endif
7564
7565 ssl->out_msglen = 4 + hash_len;
7566 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7567 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7568
7569 /*
7570 * In case of session resuming, invert the client and server
7571 * ChangeCipherSpec messages order.
7572 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007574#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007576 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007578#endif
7579#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007581 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007583#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007585 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007587
7588 /*
7589 * Switch to our negotiated transform and session parameters for outbound
7590 * data.
7591 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007593
7594#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007595 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007596 unsigned char i;
7597
7598 /* Remember current epoch settings for resending */
7599 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7601 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007602
7603 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007605
7606
7607 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 for (i = 2; i > 0; i--) {
7609 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007610 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 }
7612 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007613
7614 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 if (i == 0) {
7616 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7617 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007618 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007620#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007622
7623 ssl->transform_out = ssl->transform_negotiate;
7624 ssl->session_out = ssl->session_negotiate;
7625
7626#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7628 mbedtls_ssl_send_flight_completed(ssl);
7629 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007630#endif
7631
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7633 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7634 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007635 }
7636
7637#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7639 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7640 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7641 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007642 }
7643#endif
7644
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007646
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007648}
7649
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007650#define SSL_MAX_HASH_LEN 12
7651
Gilles Peskine449bd832023-01-11 14:50:10 +01007652int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007653{
7654 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7655 unsigned int hash_len = 12;
7656 unsigned char buf[SSL_MAX_HASH_LEN];
7657
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007659
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007660 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7661 if (ret != 0) {
7662 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7663 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007664
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7666 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007667 goto exit;
7668 }
7669
Gilles Peskine449bd832023-01-11 14:50:10 +01007670 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7671 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7672 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7673 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007674 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7675 goto exit;
7676 }
7677
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7679 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7680 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007681 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7682 goto exit;
7683 }
7684
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7686 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7687 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7688 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007689 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7690 goto exit;
7691 }
7692
Gilles Peskine449bd832023-01-11 14:50:10 +01007693 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7694 buf, hash_len) != 0) {
7695 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7696 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7697 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007698 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7699 goto exit;
7700 }
7701
7702#if defined(MBEDTLS_SSL_RENEGOTIATION)
7703 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007705#endif
7706
Gilles Peskine449bd832023-01-11 14:50:10 +01007707 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007708#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007710 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007711 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007712#endif
7713#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007715 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007717#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007719 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007720 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007721
7722#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7724 mbedtls_ssl_recv_flight_completed(ssl);
7725 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007726#endif
7727
Gilles Peskine449bd832023-01-11 14:50:10 +01007728 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007729
7730exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 mbedtls_platform_zeroize(buf, hash_len);
7732 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007733}
7734
Jerry Yu392112c2022-02-17 14:34:10 +08007735#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7736/*
7737 * Helper to get TLS 1.2 PRF from ciphersuite
7738 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7739 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007740static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007741{
Jerry Yu392112c2022-02-17 14:34:10 +08007742 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007744#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7746 return tls_prf_sha384;
7747 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007748#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007749#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007750 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007751 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7752 return tls_prf_sha256;
7753 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007754 }
7755#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007756#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007757 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007758 (void) ciphersuite_info;
7759#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007760
Gilles Peskine449bd832023-01-11 14:50:10 +01007761 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007762}
7763#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007764
Gilles Peskine449bd832023-01-11 14:50:10 +01007765static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007766{
7767 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007768#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007769 if (tls_prf == tls_prf_sha384) {
7770 return MBEDTLS_SSL_TLS_PRF_SHA384;
7771 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007772#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007773#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007774 if (tls_prf == tls_prf_sha256) {
7775 return MBEDTLS_SSL_TLS_PRF_SHA256;
7776 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007777#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007779}
7780
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007781/*
7782 * Populate a transform structure with session keys and all the other
7783 * necessary information.
7784 *
7785 * Parameters:
7786 * - [in/out]: transform: structure to populate
7787 * [in] must be just initialised with mbedtls_ssl_transform_init()
7788 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7789 * - [in] ciphersuite
7790 * - [in] master
7791 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007792 * - [in] tls_prf: pointer to PRF to use for key derivation
7793 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007794 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007795 * - [in] endpoint: client or server
7796 * - [in] ssl: used for:
7797 * - ssl->conf->{f,p}_export_keys
7798 * [in] optionally used for:
7799 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7800 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007801MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007802static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7803 int ciphersuite,
7804 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007805#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007807#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 ssl_tls_prf_t tls_prf,
7809 const unsigned char randbytes[64],
7810 mbedtls_ssl_protocol_version tls_version,
7811 unsigned endpoint,
7812 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007813{
7814 int ret = 0;
7815 unsigned char keyblk[256];
7816 unsigned char *key1;
7817 unsigned char *key2;
7818 unsigned char *mac_enc;
7819 unsigned char *mac_dec;
7820 size_t mac_key_len = 0;
7821 size_t iv_copy_len;
7822 size_t keylen;
7823 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007824 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007825
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007826 psa_key_type_t key_type;
7827 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7828 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007829 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007830 size_t key_bits;
7831 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007832
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007833 /*
7834 * Some data just needs copying into the structure
7835 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007836#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007837 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007838#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007839 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007840
7841#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007843#endif
7844
7845#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007846 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007847 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7848 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007849 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007850 }
7851#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7852
7853 /*
7854 * Get various info structures
7855 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007856 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7857 if (ciphersuite_info == NULL) {
7858 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7859 ciphersuite));
7860 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007861 }
7862
Neil Armstrongab555e02022-04-04 11:07:59 +02007863 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007864#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007865 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007866#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007868
Gilles Peskine449bd832023-01-11 14:50:10 +01007869 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007870 transform->taglen =
7871 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007873
Dave Rodgman2eab4622023-10-05 13:30:37 +01007874 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007875 transform->taglen,
7876 &alg,
7877 &key_type,
7878 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007879 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007881 goto end;
7882 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007883
Dave Rodgman2eab4622023-10-05 13:30:37 +01007884 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007886 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 (unsigned) ciphersuite_info->mac));
7888 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007889 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007890
7891#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7892 /* Copy own and peer's CID if the use of the CID
7893 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007894 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7895 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007896
7897 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7899 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7900 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007901
7902 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7904 ssl->handshake->peer_cid_len);
7905 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7906 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007907 }
7908#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7909
7910 /*
7911 * Compute key block using the PRF
7912 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7914 if (ret != 0) {
7915 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7916 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007917 }
7918
Gilles Peskine449bd832023-01-11 14:50:10 +01007919 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7920 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7921 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7922 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7923 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007924
7925 /*
7926 * Determine the appropriate key, IV and MAC length.
7927 */
7928
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007929 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007930
Valerio Settie5707042023-10-11 11:54:42 +02007931#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007932 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007933 size_t explicit_ivlen;
7934
7935 transform->maclen = 0;
7936 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007937
7938 /* All modes haves 96-bit IVs, but the length of the static parts vary
7939 * with mode and version:
7940 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7941 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7942 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7943 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7944 * sequence number).
7945 */
7946 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007947
7948 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007949 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007950
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007952 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007953 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007954 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007955 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007956
7957 /* Minimum length of encrypted record */
7958 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7959 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 } else
Valerio Settie5707042023-10-11 11:54:42 +02007961#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007962#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007964 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007967
Neil Armstronge4512952022-03-08 09:08:22 +01007968 /* Get MAC length */
7969 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007970 transform->maclen = mac_key_len;
7971
7972 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007974
7975 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007977 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007979 /*
7980 * GenericBlockCipher:
7981 * 1. if EtM is in use: one block plus MAC
7982 * otherwise: * first multiple of blocklen greater than maclen
7983 * 2. IV
7984 */
7985#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007987 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 + block_size;
7989 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007990#endif
7991 {
7992 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 + block_size
7994 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007995 }
7996
Gilles Peskine449bd832023-01-11 14:50:10 +01007997 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007998 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 } else {
8000 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008001 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8002 goto end;
8003 }
8004 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008006#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8007 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8009 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008010 }
8011
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8013 (unsigned) keylen,
8014 (unsigned) transform->minlen,
8015 (unsigned) transform->ivlen,
8016 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008017
8018 /*
8019 * Finally setup the cipher contexts, IVs and MAC secrets.
8020 */
8021#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008023 key1 = keyblk + mac_key_len * 2;
8024 key2 = keyblk + mac_key_len * 2 + keylen;
8025
8026 mac_enc = keyblk;
8027 mac_dec = keyblk + mac_key_len;
8028
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 iv_copy_len = (transform->fixed_ivlen) ?
8030 transform->fixed_ivlen : transform->ivlen;
8031 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8032 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8033 iv_copy_len);
8034 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008035#endif /* MBEDTLS_SSL_CLI_C */
8036#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008038 key1 = keyblk + mac_key_len * 2 + keylen;
8039 key2 = keyblk + mac_key_len * 2;
8040
8041 mac_enc = keyblk + mac_key_len;
8042 mac_dec = keyblk;
8043
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 iv_copy_len = (transform->fixed_ivlen) ?
8045 transform->fixed_ivlen : transform->ivlen;
8046 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8047 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8048 iv_copy_len);
8049 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008050#endif /* MBEDTLS_SSL_SRV_C */
8051 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008052 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008053 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8054 goto end;
8055 }
8056
Paul Elliott4fb19552023-10-18 12:15:30 +01008057 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008058 ssl->f_export_keys(ssl->p_export_keys,
8059 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8060 master, 48,
8061 randbytes + 32,
8062 randbytes,
8063 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008064 }
8065
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008066 transform->psa_alg = alg;
8067
Gilles Peskine449bd832023-01-11 14:50:10 +01008068 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8069 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8070 psa_set_key_algorithm(&attributes, alg);
8071 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008072
Gilles Peskine449bd832023-01-11 14:50:10 +01008073 if ((status = psa_import_key(&attributes,
8074 key1,
8075 PSA_BITS_TO_BYTES(key_bits),
8076 &transform->psa_key_enc)) != PSA_SUCCESS) {
8077 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008078 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008080 goto end;
8081 }
8082
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008084
Gilles Peskine449bd832023-01-11 14:50:10 +01008085 if ((status = psa_import_key(&attributes,
8086 key2,
8087 PSA_BITS_TO_BYTES(key_bits),
8088 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008089 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008091 goto end;
8092 }
8093 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008094
Neil Armstrong29c0c042022-03-17 17:47:28 +01008095#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8096 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8097 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008100
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8102 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8103 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008104
Gilles Peskine449bd832023-01-11 14:50:10 +01008105 if ((status = psa_import_key(&attributes,
8106 mac_enc, mac_key_len,
8107 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008108 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008110 goto end;
8111 }
8112
Gilles Peskine449bd832023-01-11 14:50:10 +01008113 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8114 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008115#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008116 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008117#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008118 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008119 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8121 PSA_KEY_USAGE_VERIFY_HASH);
8122 } else {
8123 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8124 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008125
Gilles Peskine449bd832023-01-11 14:50:10 +01008126 if ((status = psa_import_key(&attributes,
8127 mac_dec, mac_key_len,
8128 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008129 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008130 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008131 goto end;
8132 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008133 }
8134#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8135
8136 ((void) mac_dec);
8137 ((void) mac_enc);
8138
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008139end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008140 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8141 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008142}
8143
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008144#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008145int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 psa_pake_operation_t *pake_ctx,
8147 const unsigned char *buf,
8148 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008149{
8150 psa_status_t status;
8151 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008152 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008153 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8154 * At round two perform a single cycle
8155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008156 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008157
Gilles Peskine449bd832023-01-11 14:50:10 +01008158 for (; remaining_steps > 0; remaining_steps--) {
8159 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008160 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008161 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008162 /* Length is stored at the first byte */
8163 size_t length = buf[input_offset];
8164 input_offset += 1;
8165
Gilles Peskine449bd832023-01-11 14:50:10 +01008166 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008167 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8168 }
8169
Gilles Peskine449bd832023-01-11 14:50:10 +01008170 status = psa_pake_input(pake_ctx, step,
8171 buf + input_offset, length);
8172 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008173 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008174 }
8175
8176 input_offset += length;
8177 }
8178 }
8179
Gilles Peskine449bd832023-01-11 14:50:10 +01008180 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008181 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008182 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008183
Gilles Peskine449bd832023-01-11 14:50:10 +01008184 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008185}
8186
Valerio Setti6b3dab02022-11-17 17:14:54 +01008187int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 psa_pake_operation_t *pake_ctx,
8189 unsigned char *buf,
8190 size_t len, size_t *olen,
8191 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008192{
8193 psa_status_t status;
8194 size_t output_offset = 0;
8195 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008196 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008197 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8198 * At round two perform a single cycle
8199 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008201
Gilles Peskine449bd832023-01-11 14:50:10 +01008202 for (; remaining_steps > 0; remaining_steps--) {
8203 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8204 step <= PSA_PAKE_STEP_ZK_PROOF;
8205 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008206 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008207 * For each step, prepend 1 byte with the length of the data as
8208 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008209 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 status = psa_pake_output(pake_ctx, step,
8211 buf + output_offset + 1,
8212 len - output_offset - 1,
8213 &output_len);
8214 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008215 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008216 }
8217
Valerio Setti99d88c12022-11-22 16:03:43 +01008218 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008219
8220 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008221 }
8222 }
8223
8224 *olen = output_offset;
8225
Gilles Peskine449bd832023-01-11 14:50:10 +01008226 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008227}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008228#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008229
Gilles Peskine449bd832023-01-11 14:50:10 +01008230int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8231 unsigned char *hash, size_t *hashlen,
8232 unsigned char *data, size_t data_len,
8233 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008234{
8235 psa_status_t status;
8236 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008237 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008238
Gilles Peskine449bd832023-01-11 14:50:10 +01008239 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008240
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 if ((status = psa_hash_setup(&hash_operation,
8242 hash_alg)) != PSA_SUCCESS) {
8243 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008244 goto exit;
8245 }
8246
Gilles Peskine449bd832023-01-11 14:50:10 +01008247 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8248 64)) != PSA_SUCCESS) {
8249 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008250 goto exit;
8251 }
8252
Gilles Peskine449bd832023-01-11 14:50:10 +01008253 if ((status = psa_hash_update(&hash_operation,
8254 data, data_len)) != PSA_SUCCESS) {
8255 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008256 goto exit;
8257 }
8258
Gilles Peskine449bd832023-01-11 14:50:10 +01008259 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8260 hashlen)) != PSA_SUCCESS) {
8261 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8262 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008263 }
8264
8265exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 if (status != PSA_SUCCESS) {
8267 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8268 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8269 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008270 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008272 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8273 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008274 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008275 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008276 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008277 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008278 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008279 }
8280 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008281 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008282}
8283
Jerry Yuee40f9d2022-02-17 14:55:16 +08008284
Jerry Yud9d91da2022-02-17 14:57:06 +08008285#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8286
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008287/* Find the preferred hash for a given signature algorithm. */
8288unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008289 mbedtls_ssl_context *ssl,
8290 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008291{
Gabor Mezei078e8032022-04-27 21:17:56 +02008292 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008293 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008294
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8296 return MBEDTLS_SSL_HASH_NONE;
8297 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008298
Gilles Peskine449bd832023-01-11 14:50:10 +01008299 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008300 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008301 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8302 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008303 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008304 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8305 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008306
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008307 mbedtls_md_type_t md_alg =
8308 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8309 if (md_alg == MBEDTLS_MD_NONE) {
8310 continue;
8311 }
8312
Gilles Peskine449bd832023-01-11 14:50:10 +01008313 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008314 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008315 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008316 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008317
Gilles Peskine449bd832023-01-11 14:50:10 +01008318 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8319 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8320 PSA_ALG_ECDSA(psa_hash_alg),
8321 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008322 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008323 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008324
Gilles Peskine449bd832023-01-11 14:50:10 +01008325 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8326 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8327 PSA_ALG_RSA_PKCS1V15_SIGN(
8328 psa_hash_alg),
8329 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008330 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008331 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008332 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008333
Gilles Peskine449bd832023-01-11 14:50:10 +01008334 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008335 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008336 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008337
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008339}
8340
8341#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8342
Jerry Yudc7bd172022-02-17 13:44:15 +08008343#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8344
XiaokangQian75d40ef2022-04-20 11:05:24 +00008345int mbedtls_ssl_validate_ciphersuite(
8346 const mbedtls_ssl_context *ssl,
8347 const mbedtls_ssl_ciphersuite_t *suite_info,
8348 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008349 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008350{
8351 (void) ssl;
8352
Gilles Peskine449bd832023-01-11 14:50:10 +01008353 if (suite_info == NULL) {
8354 return -1;
8355 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008356
Gilles Peskine449bd832023-01-11 14:50:10 +01008357 if ((suite_info->min_tls_version > max_tls_version) ||
8358 (suite_info->max_tls_version < min_tls_version)) {
8359 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008360 }
8361
XiaokangQian060d8672022-04-21 09:24:56 +00008362#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008363#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008364 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008365 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008366 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008367 }
8368#endif
8369
8370 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8371#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008372 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8373 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8374 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008375 }
8376#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8377#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8378
Gilles Peskine449bd832023-01-11 14:50:10 +01008379 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008380}
8381
Ronald Crone68ab4f2022-10-05 12:46:29 +02008382#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008383/*
8384 * Function for writing a signature algorithm extension.
8385 *
8386 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8387 * value (TLS 1.3 RFC8446):
8388 * enum {
8389 * ....
8390 * ecdsa_secp256r1_sha256( 0x0403 ),
8391 * ecdsa_secp384r1_sha384( 0x0503 ),
8392 * ecdsa_secp521r1_sha512( 0x0603 ),
8393 * ....
8394 * } SignatureScheme;
8395 *
8396 * struct {
8397 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8398 * } SignatureSchemeList;
8399 *
8400 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8401 * value (TLS 1.2 RFC5246):
8402 * enum {
8403 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8404 * sha512(6), (255)
8405 * } HashAlgorithm;
8406 *
8407 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8408 * SignatureAlgorithm;
8409 *
8410 * struct {
8411 * HashAlgorithm hash;
8412 * SignatureAlgorithm signature;
8413 * } SignatureAndHashAlgorithm;
8414 *
8415 * SignatureAndHashAlgorithm
8416 * supported_signature_algorithms<2..2^16-2>;
8417 *
8418 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8419 * generalization of the TLS 1.2 signature algorithm extension.
8420 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8421 * `SignatureScheme` field of TLS 1.3
8422 *
8423 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008424int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8425 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008426{
8427 unsigned char *p = buf;
8428 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8429 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8430
8431 *out_len = 0;
8432
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008434
8435 /* Check if we have space for header and length field:
8436 * - extension_type (2 bytes)
8437 * - extension_data_length (2 bytes)
8438 * - supported_signature_algorithms_length (2 bytes)
8439 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008441 p += 6;
8442
8443 /*
8444 * Write supported_signature_algorithms
8445 */
8446 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008447 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8448 if (sig_alg == NULL) {
8449 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8450 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008451
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8453 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8454 *sig_alg,
8455 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8456 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008457 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008458 }
8459 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8460 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008461 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008462 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8463 *sig_alg,
8464 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008465 }
8466
8467 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008468 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008469 if (supported_sig_alg_len == 0) {
8470 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8471 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008472 }
8473
Gilles Peskine449bd832023-01-11 14:50:10 +01008474 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8475 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8476 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008477
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008478 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008479
8480#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008481 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008482#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008483
Gilles Peskine449bd832023-01-11 14:50:10 +01008484 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008485}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008486#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008487
XiaokangQian40a35232022-05-07 09:02:40 +00008488#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008489/*
8490 * mbedtls_ssl_parse_server_name_ext
8491 *
8492 * Structure of server_name extension:
8493 *
8494 * enum {
8495 * host_name(0), (255)
8496 * } NameType;
8497 * opaque HostName<1..2^16-1>;
8498 *
8499 * struct {
8500 * NameType name_type;
8501 * select (name_type) {
8502 * case host_name: HostName;
8503 * } name;
8504 * } ServerName;
8505 * struct {
8506 * ServerName server_name_list<1..2^16-1>
8507 * } ServerNameList;
8508 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008509MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008510int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8511 const unsigned char *buf,
8512 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008513{
8514 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8515 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008516 size_t server_name_list_len, hostname_len;
8517 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008518
Gilles Peskine449bd832023-01-11 14:50:10 +01008519 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008520
Gilles Peskine449bd832023-01-11 14:50:10 +01008521 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8522 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008523 p += 2;
8524
Gilles Peskine449bd832023-01-11 14:50:10 +01008525 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008526 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008527 while (p < server_name_list_end) {
8528 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8529 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8530 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8531 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008532
Gilles Peskine449bd832023-01-11 14:50:10 +01008533 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008534 /* sni_name is intended to be used only during the parsing of the
8535 * ClientHello message (it is reset to NULL before the end of
8536 * the message parsing). Thus it is ok to just point to the
8537 * reception buffer and not make a copy of it.
8538 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008539 ssl->handshake->sni_name = p + 3;
8540 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008541 if (ssl->conf->f_sni == NULL) {
8542 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008543 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008544 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8545 ssl, p + 3, hostname_len);
8546 if (ret != 0) {
8547 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8548 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8549 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8550 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8551 }
8552 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008553 }
8554
8555 p += hostname_len + 3;
8556 }
8557
Gilles Peskine449bd832023-01-11 14:50:10 +01008558 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008559}
8560#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8561
XiaokangQianacb39922022-06-17 10:18:48 +00008562#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008563MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008564int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8565 const unsigned char *buf,
8566 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008567{
8568 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008569 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008570 const unsigned char *protocol_name_list;
8571 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008572 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008573
8574 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 if (ssl->conf->alpn_list == NULL) {
8576 return 0;
8577 }
XiaokangQianacb39922022-06-17 10:18:48 +00008578
8579 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008580 * RFC7301, section 3.1
8581 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008582 *
XiaokangQianc7403452022-06-23 03:24:12 +00008583 * struct {
8584 * ProtocolName protocol_name_list<2..2^16-1>
8585 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008586 */
8587
XiaokangQianc7403452022-06-23 03:24:12 +00008588 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008589 * protocol_name_list_len 2 bytes
8590 * protocol_name_len 1 bytes
8591 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008593 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008594
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008596 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008597 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008598 protocol_name_list = p;
8599 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008600
8601 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008602 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008603 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8605 protocol_name_len);
8606 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008607 MBEDTLS_SSL_PEND_FATAL_ALERT(
8608 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008609 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8610 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008611 }
8612
8613 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008614 }
8615
8616 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01008617 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
8618 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008619 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008620 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008621 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 if (protocol_name_len == alpn_len &&
8623 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008624 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008626 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008627
8628 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008629 }
8630 }
8631
XiaokangQian95d5f542022-06-24 02:29:26 +00008632 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008633 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008634 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8635 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8636 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008637}
8638
Gilles Peskine449bd832023-01-11 14:50:10 +01008639int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8640 unsigned char *buf,
8641 unsigned char *end,
8642 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008643{
8644 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008645 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008646 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008647
Gilles Peskine449bd832023-01-11 14:50:10 +01008648 if (ssl->alpn_chosen == NULL) {
8649 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008650 }
8651
Gilles Peskine449bd832023-01-11 14:50:10 +01008652 protocol_name_len = strlen(ssl->alpn_chosen);
8653 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008654
Gilles Peskine449bd832023-01-11 14:50:10 +01008655 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008656 /*
8657 * 0 . 1 ext identifier
8658 * 2 . 3 ext length
8659 * 4 . 5 protocol list length
8660 * 6 . 6 protocol name length
8661 * 7 . 7+n protocol name
8662 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008663 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008664
XiaokangQian95d5f542022-06-24 02:29:26 +00008665 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008666
Gilles Peskine449bd832023-01-11 14:50:10 +01008667 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8668 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008669 /* Note: the length of the chosen protocol has been checked to be less
8670 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8671 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008672 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008673
Gilles Peskine449bd832023-01-11 14:50:10 +01008674 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008675
8676#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008678#endif
8679
Gilles Peskine449bd832023-01-11 14:50:10 +01008680 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008681}
8682#endif /* MBEDTLS_SSL_ALPN */
8683
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008684#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008685 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008686 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008687 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008688int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8689 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008690{
8691 /* Initialize to suppress unnecessary compiler warning */
8692 size_t hostname_len = 0;
8693
8694 /* Check if new hostname is valid before
8695 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008696 if (hostname != NULL) {
8697 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008698
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8700 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8701 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008702 }
8703
8704 /* Now it's clear that we will overwrite the old hostname,
8705 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008706 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008707 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008708 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008709 }
8710
8711 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008712 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008713 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008714 } else {
8715 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8716 if (session->hostname == NULL) {
8717 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8718 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008719
Gilles Peskine449bd832023-01-11 14:50:10 +01008720 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008721 }
8722
Gilles Peskine449bd832023-01-11 14:50:10 +01008723 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008724}
Xiaokang Qian03409292022-10-12 02:49:52 +00008725#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8726 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008727 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008728 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008729
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008730#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8731 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008732int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8733 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008734{
8735 size_t alpn_len = 0;
8736
8737 if (alpn != NULL) {
8738 alpn_len = strlen(alpn);
8739
8740 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8741 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8742 }
8743 }
8744
8745 if (session->ticket_alpn != NULL) {
8746 mbedtls_zeroize_and_free(session->ticket_alpn,
8747 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008748 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008749 }
8750
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008751 if (alpn != NULL) {
8752 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008753 if (session->ticket_alpn == NULL) {
8754 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8755 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008756 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008757 }
8758
8759 return 0;
8760}
8761#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008762
8763/*
8764 * The following functions are used by 1.2 and 1.3, client and server.
8765 */
8766#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8767int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8768 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8769 int recv_endpoint,
8770 mbedtls_ssl_protocol_version tls_version,
8771 uint32_t *flags)
8772{
8773 int ret = 0;
8774 unsigned int usage = 0;
8775 const char *ext_oid;
8776 size_t ext_len;
8777
8778 /*
8779 * keyUsage
8780 */
8781
8782 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8783 * to check what a compliant client will think while choosing which cert
8784 * to send to the client. */
8785#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8786 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8787 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8788 /* TLS 1.2 server part of the key exchange */
8789 switch (ciphersuite->key_exchange) {
8790 case MBEDTLS_KEY_EXCHANGE_RSA:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008791 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
8792 break;
8793
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008794 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8795 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8796 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8797 break;
8798
8799 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8800 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8801 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8802 break;
8803
8804 /* Don't use default: we want warnings when adding new values */
8805 case MBEDTLS_KEY_EXCHANGE_NONE:
8806 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008807 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8808 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8809 usage = 0;
8810 }
8811 } else
8812#endif
8813 {
8814 /* This is either TLS 1.3 authentication, which always uses signatures,
8815 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8816 * options we implement, both using signatures. */
8817 (void) tls_version;
8818 (void) ciphersuite;
8819 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8820 }
8821
8822 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8823 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8824 ret = -1;
8825 }
8826
8827 /*
8828 * extKeyUsage
8829 */
8830
8831 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8832 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8833 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8834 } else {
8835 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8836 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8837 }
8838
8839 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8840 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8841 ret = -1;
8842 }
8843
8844 return ret;
8845}
8846
8847int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8848 int authmode,
8849 mbedtls_x509_crt *chain,
8850 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8851 void *rs_ctx)
8852{
8853 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8854 return 0;
8855 }
8856
8857 /*
8858 * Primary check: use the appropriate X.509 verification function
8859 */
8860 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8861 void *p_vrfy;
8862 if (ssl->f_vrfy != NULL) {
8863 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8864 f_vrfy = ssl->f_vrfy;
8865 p_vrfy = ssl->p_vrfy;
8866 } else {
8867 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8868 f_vrfy = ssl->conf->f_vrfy;
8869 p_vrfy = ssl->conf->p_vrfy;
8870 }
8871
8872 int ret = 0;
8873 int have_ca_chain_or_callback = 0;
8874#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8875 if (ssl->conf->f_ca_cb != NULL) {
8876 ((void) rs_ctx);
8877 have_ca_chain_or_callback = 1;
8878
8879 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8880 ret = mbedtls_x509_crt_verify_with_ca_cb(
8881 chain,
8882 ssl->conf->f_ca_cb,
8883 ssl->conf->p_ca_cb,
8884 ssl->conf->cert_profile,
8885 ssl->hostname,
8886 &ssl->session_negotiate->verify_result,
8887 f_vrfy, p_vrfy);
8888 } else
8889#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8890 {
8891 mbedtls_x509_crt *ca_chain;
8892 mbedtls_x509_crl *ca_crl;
8893#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8894 if (ssl->handshake->sni_ca_chain != NULL) {
8895 ca_chain = ssl->handshake->sni_ca_chain;
8896 ca_crl = ssl->handshake->sni_ca_crl;
8897 } else
8898#endif
8899 {
8900 ca_chain = ssl->conf->ca_chain;
8901 ca_crl = ssl->conf->ca_crl;
8902 }
8903
8904 if (ca_chain != NULL) {
8905 have_ca_chain_or_callback = 1;
8906 }
8907
8908 ret = mbedtls_x509_crt_verify_restartable(
8909 chain,
8910 ca_chain, ca_crl,
8911 ssl->conf->cert_profile,
8912 ssl->hostname,
8913 &ssl->session_negotiate->verify_result,
8914 f_vrfy, p_vrfy, rs_ctx);
8915 }
8916
8917 if (ret != 0) {
8918 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8919 }
8920
8921#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8922 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8923 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8924 }
8925#endif
8926
8927 /*
8928 * Secondary checks: always done, but change 'ret' only if it was 0
8929 */
8930
8931 /* With TLS 1.2 and ECC certs, check that the curve used by the
8932 * certificate is on our list of acceptable curves.
8933 *
8934 * With TLS 1.3 this is not needed because the curve is part of the
8935 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8936 * we validate the signature made with the key associated to this cert.
8937 */
8938#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8939 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8940 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8941 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8942 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8943 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8944 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8945 if (ret == 0) {
8946 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8947 }
8948 }
8949 }
8950#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8951
8952 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8953 if (mbedtls_ssl_check_cert_usage(chain,
8954 ciphersuite_info,
8955 ssl->conf->endpoint,
8956 ssl->tls_version,
8957 &ssl->session_negotiate->verify_result) != 0) {
8958 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8959 if (ret == 0) {
8960 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8961 }
8962 }
8963
8964 /* With authmode optional, we want to keep going if the certificate was
8965 * unacceptable, but still fail on other errors (out of memory etc),
8966 * including fatal errors from the f_vrfy callback.
8967 *
8968 * The only acceptable errors are:
8969 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8970 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8971 * Anything else is a fatal error. */
8972 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8973 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8974 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8975 ret = 0;
8976 }
8977
8978 /* Return a specific error as this is a user error: inconsistent
8979 * configuration - can't verify without trust anchors. */
8980 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8981 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8982 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8983 }
8984
8985 if (ret != 0) {
8986 uint8_t alert;
8987
8988 /* The certificate may have been rejected for several reasons.
8989 Pick one and send the corresponding alert. Which alert to send
8990 may be a subject of debate in some cases. */
8991 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8992 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8993 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8994 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8995 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8996 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8997 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8998 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8999 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
9000 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9001 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
9002 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9003 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
9004 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
9005 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
9006 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
9007 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
9008 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
9009 } else {
9010 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
9011 }
9012 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9013 alert);
9014 }
9015
9016#if defined(MBEDTLS_DEBUG_C)
9017 if (ssl->session_negotiate->verify_result != 0) {
9018 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
9019 (unsigned int) ssl->session_negotiate->verify_result));
9020 } else {
9021 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
9022 }
9023#endif /* MBEDTLS_DEBUG_C */
9024
9025 return ret;
9026}
9027#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
9028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009029#endif /* MBEDTLS_SSL_TLS_C */