blob: 7d20b3cdd15ed10273b914b1aea0d6982a0aae04 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Harry Ramsey0f6bc412024-10-04 10:36:54 +010012#include "ssl_misc.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040021
Valerio Settib4f50762024-01-17 10:24:52 +010022#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000023#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050024#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010025#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020026#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020027
Rich Evans00ab4702015-02-06 13:43:58 +000028#include <string.h>
29
Valerio Setti384fbde2024-01-02 13:26:40 +010030#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020031#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020032#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050033#include "psa/crypto.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034
Janos Follath23bdca02016-10-07 14:47:14 +010035#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000036#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020037#endif
38
Andrzej Kurek00644842023-05-30 05:45:00 -040039/* Define local translating functions to save code size by not using too many
40 * arguments in each translating place. */
41static int local_err_translation(psa_status_t status)
42{
43 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040044 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040045 psa_generic_status_to_mbedtls);
46}
47#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050048
Ronald Cronad8c17b2022-06-10 17:18:09 +020049#if defined(MBEDTLS_TEST_HOOKS)
50static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
51
52void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010053 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020054{
55 chk_buf_ptr_fail_args.cur = cur;
56 chk_buf_ptr_fail_args.end = end;
57 chk_buf_ptr_fail_args.need = need;
58}
59
Gilles Peskine449bd832023-01-11 14:50:10 +010060void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020061{
Gilles Peskine449bd832023-01-11 14:50:10 +010062 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020063}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 return (chk_buf_ptr_fail_args.cur != args->cur) ||
68 (chk_buf_ptr_fail_args.end != args->end) ||
69 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020070}
71#endif /* MBEDTLS_TEST_HOOKS */
72
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020073#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010074
Hanno Beckera0e20d02019-05-15 14:03:01 +010075#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010076/* Top-level Connection ID API */
77
Gilles Peskine449bd832023-01-11 14:50:10 +010078int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
79 size_t len,
80 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010081{
Gilles Peskine449bd832023-01-11 14:50:10 +010082 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
83 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
84 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010085
Gilles Peskine449bd832023-01-11 14:50:10 +010086 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
87 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010089 }
90
91 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010092 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010093 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010094}
95
Gilles Peskine449bd832023-01-11 14:50:10 +010096int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
97 int enable,
98 unsigned char const *own_cid,
99 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100100{
Gilles Peskine449bd832023-01-11 14:50:10 +0100101 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
102 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
103 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100104
Hanno Beckerca092242019-04-25 16:01:49 +0100105 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (enable == MBEDTLS_SSL_CID_DISABLED) {
107 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
108 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100109 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
111 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100112
Gilles Peskine449bd832023-01-11 14:50:10 +0100113 if (own_cid_len != ssl->conf->cid_len) {
114 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
115 (unsigned) own_cid_len,
116 (unsigned) ssl->conf->cid_len));
117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100118 }
119
Gilles Peskine449bd832023-01-11 14:50:10 +0100120 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100121 /* Truncation is not an issue here because
122 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
123 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100126}
127
Gilles Peskine449bd832023-01-11 14:50:10 +0100128int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
129 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +0100130 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100131 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000132{
133 *enabled = MBEDTLS_SSL_CID_DISABLED;
134
Gilles Peskine449bd832023-01-11 14:50:10 +0100135 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
136 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
137 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000138
139 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
140 * zero as this is indistinguishable from not requesting to use
141 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100142 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
143 return 0;
144 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000145
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000147 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100148 if (own_cid != NULL) {
149 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
150 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000151 }
152
153 *enabled = MBEDTLS_SSL_CID_ENABLED;
154
Gilles Peskine449bd832023-01-11 14:50:10 +0100155 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000156}
157
Gilles Peskine449bd832023-01-11 14:50:10 +0100158int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
159 int *enabled,
160 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
161 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100162{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100163 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100164
Gilles Peskine449bd832023-01-11 14:50:10 +0100165 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
166 mbedtls_ssl_is_handshake_over(ssl) == 0) {
167 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100168 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Hanno Beckerc5f24222019-05-03 12:54:52 +0100170 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
171 * were used, but client and server requested the empty CID.
172 * This is indistinguishable from not using the CID extension
173 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 if (ssl->transform_in->in_cid_len == 0 &&
175 ssl->transform_in->out_cid_len == 0) {
176 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177 }
178
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100180 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100181 if (peer_cid != NULL) {
182 memcpy(peer_cid, ssl->transform_in->out_cid,
183 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100184 }
185 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100186
187 *enabled = MBEDTLS_SSL_CID_ENABLED;
188
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100190}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100191#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200193#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200195#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200196/*
197 * Convert max_fragment_length codes to length.
198 * RFC 6066 says:
199 * enum{
200 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
201 * } MaxFragmentLength;
202 * and we add 0 -> extension unused
203 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100204static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200205{
Gilles Peskine449bd832023-01-11 14:50:10 +0100206 switch (mfl) {
207 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
208 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
209 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
210 return 512;
211 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
212 return 1024;
213 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
214 return 2048;
215 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
216 return 4096;
217 default:
218 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000219 }
220}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200221#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200222
Gilles Peskine449bd832023-01-11 14:50:10 +0100223int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
224 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200225{
Gilles Peskine449bd832023-01-11 14:50:10 +0100226 mbedtls_ssl_session_free(dst);
227 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800228#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
229 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000230#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
231 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000232 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800233#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000234#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800235
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000236#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
237 defined(MBEDTLS_SSL_EARLY_DATA)
238 dst->ticket_alpn = NULL;
239#endif
240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000242
243#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
248 if (dst->peer_cert == NULL) {
249 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
250 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200253
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
255 src->peer_cert->raw.len)) != 0) {
256 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200257 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259 }
260 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000261#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000263 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 mbedtls_calloc(1, src->peer_cert_digest_len);
265 if (dst->peer_cert_digest == NULL) {
266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
267 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000268
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
270 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000272 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 }
274#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200277
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000278#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
279 defined(MBEDTLS_SSL_EARLY_DATA)
280 {
281 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
282 if (ret != 0) {
283 return ret;
284 }
285 }
286#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
287
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200288#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (src->ticket != NULL) {
290 dst->ticket = mbedtls_calloc(1, src->ticket_len);
291 if (dst->ticket == NULL) {
292 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
293 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200294
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200296 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000297
298#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
299 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000301 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
303 if (ret != 0) {
304 return ret;
305 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000306 }
307#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
308 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200309#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200310
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200312}
313
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500314#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200315MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100316static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500317{
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
319 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800320 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500322
323 /* We want to copy len_new bytes when downsizing the buffer, and
324 * len_old bytes when upsizing, so we choose the smaller of two sizes,
325 * to fit one buffer into another. Size checks, ensuring that no data is
326 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 memcpy(resized_buffer, *buffer,
328 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100329 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500330
331 *buffer = resized_buffer;
332 *len_old = len_new;
333
334 return 0;
335}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200336
Gilles Peskine449bd832023-01-11 14:50:10 +0100337static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
338 size_t in_buf_new_len,
339 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200340{
341 int modified = 0;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000342 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0, hdr_in = 0;
Andrzej Kurek4a063792020-10-21 15:08:44 +0200343 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 written_in = ssl->in_msg - ssl->in_buf;
346 iv_offset_in = ssl->in_iv - ssl->in_buf;
347 len_offset_in = ssl->in_len - ssl->in_buf;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000348 hdr_in = ssl->in_hdr - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200350 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 ssl->in_buf_len < in_buf_new_len) {
352 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
353 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
354 } else {
355 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
356 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200357 modified = 1;
358 }
359 }
360 }
361
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200363 written_out = ssl->out_msg - ssl->out_buf;
364 iv_offset_out = ssl->out_iv - ssl->out_buf;
365 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 ssl->out_buf_len < out_buf_new_len) {
369 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
370 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
371 } else {
372 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
373 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200374 modified = 1;
375 }
376 }
377 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200379 /* Update pointers here to avoid doing it twice. */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000380 ssl->in_hdr = ssl->in_buf + hdr_in;
381 mbedtls_ssl_update_in_pointers(ssl);
382 mbedtls_ssl_reset_out_pointers(ssl);
383
Andrzej Kurek4a063792020-10-21 15:08:44 +0200384 /* Fields below might not be properly updated with record
385 * splitting or with CID, so they are manually updated here. */
386 ssl->out_msg = ssl->out_buf + written_out;
387 ssl->out_len = ssl->out_buf + len_offset_out;
388 ssl->out_iv = ssl->out_buf + iv_offset_out;
389
390 ssl->in_msg = ssl->in_buf + written_in;
391 ssl->in_len = ssl->in_buf + len_offset_in;
392 ssl->in_iv = ssl->in_buf + iv_offset_in;
393 }
394}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500395#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
396
Jerry Yudb8c48a2022-01-27 14:54:54 +0800397#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800398
399#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100400typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
401 const char *label,
402 const unsigned char *random, size_t rlen,
403 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800404
Gilles Peskine449bd832023-01-11 14:50:10 +0100405static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800406
407#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
408
409/* Type for the TLS PRF */
410typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
411 const unsigned char *, size_t,
412 unsigned char *, size_t);
413
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200414MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100415static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
416 int ciphersuite,
417 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200418#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200420#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 ssl_tls_prf_t tls_prf,
422 const unsigned char randbytes[64],
423 mbedtls_ssl_protocol_version tls_version,
424 unsigned endpoint,
425 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800426
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100427#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200428MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100429static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300430 const char *label,
431 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100433static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
434static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100435
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100436#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100437
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100438#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100439MBEDTLS_CHECK_RETURN_CRITICAL
440static int tls_prf_sha384(const unsigned char *secret, size_t slen,
441 const char *label,
442 const unsigned char *random, size_t rlen,
443 unsigned char *dstbuf, size_t dlen);
444
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100445static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
446static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100447#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100448
Gilles Peskine449bd832023-01-11 14:50:10 +0100449MBEDTLS_CHECK_RETURN_CRITICAL
450static int ssl_tls12_session_load(mbedtls_ssl_session *session,
451 const unsigned char *buf,
452 size_t len);
453#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
454
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100455static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100456
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100457#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100458static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100459#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100460
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100461#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100462static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100463#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100464
465int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
466 const unsigned char *secret, size_t slen,
467 const char *label,
468 const unsigned char *random, size_t rlen,
469 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300470{
471 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
472
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300474#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100475#if defined(PSA_WANT_ALG_SHA_384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300476 case MBEDTLS_SSL_TLS_PRF_SHA384:
477 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100478 break;
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100479#endif /* PSA_WANT_ALG_SHA_384*/
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100480#if defined(PSA_WANT_ALG_SHA_256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300481 case MBEDTLS_SSL_TLS_PRF_SHA256:
482 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 break;
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100484#endif /* PSA_WANT_ALG_SHA_256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300485#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 default:
487 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300488 }
489
Gilles Peskine449bd832023-01-11 14:50:10 +0100490 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300491}
492
Jerry Yuc73c6182022-02-08 20:29:25 +0800493#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100494static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800495{
496#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 if (session->peer_cert != NULL) {
498 mbedtls_x509_crt_free(session->peer_cert);
499 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800500 session->peer_cert = NULL;
501 }
502#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800504 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800506 session->peer_cert_digest = NULL;
507 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
508 session->peer_cert_digest_len = 0;
509 }
510#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
511}
512#endif /* MBEDTLS_X509_CRT_PARSE_C */
513
Gilles Peskine449bd832023-01-11 14:50:10 +0100514uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800515{
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800517 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800519
520 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800522
523 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800525
526 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800528
529 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100530 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800531
532 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100533 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800534
535 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100536 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800537
538 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100539 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800540
541 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100542 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800543
544 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800546
547 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100548 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800549
550 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800552
553 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800555
556 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100557 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800558
559 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800561
562 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800564
565 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100566 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800567
568 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800570
571 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800573
574 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800576
577 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800579
580 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800582
583 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800585
586 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800588
589 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800591
592 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800594
Jan Bruckner151f6422023-02-10 12:45:19 +0100595 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
596 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
597
Jerry Yu7a485c12022-10-31 13:08:18 +0800598 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800600
601 }
602
Gilles Peskine449bd832023-01-11 14:50:10 +0100603 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800604}
605
Gilles Peskine449bd832023-01-11 14:50:10 +0100606uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800607{
Gilles Peskine449bd832023-01-11 14:50:10 +0100608 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800609}
610
Jerry Yud25cab02022-10-31 12:48:30 +0800611#if defined(MBEDTLS_DEBUG_C)
612static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800613 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800614 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
615 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
616 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
617 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
618 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
619 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
620 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
621 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
622 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
623 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
624 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
625 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
626 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
627 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
628 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
629 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
630 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
631 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
632 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
633 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
634 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
635 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
636 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
637 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
638 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
639 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100640 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
641 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800642};
643
Chien Wong4e9683e2023-12-28 17:07:43 +0800644static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800645 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
646 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
647 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
648 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
649 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
650 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
651 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
652 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
653 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
654 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
655 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
656 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
657 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
658 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
659 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
660 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
661 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
662 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
663 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
664 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
665 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
666 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
667 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
668 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
669 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
670 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
671 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100672 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
673 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800674};
675
Gilles Peskine449bd832023-01-11 14:50:10 +0100676const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800677{
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return extension_name_table[
679 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800680}
681
Gilles Peskine449bd832023-01-11 14:50:10 +0100682static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800683{
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800685 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800687 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800689 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800691 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800693 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800695 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800697 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800699 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100700 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800701}
702
Gilles Peskine449bd832023-01-11 14:50:10 +0100703void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
704 int level, const char *file, int line,
705 int hs_msg_type, unsigned int extension_type,
706 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800707{
708 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800710 mbedtls_debug_print_msg(
711 ssl, level, file, line,
712 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 ssl_tls13_get_hs_msg_name(hs_msg_type),
714 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800715 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100716 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800717 return;
718 }
719
720 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800722 mbedtls_debug_print_msg(
723 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
725 mbedtls_ssl_get_extension_name(extension_type), extension_type,
726 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800727 return;
728 }
729
730 mbedtls_debug_print_msg(
731 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
733 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800734}
735
Gilles Peskine449bd832023-01-11 14:50:10 +0100736void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
737 int level, const char *file, int line,
738 int hs_msg_type, uint32_t extensions_mask,
739 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800740{
741
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 for (unsigned i = 0;
743 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
744 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800745 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800746 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100747 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800748 }
749}
750
Pengyu Lvee455c02023-01-12 14:37:24 +0800751#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800752static const char *ticket_flag_name_table[] =
753{
754 [0] = "ALLOW_PSK_RESUMPTION",
755 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
756 [3] = "ALLOW_EARLY_DATA",
757};
758
Pengyu Lv4938a562023-01-16 11:28:49 +0800759void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
760 int level, const char *file, int line,
761 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800762{
763 size_t i;
764
765 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800766 "print ticket_flags (0x%02x)", flags);
767
768 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800769
770 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800771 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800772 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
773 ticket_flag_name_table[i]);
774 }
775 }
776}
777#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
778
Jerry Yud25cab02022-10-31 12:48:30 +0800779#endif /* MBEDTLS_DEBUG_C */
780
Gilles Peskine449bd832023-01-11 14:50:10 +0100781void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
782 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800783{
784 ((void) ciphersuite_info);
785
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100786#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800788 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800790#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100791#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800793 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800795#endif
796 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100797 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800798 return;
799 }
800}
801
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100802int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100803 unsigned hs_type,
804 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100805{
806 unsigned char hs_hdr[4];
807
808 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
810 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
811 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
812 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100813
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100814 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100815}
816
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100817int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100818 unsigned hs_type,
819 unsigned char const *msg,
820 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100821{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100822 int ret;
823 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100824 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100825 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100826 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100827 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100828}
829
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100830int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800831{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100832#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100833 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100834 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100835#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800836 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100837#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100838#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100839 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
840 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200841 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100842 }
843 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
844 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200845 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100846 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800847#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100848#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100849 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
850 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200851 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100852 }
853 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
854 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200855 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100856 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800857#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100858 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800859}
860
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100861static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100862 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800863{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100864#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100865 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100866 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100867#else /* SHA-256 or SHA-384 */
868 ((void) ssl);
869 (void) buf;
870 (void) len;
871#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100872#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100873 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
874 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200875 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100876 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800877#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100878#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100879 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
880 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200881 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100882 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800883#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100884 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800885}
886
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100887#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100888static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100889 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800890{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200891 return mbedtls_md_error_from_psa(psa_hash_update(
892 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800893}
894#endif
895
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100896#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100897static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100898 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800899{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200900 return mbedtls_md_error_from_psa(psa_hash_update(
901 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800902}
903#endif
904
Gilles Peskine449bd832023-01-11 14:50:10 +0100905static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200906{
Gilles Peskine449bd832023-01-11 14:50:10 +0100907 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200908
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100909#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500910 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500911#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100912#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500913 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500914#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200915
916 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100917
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200920#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200921#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200922 handshake->psa_pake_ctx = psa_pake_operation_init();
923 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200924#if defined(MBEDTLS_SSL_CLI_C)
925 handshake->ecjpake_cache = NULL;
926 handshake->ecjpake_cache_len = 0;
927#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200928#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200929
Gilles Peskineeccd8882020-03-10 12:19:08 +0100930#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200932#endif
933
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200934#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
935 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
936#endif
Hanno Becker75173122019-02-06 16:18:31 +0000937
938#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
939 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100940 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +0000941#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200942}
943
Gilles Peskine449bd832023-01-11 14:50:10 +0100944void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200945{
Gilles Peskine449bd832023-01-11 14:50:10 +0100946 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +0200947
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100948 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
949 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100950
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000951#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100952 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
953 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100954#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200955}
956
Gilles Peskine449bd832023-01-11 14:50:10 +0100957void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200958{
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200960}
961
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200962MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100963static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +0000964{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100965 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
966
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200967 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +0800968#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 if (ssl->transform_negotiate) {
970 mbedtls_ssl_transform_free(ssl->transform_negotiate);
971 }
Jerry Yu2e199812022-12-01 18:57:19 +0800972#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100973 if (ssl->session_negotiate) {
974 mbedtls_ssl_session_free(ssl->session_negotiate);
975 }
976 if (ssl->handshake) {
977 mbedtls_ssl_handshake_free(ssl);
978 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200979
Jerry Yu2e199812022-12-01 18:57:19 +0800980#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200981 /*
982 * Either the pointers are now NULL or cleared properly and can be freed.
983 * Now allocate missing structures.
984 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 if (ssl->transform_negotiate == NULL) {
986 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200987 }
Jerry Yu2e199812022-12-01 18:57:19 +0800988#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000989
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 if (ssl->session_negotiate == NULL) {
991 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200992 }
Paul Bakker48916f92012-09-16 19:57:18 +0000993
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 if (ssl->handshake == NULL) {
995 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200996 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500997#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
998 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400999
Gilles Peskine449bd832023-01-11 14:50:10 +01001000 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1001 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001002#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001003
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001004 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001005 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001006#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001007 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001008#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 ssl->session_negotiate == NULL) {
1010 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001011
Gilles Peskine449bd832023-01-11 14:50:10 +01001012 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001013 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001014
1015#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001017 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001018#endif
1019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001021 ssl->session_negotiate = NULL;
1022
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001024 }
1025
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001026#if defined(MBEDTLS_SSL_EARLY_DATA)
1027#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001028 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001029#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001030#if defined(MBEDTLS_SSL_SRV_C)
1031 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1032#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001033 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001034#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001035
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001036 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 mbedtls_ssl_session_init(ssl->session_negotiate);
1038 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001039
Jerry Yu2e199812022-12-01 18:57:19 +08001040#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001041 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001042#endif
1043
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001044 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001045 ret = mbedtls_ssl_reset_checksum(ssl);
1046 if (ret != 0) {
1047 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1048 return ret;
1049 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001050
Jerry Yud0766ec2022-09-22 10:46:57 +08001051#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1052 defined(MBEDTLS_SSL_SRV_C) && \
1053 defined(MBEDTLS_SSL_SESSION_TICKETS)
1054 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001056#endif
1057
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001060 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001061
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001063 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001065 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001067
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001069 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001070#endif
1071
Ronald Crone68ab4f2022-10-05 12:46:29 +02001072#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001073#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001074#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001075 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1076 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1078 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001079 const int *md;
1080 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001081 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001082 uint16_t *p;
1083
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001084 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1085 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1086 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001087
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1089 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001090 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001092#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001094#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001095
Jerry Yub476a442022-01-21 18:14:45 +08001096#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001098#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1100 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1101 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001102 }
1103
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1105 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1106 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001107
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1109 sizeof(uint16_t));
1110 if (ssl->handshake->sig_algs == NULL) {
1111 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1112 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001113
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 p = (uint16_t *) ssl->handshake->sig_algs;
1115 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1116 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1117 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001118 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001120#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001122 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001123#endif
1124#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001126 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001127#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001128 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001129 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001130 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001132#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001133 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001134 ssl->handshake->sig_algs_heap_allocated = 0;
1135 }
Jerry Yucc539102022-06-27 16:27:35 +08001136#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001137#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001139}
1140
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001141#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001142/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001143MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001144static int ssl_cookie_write_dummy(void *ctx,
1145 unsigned char **p, unsigned char *end,
1146 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001147{
1148 ((void) ctx);
1149 ((void) p);
1150 ((void) end);
1151 ((void) cli_id);
1152 ((void) cli_id_len);
1153
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001155}
1156
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001157MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001158static int ssl_cookie_check_dummy(void *ctx,
1159 const unsigned char *cookie, size_t cookie_len,
1160 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001161{
1162 ((void) ctx);
1163 ((void) cookie);
1164 ((void) cookie_len);
1165 ((void) cli_id);
1166 ((void) cli_id_len);
1167
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001169}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001170#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001171
Paul Bakker5121ce52009-01-03 21:22:43 +00001172/*
1173 * Initialize an SSL context
1174 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001175void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001176{
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001178}
1179
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001180MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001181static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001182{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001183 const mbedtls_ssl_config *conf = ssl->conf;
1184
Ronald Cron6f135e12021-12-08 16:57:54 +01001185#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001186 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1187 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1188 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1189 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001190 }
1191
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1193 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001194 }
1195#endif
1196
1197#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1199 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1200 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001201 }
1202#endif
1203
Ronald Cron6f135e12021-12-08 16:57:54 +01001204#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1206 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1207 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1208 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001209 }
1210
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1212 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001213 }
1214#endif
1215
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1217 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001218}
1219
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001220MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001221static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1222{
1223 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 ret = ssl_conf_version_check(ssl);
1225 if (ret != 0) {
1226 return ret;
1227 }
Jerry Yu60835a82021-08-04 10:13:52 +08001228
Yanray Wangb422cab2023-12-01 16:18:10 +08001229 if (ssl->conf->f_rng == NULL) {
1230 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1231 return MBEDTLS_ERR_SSL_NO_RNG;
1232 }
1233
Jerry Yu60835a82021-08-04 10:13:52 +08001234 /* Space for further checks */
1235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001237}
1238
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001239/*
1240 * Setup an SSL context
1241 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001242
Gilles Peskine449bd832023-01-11 14:50:10 +01001243int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1244 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001245{
Janos Follath865b3eb2019-12-16 11:46:15 +00001246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001247 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1248 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001249
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001250 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001251
Gilles Peskine449bd832023-01-11 14:50:10 +01001252 if ((ret = ssl_conf_check(ssl)) != 0) {
1253 return ret;
1254 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001255 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001256
Paul Bakker62f2dee2012-09-28 07:31:51 +00001257 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001258 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001259 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001260
1261 /* Set to NULL in case of an error condition */
1262 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001263
Darryl Greenb33cc762019-11-28 14:29:44 +00001264#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1265 ssl->in_buf_len = in_buf_len;
1266#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001267 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1268 if (ssl->in_buf == NULL) {
1269 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001270 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001271 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001272 }
1273
Darryl Greenb33cc762019-11-28 14:29:44 +00001274#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1275 ssl->out_buf_len = out_buf_len;
1276#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001277 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1278 if (ssl->out_buf == NULL) {
1279 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001280 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001281 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001282 }
1283
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001284 mbedtls_ssl_reset_in_pointers(ssl);
1285 mbedtls_ssl_reset_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001286
Johan Pascalb62bb512015-12-03 21:56:45 +01001287#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001289#endif
1290
Gilles Peskine449bd832023-01-11 14:50:10 +01001291 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001292 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001294
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001296
1297error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 mbedtls_free(ssl->in_buf);
1299 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001300
1301 ssl->conf = NULL;
1302
Darryl Greenb33cc762019-11-28 14:29:44 +00001303#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1304 ssl->in_buf_len = 0;
1305 ssl->out_buf_len = 0;
1306#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001307 ssl->in_buf = NULL;
1308 ssl->out_buf = NULL;
1309
1310 ssl->in_hdr = NULL;
1311 ssl->in_ctr = NULL;
1312 ssl->in_len = NULL;
1313 ssl->in_iv = NULL;
1314 ssl->in_msg = NULL;
1315
1316 ssl->out_hdr = NULL;
1317 ssl->out_ctr = NULL;
1318 ssl->out_len = NULL;
1319 ssl->out_iv = NULL;
1320 ssl->out_msg = NULL;
1321
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001323}
1324
1325/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001326 * Reset an initialized and used SSL context for re-use while retaining
1327 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001328 *
1329 * If partial is non-zero, keep data in the input buffer and client ID.
1330 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001331 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001332void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1333 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001334{
Darryl Greenb33cc762019-11-28 14:29:44 +00001335#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1336 size_t in_buf_len = ssl->in_buf_len;
1337 size_t out_buf_len = ssl->out_buf_len;
1338#else
1339 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1340 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1341#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001342
Hanno Beckerb0302c42021-08-03 09:39:42 +01001343#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1344 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001345#endif
1346
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001347 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001349
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001350 mbedtls_ssl_reset_in_pointers(ssl);
1351 mbedtls_ssl_reset_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001352
1353 /* Reset incoming message parsing */
1354 ssl->in_offt = NULL;
1355 ssl->nb_zero = 0;
1356 ssl->in_msgtype = 0;
1357 ssl->in_msglen = 0;
1358 ssl->in_hslen = 0;
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03001359 ssl->in_hsfraglen = 0;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001360 ssl->keep_current_message = 0;
1361 ssl->transform_in = NULL;
1362
1363#if defined(MBEDTLS_SSL_PROTO_DTLS)
1364 ssl->next_record_offset = 0;
1365 ssl->in_epoch = 0;
1366#endif
1367
1368 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001369 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001370 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001372 }
1373
Ronald Cronad8c17b2022-06-10 17:18:09 +02001374 ssl->send_alert = 0;
1375
Hanno Beckerb0302c42021-08-03 09:39:42 +01001376 /* Reset outgoing message writing */
1377 ssl->out_msgtype = 0;
1378 ssl->out_msglen = 0;
1379 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 memset(ssl->out_buf, 0, out_buf_len);
1381 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001382 ssl->transform_out = NULL;
1383
1384#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001385 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001386#endif
1387
XiaokangQian2b01dc32022-01-21 02:53:13 +00001388#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001389 if (ssl->transform) {
1390 mbedtls_ssl_transform_free(ssl->transform);
1391 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001392 ssl->transform = NULL;
1393 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001394#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1395
XiaokangQian2b01dc32022-01-21 02:53:13 +00001396#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 mbedtls_ssl_transform_free(ssl->transform_application);
1398 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001399 ssl->transform_application = NULL;
1400
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001402#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1404 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001405 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001406#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001407
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1409 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001410 ssl->handshake->transform_handshake = NULL;
1411 }
1412
XiaokangQian2b01dc32022-01-21 02:53:13 +00001413#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001414}
1415
Gilles Peskine449bd832023-01-11 14:50:10 +01001416int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001417{
1418 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1419
1420 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001421 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001422
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001424
1425 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001426#if defined(MBEDTLS_SSL_RENEGOTIATION)
1427 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001428 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001429
1430 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1432 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001433#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001434 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001435
Hanno Beckerb0302c42021-08-03 09:39:42 +01001436 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001437 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 if (ssl->session) {
1439 mbedtls_ssl_session_free(ssl->session);
1440 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001441 ssl->session = NULL;
1442 }
1443
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001444#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001445 ssl->alpn_chosen = NULL;
1446#endif
1447
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001448#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001449 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001450#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001451 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001452#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 if (free_cli_id) {
1454 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001455 ssl->cli_id = NULL;
1456 ssl->cli_id_len = 0;
1457 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001458#endif
1459
Gilles Peskine449bd832023-01-11 14:50:10 +01001460 if ((ret = ssl_handshake_init(ssl)) != 0) {
1461 return ret;
1462 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001463
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001465}
1466
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001467/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001468 * Reset an initialized and used SSL context for re-use while retaining
1469 * all application-set variables, function pointers and data.
1470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001472{
Gilles Peskine449bd832023-01-11 14:50:10 +01001473 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001474}
1475
1476/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001477 * SSL set accessors
1478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001479void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001480{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001481 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001482}
1483
Gilles Peskine449bd832023-01-11 14:50:10 +01001484void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001485{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001486 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001487}
1488
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001489#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001490void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001491{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001492 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001493}
1494#endif
1495
Gilles Peskine449bd832023-01-11 14:50:10 +01001496void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001497{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001498 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001499}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001500
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001501#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001502
Gilles Peskine449bd832023-01-11 14:50:10 +01001503void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1504 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001505{
1506 ssl->disable_datagram_packing = !allow_packing;
1507}
1508
Gilles Peskine449bd832023-01-11 14:50:10 +01001509void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1510 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001511{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001512 conf->hs_timeout_min = min;
1513 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001514}
1515#endif
1516
Gilles Peskine449bd832023-01-11 14:50:10 +01001517void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001518{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001519 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001520}
1521
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001522#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001523void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1524 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1525 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001526{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001527 conf->f_vrfy = f_vrfy;
1528 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001529}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001530#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001531
Gilles Peskine449bd832023-01-11 14:50:10 +01001532void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1533 int (*f_rng)(void *, unsigned char *, size_t),
1534 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001535{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001536 conf->f_rng = f_rng;
1537 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001538}
1539
Gilles Peskine449bd832023-01-11 14:50:10 +01001540void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1541 void (*f_dbg)(void *, int, const char *, int, const char *),
1542 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001543{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001544 conf->f_dbg = f_dbg;
1545 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001546}
1547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1549 void *p_bio,
1550 mbedtls_ssl_send_t *f_send,
1551 mbedtls_ssl_recv_t *f_recv,
1552 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001553{
1554 ssl->p_bio = p_bio;
1555 ssl->f_send = f_send;
1556 ssl->f_recv = f_recv;
1557 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001558}
1559
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001560#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001561void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001562{
1563 ssl->mtu = mtu;
1564}
1565#endif
1566
Gilles Peskine449bd832023-01-11 14:50:10 +01001567void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001568{
1569 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001570}
1571
Gilles Peskine449bd832023-01-11 14:50:10 +01001572void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1573 void *p_timer,
1574 mbedtls_ssl_set_timer_t *f_set_timer,
1575 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001576{
1577 ssl->p_timer = p_timer;
1578 ssl->f_set_timer = f_set_timer;
1579 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001580
1581 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001583}
1584
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001586void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1587 void *p_cache,
1588 mbedtls_ssl_cache_get_t *f_get_cache,
1589 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001590{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001591 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001592 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001593 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001594}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001595#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001596
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001597#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001598int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001599{
Janos Follath865b3eb2019-12-16 11:46:15 +00001600 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001601
Gilles Peskine449bd832023-01-11 14:50:10 +01001602 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001603 session == NULL ||
1604 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1606 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001607 }
1608
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 if (ssl->handshake->resume == 1) {
1610 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1611 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001612
Jerry Yu21092062022-10-10 21:21:31 +08001613#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001615#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001616 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001618
Gilles Peskine449bd832023-01-11 14:50:10 +01001619 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001620 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1622 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1623 session->ciphersuite));
1624 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001625 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001626#else
1627 /*
1628 * If session tickets are not enabled, it is not possible to resume a
1629 * TLS 1.3 session, thus do not make any change to the SSL context in
1630 * the first place.
1631 */
1632 return 0;
1633#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001634 }
Jerry Yu21092062022-10-10 21:21:31 +08001635#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001636
Gilles Peskine449bd832023-01-11 14:50:10 +01001637 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1638 session)) != 0) {
1639 return ret;
1640 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001641
Paul Bakker0a597072012-09-25 21:55:46 +00001642 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001643
Gilles Peskine449bd832023-01-11 14:50:10 +01001644 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001645}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001646#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001647
Gilles Peskine449bd832023-01-11 14:50:10 +01001648void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1649 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001650{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001651 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001652}
1653
Ronald Cron6f135e12021-12-08 16:57:54 +01001654#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001655void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1656 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001657{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001658 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001659}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001660
1661#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001662void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1663 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001664{
1665 conf->early_data_enabled = early_data_enabled;
1666}
Jerry Yucc4e0072022-11-22 17:22:22 +08001667
1668#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001669void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001670 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001671{
Jerry Yu39da9852022-12-06 16:58:36 +08001672 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001673}
1674#endif /* MBEDTLS_SSL_SRV_C */
1675
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001676#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001677#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001678
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001679#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001680void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1681 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001682{
1683 conf->cert_profile = profile;
1684}
1685
Gilles Peskine449bd832023-01-11 14:50:10 +01001686static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001687{
1688 mbedtls_ssl_key_cert *cur = key_cert, *next;
1689
Gilles Peskine449bd832023-01-11 14:50:10 +01001690 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001691 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001693 cur = next;
1694 }
1695}
1696
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001697/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001698MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001699static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1700 mbedtls_x509_crt *cert,
1701 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001702{
niisato8ee24222018-06-25 19:05:48 +09001703 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001704
Gilles Peskine449bd832023-01-11 14:50:10 +01001705 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001706 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001707 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001708 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001709 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001710 }
1711
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1713 if (new_cert == NULL) {
1714 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1715 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001716
niisato8ee24222018-06-25 19:05:48 +09001717 new_cert->cert = cert;
1718 new_cert->key = key;
1719 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001720
Glenn Strauss36872db2022-01-22 05:06:31 -05001721 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001723 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001725 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001727 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 }
niisato8ee24222018-06-25 19:05:48 +09001729 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001730 }
1731
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001733}
1734
Gilles Peskine449bd832023-01-11 14:50:10 +01001735int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001736 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001738{
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001740}
1741
Gilles Peskine449bd832023-01-11 14:50:10 +01001742void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001743 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001745{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001746 conf->ca_chain = ca_chain;
1747 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001748
1749#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1750 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1751 * cannot be used together. */
1752 conf->f_ca_cb = NULL;
1753 conf->p_ca_cb = NULL;
1754#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001755}
Hanno Becker5adaad92019-03-27 16:54:37 +00001756
1757#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001758void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1759 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1760 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001761{
1762 conf->f_ca_cb = f_ca_cb;
1763 conf->p_ca_cb = p_ca_cb;
1764
1765 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1766 * cannot be used together. */
1767 conf->ca_chain = NULL;
1768 conf->ca_crl = NULL;
1769}
1770#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001772
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001773#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001774const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1775 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001776{
1777 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001778 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001779}
1780
Gilles Peskine449bd832023-01-11 14:50:10 +01001781int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1782 mbedtls_x509_crt *own_cert,
1783 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001784{
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1786 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001787}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001788
Gilles Peskine449bd832023-01-11 14:50:10 +01001789void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1790 mbedtls_x509_crt *ca_chain,
1791 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001792{
1793 ssl->handshake->sni_ca_chain = ca_chain;
1794 ssl->handshake->sni_ca_crl = ca_crl;
1795}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001796
Glenn Strauss999ef702022-03-11 01:37:23 -05001797#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001798void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1799 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001800{
1801 ssl->handshake->dn_hints = crt;
1802}
1803#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1804
Gilles Peskine449bd832023-01-11 14:50:10 +01001805void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1806 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001807{
1808 ssl->handshake->sni_authmode = authmode;
1809}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001810#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1811
Hanno Becker8927c832019-04-03 12:52:50 +01001812#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001813void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1814 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1815 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001816{
1817 ssl->f_vrfy = f_vrfy;
1818 ssl->p_vrfy = p_vrfy;
1819}
1820#endif
1821
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001822#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001823
Przemek Stekielfde11282023-03-13 16:06:09 +01001824static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1825static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1826
Valerio Setti016f6822022-12-09 14:17:50 +01001827static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 mbedtls_ssl_context *ssl,
1829 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001830{
1831 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001832 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001833 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001834 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001835 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001836 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1838 psa_pake_cs_set_primitive(&cipher_suite,
1839 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1840 PSA_ECC_FAMILY_SECP_R1,
1841 256));
1842 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001843
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1845 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001846 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001848
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001850 user = jpake_server_id;
1851 user_len = sizeof(jpake_server_id);
1852 peer = jpake_client_id;
1853 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001855 user = jpake_client_id;
1856 user_len = sizeof(jpake_client_id);
1857 peer = jpake_server_id;
1858 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001860
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001861 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1862 if (status != PSA_SUCCESS) {
1863 return status;
1864 }
1865
1866 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001868 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 }
Valerio Setti016f6822022-12-09 14:17:50 +01001870
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1872 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001873 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 }
Valerio Setti016f6822022-12-09 14:17:50 +01001875
1876 ssl->handshake->psa_pake_ctx_is_ok = 1;
1877
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001879}
1880
Gilles Peskine449bd832023-01-11 14:50:10 +01001881int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1882 const unsigned char *pw,
1883 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001884{
1885 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1886 psa_status_t status;
1887
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 if (ssl->handshake == NULL || ssl->conf == NULL) {
1889 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001890 }
1891
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 /* Empty password is not valid */
1893 if ((pw == NULL) || (pw_len == 0)) {
1894 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1895 }
1896
1897 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1898 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1899 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1900
1901 status = psa_import_key(&attributes, pw, pw_len,
1902 &ssl->handshake->psa_pake_password);
1903 if (status != PSA_SUCCESS) {
1904 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1905 }
1906
1907 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1908 ssl->handshake->psa_pake_password);
1909 if (status != PSA_SUCCESS) {
1910 psa_destroy_key(ssl->handshake->psa_pake_password);
1911 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1912 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1913 }
1914
1915 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001916}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001917
Gilles Peskine449bd832023-01-11 14:50:10 +01001918int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1919 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001920{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001921 psa_status_t status;
1922
Gilles Peskine449bd832023-01-11 14:50:10 +01001923 if (ssl->handshake == NULL || ssl->conf == NULL) {
1924 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001925 }
1926
Gilles Peskine449bd832023-01-11 14:50:10 +01001927 if (mbedtls_svc_key_id_is_null(pwd)) {
1928 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1929 }
1930
1931 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1932 if (status != PSA_SUCCESS) {
1933 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1934 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1935 }
1936
1937 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001938}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001939#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001940
Ronald Cron73fe8df2022-10-05 14:31:43 +02001941#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001942int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001943{
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 if (conf->psk_identity == NULL ||
1945 conf->psk_identity_len == 0) {
1946 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001947 }
1948
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1950 return 1;
1951 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001952
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 if (conf->psk != NULL && conf->psk_len != 0) {
1954 return 1;
1955 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001956
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001958}
1959
Gilles Peskine449bd832023-01-11 14:50:10 +01001960static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001961{
1962 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001964 /* The maintenance of the PSK key slot is the
1965 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001966 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001967 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001969 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001970 conf->psk = NULL;
1971 conf->psk_len = 0;
1972 }
1973
1974 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 if (conf->psk_identity != NULL) {
1976 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001977 conf->psk_identity = NULL;
1978 conf->psk_identity_len = 0;
1979 }
1980}
1981
Hanno Becker7390c712018-11-15 13:33:04 +00001982/* This function assumes that PSK identity in the SSL config is unset.
1983 * It checks that the provided identity is well-formed and attempts
1984 * to make a copy of it in the SSL config.
1985 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001986MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001987static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1988 unsigned char const *psk_identity,
1989 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001990{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001991 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001993 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 (psk_identity_len >> 16) != 0 ||
1995 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1996 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001997 }
1998
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2000 if (conf->psk_identity == NULL) {
2001 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2002 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002003
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002004 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002006
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002008}
2009
Gilles Peskine449bd832023-01-11 14:50:10 +01002010int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2011 const unsigned char *psk, size_t psk_len,
2012 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002013{
Janos Follath865b3eb2019-12-16 11:46:15 +00002014 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002015
2016 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2018 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2019 }
Hanno Becker7390c712018-11-15 13:33:04 +00002020
2021 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 if (psk == NULL) {
2023 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2024 }
2025 if (psk_len == 0) {
2026 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2027 }
2028 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2029 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2030 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002031
Gilles Peskine449bd832023-01-11 14:50:10 +01002032 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2033 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2034 }
Hanno Becker7390c712018-11-15 13:33:04 +00002035 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002037
2038 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2040 if (ret != 0) {
2041 ssl_conf_remove_psk(conf);
2042 }
Hanno Becker7390c712018-11-15 13:33:04 +00002043
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002045}
2046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002048{
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002050 /* The maintenance of the external PSK key slot is the
2051 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 if (ssl->handshake->psk_opaque_is_internal) {
2053 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002054 ssl->handshake->psk_opaque_is_internal = 0;
2055 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002056 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002057 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002058}
2059
Gilles Peskine449bd832023-01-11 14:50:10 +01002060int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2061 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002062{
Neil Armstrong501c9322022-05-03 09:35:09 +02002063 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002064 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002065 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002066 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002067
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 if (psk == NULL || ssl->handshake == NULL) {
2069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2070 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002071
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2073 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2074 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002077
Jerry Yuccc68a42022-07-26 16:39:20 +08002078#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2080 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2081 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2082 } else {
2083 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2084 }
2085 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002086 }
2087#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002088
Jerry Yu568ec252022-07-22 21:27:34 +08002089#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2091 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2092 psa_set_key_usage_flags(&key_attributes,
2093 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002094 }
2095#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2096
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 psa_set_key_algorithm(&key_attributes, alg);
2098 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002099
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2101 if (status != PSA_SUCCESS) {
2102 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2103 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002104
2105 /* Allow calling psa_destroy_key() on psk remove */
2106 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002108}
2109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2111 mbedtls_svc_key_id_t psk,
2112 const unsigned char *psk_identity,
2113 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002114{
Janos Follath865b3eb2019-12-16 11:46:15 +00002115 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002116
2117 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2119 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2120 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002121
Hanno Becker7390c712018-11-15 13:33:04 +00002122 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 if (mbedtls_svc_key_id_is_null(psk)) {
2124 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2125 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002126 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002127
2128 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2130 psk_identity_len);
2131 if (ret != 0) {
2132 ssl_conf_remove_psk(conf);
2133 }
Hanno Becker7390c712018-11-15 13:33:04 +00002134
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002136}
2137
Gilles Peskine449bd832023-01-11 14:50:10 +01002138int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2139 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002140{
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 if ((mbedtls_svc_key_id_is_null(psk)) ||
2142 (ssl->handshake == NULL)) {
2143 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2144 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002145
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002147 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002149}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002150
Jerry Yu8897c072022-08-12 13:56:53 +08002151#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002152void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2153 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2154 size_t),
2155 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002156{
2157 conf->f_psk = f_psk;
2158 conf->p_psk = p_psk;
2159}
Jerry Yu8897c072022-08-12 13:56:53 +08002160#endif /* MBEDTLS_SSL_SRV_C */
2161
Ronald Cron73fe8df2022-10-05 14:31:43 +02002162#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002163
Gilles Peskine301711e2022-04-26 16:57:05 +02002164static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002166{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002167#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 if (alg == PSA_ALG_CBC_NO_PADDING) {
2169 return MBEDTLS_SSL_MODE_CBC;
2170 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002171#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 if (PSA_ALG_IS_AEAD(alg)) {
2173 return MBEDTLS_SSL_MODE_AEAD;
2174 }
2175 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002176}
2177
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002178
Gilles Peskinee108d982022-04-26 16:50:40 +02002179static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2180 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002182{
2183#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2185 base_mode == MBEDTLS_SSL_MODE_CBC) {
2186 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002187 }
2188#else
2189 (void) encrypt_then_mac;
2190#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002192}
2193
Neil Armstrongab555e02022-04-04 11:07:59 +02002194mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002196{
Gilles Peskinee108d982022-04-26 16:50:40 +02002197 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002199 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002200
Gilles Peskinee108d982022-04-26 16:50:40 +02002201 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002202#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002203 encrypt_then_mac = transform->encrypt_then_mac;
2204#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002206}
2207
Neil Armstrongab555e02022-04-04 11:07:59 +02002208mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002209#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002211#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002213{
Gilles Peskinee108d982022-04-26 16:50:40 +02002214 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2215
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002216 psa_status_t status;
2217 psa_algorithm_t alg;
2218 psa_key_type_t type;
2219 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002220 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2221 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 if (status == PSA_SUCCESS) {
2223 base_mode = mbedtls_ssl_get_base_mode(alg);
2224 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002225
Gilles Peskinee108d982022-04-26 16:50:40 +02002226#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2227 int encrypt_then_mac = 0;
2228#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002230}
2231
Jerry Yu251a12e2022-07-13 15:15:48 +08002232
Ronald Cron8b592d22024-11-12 18:08:25 +01002233const mbedtls_error_pair_t psa_to_ssl_errors[] =
2234{
2235 { PSA_SUCCESS, 0 },
2236 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2237 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2238 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2239 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2240 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2241 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2242};
2243
Gilles Peskine449bd832023-01-11 14:50:10 +01002244psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2245 size_t taglen,
2246 psa_algorithm_t *alg,
2247 psa_key_type_t *key_type,
2248 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002249{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002250#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002251 (void) taglen;
2252#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002254#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002255 case MBEDTLS_CIPHER_AES_128_CBC:
2256 *alg = PSA_ALG_CBC_NO_PADDING;
2257 *key_type = PSA_KEY_TYPE_AES;
2258 *key_size = 128;
2259 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002260#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002261#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002262 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002264 *key_type = PSA_KEY_TYPE_AES;
2265 *key_size = 128;
2266 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002267#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002268#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002269 case MBEDTLS_CIPHER_AES_128_GCM:
2270 *alg = PSA_ALG_GCM;
2271 *key_type = PSA_KEY_TYPE_AES;
2272 *key_size = 128;
2273 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002274#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002275#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002276 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002278 *key_type = PSA_KEY_TYPE_AES;
2279 *key_size = 192;
2280 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002281#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002282#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002283 case MBEDTLS_CIPHER_AES_192_GCM:
2284 *alg = PSA_ALG_GCM;
2285 *key_type = PSA_KEY_TYPE_AES;
2286 *key_size = 192;
2287 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002288#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002289#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002290 case MBEDTLS_CIPHER_AES_256_CBC:
2291 *alg = PSA_ALG_CBC_NO_PADDING;
2292 *key_type = PSA_KEY_TYPE_AES;
2293 *key_size = 256;
2294 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002295#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002296#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002297 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002299 *key_type = PSA_KEY_TYPE_AES;
2300 *key_size = 256;
2301 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002302#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002303#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002304 case MBEDTLS_CIPHER_AES_256_GCM:
2305 *alg = PSA_ALG_GCM;
2306 *key_type = PSA_KEY_TYPE_AES;
2307 *key_size = 256;
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_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002311 case MBEDTLS_CIPHER_ARIA_128_CBC:
2312 *alg = PSA_ALG_CBC_NO_PADDING;
2313 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002318 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002320 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002325 case MBEDTLS_CIPHER_ARIA_128_GCM:
2326 *alg = PSA_ALG_GCM;
2327 *key_type = PSA_KEY_TYPE_ARIA;
2328 *key_size = 128;
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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002332 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002334 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002339 case MBEDTLS_CIPHER_ARIA_192_GCM:
2340 *alg = PSA_ALG_GCM;
2341 *key_type = PSA_KEY_TYPE_ARIA;
2342 *key_size = 192;
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_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002346 case MBEDTLS_CIPHER_ARIA_256_CBC:
2347 *alg = PSA_ALG_CBC_NO_PADDING;
2348 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002353 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002355 *key_type = PSA_KEY_TYPE_ARIA;
2356 *key_size = 256;
2357 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002358#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002359#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002360 case MBEDTLS_CIPHER_ARIA_256_GCM:
2361 *alg = PSA_ALG_GCM;
2362 *key_type = PSA_KEY_TYPE_ARIA;
2363 *key_size = 256;
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_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002367 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2368 *alg = PSA_ALG_CBC_NO_PADDING;
2369 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002374 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002376 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002381 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2382 *alg = PSA_ALG_GCM;
2383 *key_type = PSA_KEY_TYPE_CAMELLIA;
2384 *key_size = 128;
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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002388 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002390 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002395 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2396 *alg = PSA_ALG_GCM;
2397 *key_type = PSA_KEY_TYPE_CAMELLIA;
2398 *key_size = 192;
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_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002402 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2403 *alg = PSA_ALG_CBC_NO_PADDING;
2404 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002409 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002411 *key_type = PSA_KEY_TYPE_CAMELLIA;
2412 *key_size = 256;
2413 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002414#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002415#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002416 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2417 *alg = PSA_ALG_GCM;
2418 *key_type = PSA_KEY_TYPE_CAMELLIA;
2419 *key_size = 256;
2420 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002421#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002422#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002423 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2424 *alg = PSA_ALG_CHACHA20_POLY1305;
2425 *key_type = PSA_KEY_TYPE_CHACHA20;
2426 *key_size = 256;
2427 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002428#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002429 case MBEDTLS_CIPHER_NULL:
2430 *alg = MBEDTLS_SSL_NULL_CIPHER;
2431 *key_type = 0;
2432 *key_size = 0;
2433 break;
2434 default:
2435 return PSA_ERROR_NOT_SUPPORTED;
2436 }
2437
2438 return PSA_SUCCESS;
2439}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002440
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002441#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002442int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2443 const unsigned char *dhm_P, size_t P_len,
2444 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002445{
Janos Follath865b3eb2019-12-16 11:46:15 +00002446 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002447
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 mbedtls_mpi_free(&conf->dhm_P);
2449 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002450
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2452 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2453 mbedtls_mpi_free(&conf->dhm_P);
2454 mbedtls_mpi_free(&conf->dhm_G);
2455 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002456 }
2457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002459}
Paul Bakker5121ce52009-01-03 21:22:43 +00002460
Gilles Peskine449bd832023-01-11 14:50:10 +01002461int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002462{
Janos Follath865b3eb2019-12-16 11:46:15 +00002463 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 mbedtls_mpi_free(&conf->dhm_P);
2466 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002467
Gilles Peskine449bd832023-01-11 14:50:10 +01002468 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2469 &conf->dhm_P)) != 0 ||
2470 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2471 &conf->dhm_G)) != 0) {
2472 mbedtls_mpi_free(&conf->dhm_P);
2473 mbedtls_mpi_free(&conf->dhm_G);
2474 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002475 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002476
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002478}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002479#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002480
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002481#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2482/*
2483 * Set the minimum length for Diffie-Hellman parameters
2484 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002485void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2486 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002487{
2488 conf->dhm_min_bitlen = bitlen;
2489}
2490#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2491
Ronald Crone68ab4f2022-10-05 12:46:29 +02002492#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002493#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002494/*
2495 * Set allowed/preferred hashes for handshake signatures
2496 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002497void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2498 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002499{
2500 conf->sig_hashes = hashes;
2501}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002502#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002503
Jerry Yuf017ee42022-01-12 15:49:48 +08002504/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002505void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2506 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002507{
Jerry Yuf017ee42022-01-12 15:49:48 +08002508#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2509 conf->sig_hashes = NULL;
2510#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2511 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002512}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002513#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002514
Brett Warrene0edc842021-08-17 09:53:13 +01002515/*
2516 * Set the allowed groups
2517 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002518void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2519 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002520{
Brett Warrene0edc842021-08-17 09:53:13 +01002521 conf->group_list = group_list;
2522}
2523
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002524#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002525int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002526{
Hanno Becker947194e2017-04-07 13:25:49 +01002527 /* Initialize to suppress unnecessary compiler warning */
2528 size_t hostname_len = 0;
2529
2530 /* Check if new hostname is valid before
2531 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 if (hostname != NULL) {
2533 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2536 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2537 }
Hanno Becker947194e2017-04-07 13:25:49 +01002538 }
2539
2540 /* Now it's clear that we will overwrite the old hostname,
2541 * so we can free it safely */
2542
Gilles Peskine449bd832023-01-11 14:50:10 +01002543 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002544 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002545 }
2546
2547 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002548
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002550 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 } else {
2552 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2553 if (ssl->hostname == NULL) {
2554 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2555 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002558
Hanno Becker947194e2017-04-07 13:25:49 +01002559 ssl->hostname[hostname_len] = '\0';
2560 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002561
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002563}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002564#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002565
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002566#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002567void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2568 int (*f_sni)(void *, mbedtls_ssl_context *,
2569 const unsigned char *, size_t),
2570 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002571{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002572 conf->f_sni = f_sni;
2573 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002574}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002576
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002577#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002578int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002579{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002580 size_t cur_len, tot_len;
2581 const char **p;
2582
2583 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002584 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2585 * MUST NOT be truncated."
2586 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002587 */
2588 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 for (p = protos; *p != NULL; p++) {
2590 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002591 tot_len += cur_len;
2592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 if ((cur_len == 0) ||
2594 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2595 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2596 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2597 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002598 }
2599
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002600 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002601
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002603}
2604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002606{
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002608}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002610
Johan Pascalb62bb512015-12-03 21:56:45 +01002611#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002612void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2613 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002614{
2615 conf->dtls_srtp_mki_support = support_mki_value;
2616}
2617
Gilles Peskine449bd832023-01-11 14:50:10 +01002618int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2619 unsigned char *mki_value,
2620 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002621{
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2623 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002624 }
Ron Eldor591f1622018-01-22 12:30:04 +02002625
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2627 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002628 }
Ron Eldor591f1622018-01-22 12:30:04 +02002629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002631 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002633}
2634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2636 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002637{
Johan Pascal253d0262020-09-22 13:04:45 +02002638 const mbedtls_ssl_srtp_profile *p;
2639 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002640
Johan Pascal253d0262020-09-22 13:04:45 +02002641 /* check the profiles list: all entry must be valid,
2642 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2644 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2645 p++) {
2646 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002647 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002649 /* unsupported value, stop parsing and set the size to an error value */
2650 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002651 }
2652 }
2653
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2655 conf->dtls_srtp_profile_list = NULL;
2656 conf->dtls_srtp_profile_list_len = 0;
2657 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002658 }
2659
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002660 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002661 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002664}
2665
Gilles Peskine449bd832023-01-11 14:50:10 +01002666void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2667 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002668{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002669 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2670 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002672 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002674 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2676 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002677 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002678}
Johan Pascalb62bb512015-12-03 21:56:45 +01002679#endif /* MBEDTLS_SSL_DTLS_SRTP */
2680
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302681#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002682void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002683{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002684 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002685}
2686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002688{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002689 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002690}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302691#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002692
Janos Follath088ce432017-04-10 12:42:31 +01002693#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002694void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2695 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002696{
2697 conf->cert_req_ca_list = cert_req_ca_list;
2698}
2699#endif
2700
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002701#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002702void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002703{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002704 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002705}
2706#endif
2707
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002708#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002709void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002710{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002711 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002712}
2713#endif
2714
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002715#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002716int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002717{
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2719 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2720 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002721 }
2722
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002723 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002724
Gilles Peskine449bd832023-01-11 14:50:10 +01002725 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002726}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002728
Gilles Peskine449bd832023-01-11 14:50:10 +01002729void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002730{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002731 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002732}
2733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002735void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002736{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002737 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002738}
2739
Gilles Peskine449bd832023-01-11 14:50:10 +01002740void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002741{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002742 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002743}
2744
Gilles Peskine449bd832023-01-11 14:50:10 +01002745void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2746 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002747{
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002749}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002750#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002751
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002752#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002753#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002754void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002755{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002756 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002757}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002758#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002759
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002760#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002761
Jerry Yud0766ec2022-09-22 10:46:57 +08002762#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002763void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2764 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002765{
Jerry Yud0766ec2022-09-22 10:46:57 +08002766 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002767}
2768#endif
2769
Gilles Peskine449bd832023-01-11 14:50:10 +01002770void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2771 mbedtls_ssl_ticket_write_t *f_ticket_write,
2772 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2773 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002774{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002775 conf->f_ticket_write = f_ticket_write;
2776 conf->f_ticket_parse = f_ticket_parse;
2777 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002778}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002779#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002780#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2783 mbedtls_ssl_export_keys_t *f_export_keys,
2784 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002785{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002786 ssl->f_export_keys = f_export_keys;
2787 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002788}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002789
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002790#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002791void mbedtls_ssl_conf_async_private_cb(
2792 mbedtls_ssl_config *conf,
2793 mbedtls_ssl_async_sign_t *f_async_sign,
2794 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2795 mbedtls_ssl_async_resume_t *f_async_resume,
2796 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002798{
2799 conf->f_async_sign_start = f_async_sign;
2800 conf->f_async_decrypt_start = f_async_decrypt;
2801 conf->f_async_resume = f_async_resume;
2802 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002803 conf->p_async_config_data = async_config_data;
2804}
2805
Gilles Peskine449bd832023-01-11 14:50:10 +01002806void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002807{
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002809}
2810
Gilles Peskine449bd832023-01-11 14:50:10 +01002811void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002812{
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 if (ssl->handshake == NULL) {
2814 return NULL;
2815 } else {
2816 return ssl->handshake->user_async_ctx;
2817 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002818}
2819
Gilles Peskine449bd832023-01-11 14:50:10 +01002820void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2821 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002822{
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002824 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002826}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002827#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002828
Paul Bakker5121ce52009-01-03 21:22:43 +00002829/*
2830 * SSL get accessors
2831 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002832uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002833{
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 if (ssl->session != NULL) {
2835 return ssl->session->verify_result;
2836 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 if (ssl->session_negotiate != NULL) {
2839 return ssl->session_negotiate->verify_result;
2840 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002841
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002843}
2844
Gilles Peskine449bd832023-01-11 14:50:10 +01002845int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002846{
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 if (ssl == NULL || ssl->session == NULL) {
2848 return 0;
2849 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002852}
2853
Gilles Peskine449bd832023-01-11 14:50:10 +01002854const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002855{
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 if (ssl == NULL || ssl->session == NULL) {
2857 return NULL;
2858 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002861}
2862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002864{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002865#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002866 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2867 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002868 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002870 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002872 }
2873 }
2874#endif
2875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002877 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002879 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002881 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002883 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002884}
2885
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002886#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2887
2888size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2889{
2890 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2891 size_t record_size_limit = max_len;
2892
2893 if (ssl->session != NULL &&
2894 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2895 ssl->session->record_size_limit < max_len) {
2896 record_size_limit = ssl->session->record_size_limit;
2897 }
2898
2899 // TODO: this is currently untested
2900 /* During a handshake, use the value being negotiated */
2901 if (ssl->session_negotiate != NULL &&
2902 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2903 ssl->session_negotiate->record_size_limit < max_len) {
2904 record_size_limit = ssl->session_negotiate->record_size_limit;
2905 }
2906
2907 return record_size_limit;
2908}
2909#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2910
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002911#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002912size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002913{
David Horstmann95d516f2021-05-04 18:36:56 +01002914 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002915 size_t read_mfl;
2916
Jerry Yuddda0502022-12-01 19:43:12 +08002917#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002918 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2920 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2921 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002922 }
Jerry Yuddda0502022-12-01 19:43:12 +08002923#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002924
2925 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 if (ssl->session_out != NULL) {
2927 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2928 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002929 max_len = read_mfl;
2930 }
2931 }
2932
Jerry Yuddda0502022-12-01 19:43:12 +08002933 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 if (ssl->session_negotiate != NULL) {
2935 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2936 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002937 max_len = read_mfl;
2938 }
2939 }
2940
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002942}
2943
Gilles Peskine449bd832023-01-11 14:50:10 +01002944size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002945{
2946 size_t max_len;
2947
2948 /*
2949 * Assume mfl_code is correct since it was checked when set
2950 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002952
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002953 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 if (ssl->session_out != NULL &&
2955 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2956 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002957 }
2958
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002959 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 if (ssl->session_negotiate != NULL &&
2961 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2962 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002963 }
2964
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002966}
2967#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2968
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002969#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002970size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002971{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002972 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2974 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2975 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2976 return 0;
2977 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002978
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2980 return ssl->mtu;
2981 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 if (ssl->mtu == 0) {
2984 return ssl->handshake->mtu;
2985 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002986
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 return ssl->mtu < ssl->handshake->mtu ?
2988 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002989}
2990#endif /* MBEDTLS_SSL_PROTO_DTLS */
2991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002993{
2994 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2995
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002996#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002997 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002998 !defined(MBEDTLS_SSL_PROTO_DTLS)
2999 (void) ssl;
3000#endif
3001
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003002#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003006 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003008#endif
3009
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003010#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3011 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3012
3013 if (max_len > record_size_limit) {
3014 max_len = record_size_limit;
3015 }
3016#endif
3017
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003018 if (ssl->transform_out != NULL &&
3019 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003020 /*
3021 * In TLS 1.3 case, when records are protected, `max_len` as computed
3022 * above is the maximum length of the TLSInnerPlaintext structure that
3023 * along the plaintext payload contains the inner content type (one byte)
3024 * and some zero padding. Given the algorithm used for padding
3025 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3026 * the plaintext payload. Round down to a multiple of
3027 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3028 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003029 */
3030 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3031 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3032 }
3033
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003034#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3036 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3037 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003038 const size_t overhead = (size_t) ret;
3039
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 if (ret < 0) {
3041 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003042 }
3043
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 if (mtu <= overhead) {
3045 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3046 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3047 }
3048
3049 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003050 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003052 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003053#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003054
Hanno Becker0defedb2018-08-10 12:35:02 +01003055#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003056 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3057 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003058 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003059#endif
3060
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003062}
3063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003065{
3066 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3067
3068#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3069 (void) ssl;
3070#endif
3071
3072#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003074
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003076 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003078#endif
3079
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003081}
3082
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003083#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003084const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003085{
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 if (ssl == NULL || ssl->session == NULL) {
3087 return NULL;
3088 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003089
Hanno Beckere6824572019-02-07 13:18:46 +00003090#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003092#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003094#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003095}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003096#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003098#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003099int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3100 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003101{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003102 int ret;
3103
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003105 dst == NULL ||
3106 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3108 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003109 }
3110
Hanno Beckere810bbc2021-05-14 16:01:05 +01003111 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3112 * idempotent: Each session can only be exported once.
3113 *
3114 * (This is in preparation for TLS 1.3 support where we will
3115 * need the ability to export multiple sessions (aka tickets),
3116 * which will be achieved by calling mbedtls_ssl_get_session()
3117 * multiple times until it fails.)
3118 *
3119 * Check whether we have already exported the current session,
3120 * and fail if so.
3121 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 if (ssl->session->exported == 1) {
3123 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3124 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003125
Gilles Peskine449bd832023-01-11 14:50:10 +01003126 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3127 if (ret != 0) {
3128 return ret;
3129 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003130
3131 /* Remember that we've exported the session. */
3132 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003134}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003136
David Horstmanncb01b362024-02-29 17:31:46 +00003137#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3138
3139/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003140 *
David Horstmanncb01b362024-02-29 17:31:46 +00003141 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003142 */
3143static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3144 unsigned char *buf,
3145 size_t buf_len)
3146{
3147 unsigned char *p = buf;
3148 size_t used = 0;
3149
3150#if defined(MBEDTLS_HAVE_TIME)
3151 uint64_t start;
3152#endif
3153#if defined(MBEDTLS_X509_CRT_PARSE_C)
3154#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3155 size_t cert_len;
3156#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3157#endif /* MBEDTLS_X509_CRT_PARSE_C */
3158
3159 /*
3160 * Time
3161 */
3162#if defined(MBEDTLS_HAVE_TIME)
3163 used += 8;
3164
3165 if (used <= buf_len) {
3166 start = (uint64_t) session->start;
3167
3168 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3169 p += 8;
3170 }
3171#endif /* MBEDTLS_HAVE_TIME */
3172
3173 /*
3174 * Basic mandatory fields
3175 */
3176 used += 1 /* id_len */
3177 + sizeof(session->id)
3178 + sizeof(session->master)
3179 + 4; /* verify_result */
3180
3181 if (used <= buf_len) {
3182 *p++ = MBEDTLS_BYTE_0(session->id_len);
3183 memcpy(p, session->id, 32);
3184 p += 32;
3185
3186 memcpy(p, session->master, 48);
3187 p += 48;
3188
3189 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3190 p += 4;
3191 }
3192
3193 /*
3194 * Peer's end-entity certificate
3195 */
3196#if defined(MBEDTLS_X509_CRT_PARSE_C)
3197#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3198 if (session->peer_cert == NULL) {
3199 cert_len = 0;
3200 } else {
3201 cert_len = session->peer_cert->raw.len;
3202 }
3203
3204 used += 3 + cert_len;
3205
3206 if (used <= buf_len) {
3207 *p++ = MBEDTLS_BYTE_2(cert_len);
3208 *p++ = MBEDTLS_BYTE_1(cert_len);
3209 *p++ = MBEDTLS_BYTE_0(cert_len);
3210
3211 if (session->peer_cert != NULL) {
3212 memcpy(p, session->peer_cert->raw.p, cert_len);
3213 p += cert_len;
3214 }
3215 }
3216#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3217 if (session->peer_cert_digest != NULL) {
3218 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3219 if (used <= buf_len) {
3220 *p++ = (unsigned char) session->peer_cert_digest_type;
3221 *p++ = (unsigned char) session->peer_cert_digest_len;
3222 memcpy(p, session->peer_cert_digest,
3223 session->peer_cert_digest_len);
3224 p += session->peer_cert_digest_len;
3225 }
3226 } else {
3227 used += 2;
3228 if (used <= buf_len) {
3229 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3230 *p++ = 0;
3231 }
3232 }
3233#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3234#endif /* MBEDTLS_X509_CRT_PARSE_C */
3235
3236 /*
3237 * Session ticket if any, plus associated data
3238 */
3239#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3240#if defined(MBEDTLS_SSL_CLI_C)
3241 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3242 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3243
3244 if (used <= buf_len) {
3245 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3246 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3247 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3248
3249 if (session->ticket != NULL) {
3250 memcpy(p, session->ticket, session->ticket_len);
3251 p += session->ticket_len;
3252 }
3253
3254 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3255 p += 4;
3256 }
3257 }
3258#endif /* MBEDTLS_SSL_CLI_C */
3259#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3260 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3261 used += 8;
3262
3263 if (used <= buf_len) {
3264 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3265 p += 8;
3266 }
3267 }
3268#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3269#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3270
3271 /*
3272 * Misc extension-related info
3273 */
3274#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3275 used += 1;
3276
3277 if (used <= buf_len) {
3278 *p++ = session->mfl_code;
3279 }
3280#endif
3281
3282#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3283 used += 1;
3284
3285 if (used <= buf_len) {
3286 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3287 }
3288#endif
3289
3290 return used;
3291}
3292
3293MBEDTLS_CHECK_RETURN_CRITICAL
3294static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3295 const unsigned char *buf,
3296 size_t len)
3297{
3298#if defined(MBEDTLS_HAVE_TIME)
3299 uint64_t start;
3300#endif
3301#if defined(MBEDTLS_X509_CRT_PARSE_C)
3302#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3303 size_t cert_len;
3304#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3305#endif /* MBEDTLS_X509_CRT_PARSE_C */
3306
3307 const unsigned char *p = buf;
3308 const unsigned char * const end = buf + len;
3309
3310 /*
3311 * Time
3312 */
3313#if defined(MBEDTLS_HAVE_TIME)
3314 if (8 > (size_t) (end - p)) {
3315 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3316 }
3317
3318 start = MBEDTLS_GET_UINT64_BE(p, 0);
3319 p += 8;
3320
3321 session->start = (time_t) start;
3322#endif /* MBEDTLS_HAVE_TIME */
3323
3324 /*
3325 * Basic mandatory fields
3326 */
3327 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3328 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3329 }
3330
3331 session->id_len = *p++;
3332 memcpy(session->id, p, 32);
3333 p += 32;
3334
3335 memcpy(session->master, p, 48);
3336 p += 48;
3337
3338 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3339 p += 4;
3340
3341 /* Immediately clear invalid pointer values that have been read, in case
3342 * we exit early before we replaced them with valid ones. */
3343#if defined(MBEDTLS_X509_CRT_PARSE_C)
3344#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3345 session->peer_cert = NULL;
3346#else
3347 session->peer_cert_digest = NULL;
3348#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3349#endif /* MBEDTLS_X509_CRT_PARSE_C */
3350#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3351 session->ticket = NULL;
3352#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3353
3354 /*
3355 * Peer certificate
3356 */
3357#if defined(MBEDTLS_X509_CRT_PARSE_C)
3358#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3359 /* Deserialize CRT from the end of the ticket. */
3360 if (3 > (size_t) (end - p)) {
3361 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3362 }
3363
3364 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3365 p += 3;
3366
3367 if (cert_len != 0) {
3368 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3369
3370 if (cert_len > (size_t) (end - p)) {
3371 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3372 }
3373
3374 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3375
3376 if (session->peer_cert == NULL) {
3377 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3378 }
3379
3380 mbedtls_x509_crt_init(session->peer_cert);
3381
3382 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3383 p, cert_len)) != 0) {
3384 mbedtls_x509_crt_free(session->peer_cert);
3385 mbedtls_free(session->peer_cert);
3386 session->peer_cert = NULL;
3387 return ret;
3388 }
3389
3390 p += cert_len;
3391 }
3392#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3393 /* Deserialize CRT digest from the end of the ticket. */
3394 if (2 > (size_t) (end - p)) {
3395 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3396 }
3397
3398 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3399 session->peer_cert_digest_len = (size_t) *p++;
3400
3401 if (session->peer_cert_digest_len != 0) {
3402 const mbedtls_md_info_t *md_info =
3403 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3404 if (md_info == NULL) {
3405 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3406 }
3407 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3408 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3409 }
3410
3411 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3412 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3413 }
3414
3415 session->peer_cert_digest =
3416 mbedtls_calloc(1, session->peer_cert_digest_len);
3417 if (session->peer_cert_digest == NULL) {
3418 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3419 }
3420
3421 memcpy(session->peer_cert_digest, p,
3422 session->peer_cert_digest_len);
3423 p += session->peer_cert_digest_len;
3424 }
3425#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3426#endif /* MBEDTLS_X509_CRT_PARSE_C */
3427
3428 /*
3429 * Session ticket and associated data
3430 */
3431#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3432#if defined(MBEDTLS_SSL_CLI_C)
3433 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3434 if (3 > (size_t) (end - p)) {
3435 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3436 }
3437
3438 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3439 p += 3;
3440
3441 if (session->ticket_len != 0) {
3442 if (session->ticket_len > (size_t) (end - p)) {
3443 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3444 }
3445
3446 session->ticket = mbedtls_calloc(1, session->ticket_len);
3447 if (session->ticket == NULL) {
3448 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3449 }
3450
3451 memcpy(session->ticket, p, session->ticket_len);
3452 p += session->ticket_len;
3453 }
3454
3455 if (4 > (size_t) (end - p)) {
3456 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3457 }
3458
3459 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3460 p += 4;
3461 }
3462#endif /* MBEDTLS_SSL_CLI_C */
3463#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3464 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3465 if (8 > (size_t) (end - p)) {
3466 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3467 }
3468 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3469 p += 8;
3470 }
3471#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3472#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3473
3474 /*
3475 * Misc extension-related info
3476 */
3477#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3478 if (1 > (size_t) (end - p)) {
3479 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3480 }
3481
3482 session->mfl_code = *p++;
3483#endif
3484
3485#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3486 if (1 > (size_t) (end - p)) {
3487 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3488 }
3489
3490 session->encrypt_then_mac = *p++;
3491#endif
3492
3493 /* Done, should have consumed entire buffer */
3494 if (p != end) {
3495 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3496 }
3497
3498 return 0;
3499}
3500
3501#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3502
3503#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3504/* Serialization of TLS 1.3 sessions:
3505 *
David Horstmanncb01b362024-02-29 17:31:46 +00003506 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003507 */
3508#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3509MBEDTLS_CHECK_RETURN_CRITICAL
3510static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3511 unsigned char *buf,
3512 size_t buf_len,
3513 size_t *olen)
3514{
3515 unsigned char *p = buf;
3516#if defined(MBEDTLS_SSL_CLI_C) && \
3517 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3518 size_t hostname_len = (session->hostname == NULL) ?
3519 0 : strlen(session->hostname) + 1;
3520#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003521
3522#if defined(MBEDTLS_SSL_SRV_C) && \
3523 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003524 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003525 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003526#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003527 size_t needed = 4 /* ticket_age_add */
3528 + 1 /* ticket_flags */
3529 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003530
David Horstmanne59f9702024-02-29 16:08:57 +00003531 *olen = 0;
3532
3533 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3534 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3535 }
3536 needed += session->resumption_key_len; /* resumption_key */
3537
3538#if defined(MBEDTLS_SSL_EARLY_DATA)
3539 needed += 4; /* max_early_data_size */
3540#endif
3541#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3542 needed += 2; /* record_size_limit */
3543#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3544
3545#if defined(MBEDTLS_HAVE_TIME)
3546 needed += 8; /* ticket_creation_time or ticket_reception_time */
3547#endif
3548
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003549#if defined(MBEDTLS_SSL_SRV_C)
3550 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3551#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003552 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003553 + alpn_len; /* alpn */
3554#endif
3555 }
3556#endif /* MBEDTLS_SSL_SRV_C */
3557
David Horstmanne59f9702024-02-29 16:08:57 +00003558#if defined(MBEDTLS_SSL_CLI_C)
3559 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3560#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3561 needed += 2 /* hostname_len */
3562 + hostname_len; /* hostname */
3563#endif
3564
3565 needed += 4 /* ticket_lifetime */
3566 + 2; /* ticket_len */
3567
3568 /* Check size_t overflow */
3569 if (session->ticket_len > SIZE_MAX - needed) {
3570 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3571 }
3572
3573 needed += session->ticket_len; /* ticket */
3574 }
3575#endif /* MBEDTLS_SSL_CLI_C */
3576
3577 *olen = needed;
3578 if (needed > buf_len) {
3579 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3580 }
3581
3582 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3583 p[4] = session->ticket_flags;
3584
3585 /* save resumption_key */
3586 p[5] = session->resumption_key_len;
3587 p += 6;
3588 memcpy(p, session->resumption_key, session->resumption_key_len);
3589 p += session->resumption_key_len;
3590
3591#if defined(MBEDTLS_SSL_EARLY_DATA)
3592 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3593 p += 4;
3594#endif
3595#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3596 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3597 p += 2;
3598#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3599
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003600#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003601 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003602#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003603 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3604 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003605#endif /* MBEDTLS_HAVE_TIME */
3606
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003607#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003608 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3609 p += 2;
3610
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003611 if (alpn_len > 0) {
3612 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003613 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003614 p += alpn_len;
3615 }
3616#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3617 }
3618#endif /* MBEDTLS_SSL_SRV_C */
3619
David Horstmanne59f9702024-02-29 16:08:57 +00003620#if defined(MBEDTLS_SSL_CLI_C)
3621 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3622#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3623 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3624 p += 2;
3625 if (hostname_len > 0) {
3626 /* save host name */
3627 memcpy(p, session->hostname, hostname_len);
3628 p += hostname_len;
3629 }
3630#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3631
3632#if defined(MBEDTLS_HAVE_TIME)
3633 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3634 p += 8;
3635#endif
3636 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3637 p += 4;
3638
3639 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3640 p += 2;
3641
3642 if (session->ticket != NULL && session->ticket_len > 0) {
3643 memcpy(p, session->ticket, session->ticket_len);
3644 p += session->ticket_len;
3645 }
3646 }
3647#endif /* MBEDTLS_SSL_CLI_C */
3648 return 0;
3649}
3650
3651MBEDTLS_CHECK_RETURN_CRITICAL
3652static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3653 const unsigned char *buf,
3654 size_t len)
3655{
3656 const unsigned char *p = buf;
3657 const unsigned char *end = buf + len;
3658
3659 if (end - p < 6) {
3660 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3661 }
3662 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3663 session->ticket_flags = p[4];
3664
3665 /* load resumption_key */
3666 session->resumption_key_len = p[5];
3667 p += 6;
3668
3669 if (end - p < session->resumption_key_len) {
3670 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3671 }
3672
3673 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3674 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3675 }
3676 memcpy(session->resumption_key, p, session->resumption_key_len);
3677 p += session->resumption_key_len;
3678
3679#if defined(MBEDTLS_SSL_EARLY_DATA)
3680 if (end - p < 4) {
3681 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3682 }
3683 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3684 p += 4;
3685#endif
3686#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3687 if (end - p < 2) {
3688 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3689 }
3690 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3691 p += 2;
3692#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3693
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003694#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003695 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003696#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003697 if (end - p < 8) {
3698 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3699 }
3700 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3701 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003702#endif /* MBEDTLS_HAVE_TIME */
3703
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003704#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003705 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003706
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003707 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003708 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3709 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003710
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003711 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3712 p += 2;
3713
3714 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003715 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3716 }
3717
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003718 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003719 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3720 if (ret != 0) {
3721 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003722 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003723 p += alpn_len;
3724 }
3725#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3726 }
3727#endif /* MBEDTLS_SSL_SRV_C */
3728
David Horstmanne59f9702024-02-29 16:08:57 +00003729#if defined(MBEDTLS_SSL_CLI_C)
3730 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3731#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3732 size_t hostname_len;
3733 /* load host name */
3734 if (end - p < 2) {
3735 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3736 }
3737 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3738 p += 2;
3739
3740 if (end - p < (long int) hostname_len) {
3741 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3742 }
3743 if (hostname_len > 0) {
3744 session->hostname = mbedtls_calloc(1, hostname_len);
3745 if (session->hostname == NULL) {
3746 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3747 }
3748 memcpy(session->hostname, p, hostname_len);
3749 p += hostname_len;
3750 }
3751#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3752
3753#if defined(MBEDTLS_HAVE_TIME)
3754 if (end - p < 8) {
3755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3756 }
3757 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3758 p += 8;
3759#endif
3760 if (end - p < 4) {
3761 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3762 }
3763 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3764 p += 4;
3765
3766 if (end - p < 2) {
3767 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3768 }
3769 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3770 p += 2;
3771
3772 if (end - p < (long int) session->ticket_len) {
3773 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3774 }
3775 if (session->ticket_len > 0) {
3776 session->ticket = mbedtls_calloc(1, session->ticket_len);
3777 if (session->ticket == NULL) {
3778 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3779 }
3780 memcpy(session->ticket, p, session->ticket_len);
3781 p += session->ticket_len;
3782 }
3783 }
3784#endif /* MBEDTLS_SSL_CLI_C */
3785
3786 return 0;
3787
3788}
3789#else /* MBEDTLS_SSL_SESSION_TICKETS */
3790MBEDTLS_CHECK_RETURN_CRITICAL
3791static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3792 unsigned char *buf,
3793 size_t buf_len,
3794 size_t *olen)
3795{
3796 ((void) session);
3797 ((void) buf);
3798 ((void) buf_len);
3799 *olen = 0;
3800 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3801}
3802
3803static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003804 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003805 size_t buf_len)
3806{
3807 ((void) session);
3808 ((void) buf);
3809 ((void) buf_len);
3810 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3811}
3812#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3813#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3814
Paul Bakker5121ce52009-01-03 21:22:43 +00003815/*
Hanno Beckera835da52019-05-16 12:39:07 +01003816 * Define ticket header determining Mbed TLS version
3817 * and structure of the ticket.
3818 */
3819
Hanno Becker94ef3b32019-05-16 12:50:45 +01003820/*
Hanno Becker50b59662019-05-28 14:30:45 +01003821 * Define bitflag determining compile-time settings influencing
3822 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003823 */
3824
Hanno Becker50b59662019-05-28 14:30:45 +01003825#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003826#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003827#else
Hanno Becker3e088662019-05-29 11:10:18 +01003828#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003829#endif /* MBEDTLS_HAVE_TIME */
3830
3831#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003832#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003833#else
Hanno Becker3e088662019-05-29 11:10:18 +01003834#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003835#endif /* MBEDTLS_X509_CRT_PARSE_C */
3836
David Horstmann5c5a32f2024-02-13 17:53:35 +00003837#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003838#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003839#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003840#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003841#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3842
Hanno Becker94ef3b32019-05-16 12:50:45 +01003843#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003844#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003845#else
Hanno Becker3e088662019-05-29 11:10:18 +01003846#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003847#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3848
3849#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003850#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003851#else
Hanno Becker3e088662019-05-29 11:10:18 +01003852#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003853#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3854
Hanno Becker94ef3b32019-05-16 12:50:45 +01003855#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003856#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003857#else
Hanno Becker3e088662019-05-29 11:10:18 +01003858#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003859#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3860
Hanno Becker94ef3b32019-05-16 12:50:45 +01003861#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3862#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3863#else
3864#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3865#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3866
David Horstmann92b258b2024-02-13 17:23:34 +00003867#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3868#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3869#else
3870#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3871#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3872
3873#if defined(MBEDTLS_SSL_EARLY_DATA)
3874#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3875#else
3876#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3877#endif /* MBEDTLS_SSL_EARLY_DATA */
3878
3879#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3880#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3881#else
3882#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3883#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3884
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003885#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3886 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003887#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3888#else
3889#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3890#endif /* MBEDTLS_SSL_ALPN */
3891
Hanno Becker3e088662019-05-29 11:10:18 +01003892#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3893#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3894#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3895#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003896#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3897#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003898#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003899#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3900#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3901#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003902#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003903
Hanno Becker50b59662019-05-28 14:30:45 +01003904#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003905 ((uint16_t) ( \
3906 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3907 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3908 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3909 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3910 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3911 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003912 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003913 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3914 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003915 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3916 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3917 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3918 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003919 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003920 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003921 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003922
Chien Wong4e9683e2023-12-28 17:07:43 +08003923static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003924 MBEDTLS_VERSION_MAJOR,
3925 MBEDTLS_VERSION_MINOR,
3926 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003927 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3928 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003929};
Hanno Beckera835da52019-05-16 12:39:07 +01003930
3931/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003932 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003933 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003934 *
David Horstmanncb01b362024-02-29 17:31:46 +00003935 * TLS 1.2 session:
3936 *
3937 * struct {
3938 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3939 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3940 * uint32 ticket_lifetime;
3941 * #endif
3942 * } ClientOnlyData;
3943 *
3944 * struct {
3945 * #if defined(MBEDTLS_HAVE_TIME)
3946 * uint64 start_time;
3947 * #endif
3948 * uint8 session_id_len; // at most 32
3949 * opaque session_id[32];
3950 * opaque master[48]; // fixed length in the standard
3951 * uint32 verify_result;
3952 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3953 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3954 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003955 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003956 * opaque peer_cert_digest<0..2^8-1>
3957 * #endif
3958 * select (endpoint) {
3959 * case client: ClientOnlyData;
3960 * case server: uint64 ticket_creation_time;
3961 * };
3962 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3963 * uint8 mfl_code; // up to 255 according to standard
3964 * #endif
3965 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3966 * uint8 encrypt_then_mac; // 0 or 1
3967 * #endif
3968 * } serialized_session_tls12;
3969 *
3970 *
3971 * TLS 1.3 Session:
3972 *
3973 * struct {
3974 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3975 * opaque hostname<0..2^16-1>;
3976 * #endif
3977 * #if defined(MBEDTLS_HAVE_TIME)
3978 * uint64 ticket_reception_time;
3979 * #endif
3980 * uint32 ticket_lifetime;
3981 * opaque ticket<1..2^16-1>;
3982 * } ClientOnlyData;
3983 *
3984 * struct {
3985 * uint32 ticket_age_add;
3986 * uint8 ticket_flags;
3987 * opaque resumption_key<0..255>;
3988 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3989 * uint32 max_early_data_size;
3990 * #endif
3991 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3992 * uint16 record_size_limit;
3993 * #endif
3994 * select ( endpoint ) {
3995 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003996 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003997 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003998 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003999 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004000 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004001 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004002 * #endif
4003 * };
4004 * } serialized_session_tls13;
4005 *
4006 *
4007 * SSL session:
4008 *
4009 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004010 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004011 * opaque mbedtls_version[3]; // library version: major, minor, patch
4012 * opaque session_format[2]; // library-version specific 16-bit field
4013 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004014 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004015 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004016 * Note: When updating the format, remember to keep
4017 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004018 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004019 * // In this version, `session_format` determines
4020 * // the setting of those compile-time
4021 * // configuration options which influence
4022 * // the structure of mbedtls_ssl_session.
4023 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004024 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004025 * // - TLS 1.2 (0x0303)
4026 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004027 * uint8_t endpoint;
4028 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004029 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004030 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004031 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004032 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004033 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004034 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004035 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004036 *
4037 * };
4038 *
4039 * } serialized_session;
4040 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004041 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004042
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004043MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004044static int ssl_session_save(const mbedtls_ssl_session *session,
4045 unsigned char omit_header,
4046 unsigned char *buf,
4047 size_t buf_len,
4048 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004049{
4050 unsigned char *p = buf;
4051 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004052 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004053#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4054 size_t out_len;
4055 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4056#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 if (session == NULL) {
4058 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4059 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004060
Gilles Peskine449bd832023-01-11 14:50:10 +01004061 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004062 /*
4063 * Add Mbed TLS version identifier
4064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004065 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004066
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 if (used <= buf_len) {
4068 memcpy(p, ssl_serialized_session_header,
4069 sizeof(ssl_serialized_session_header));
4070 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004071 }
4072 }
4073
4074 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004075 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004076 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004077 used += 1 /* TLS version */
4078 + 1 /* endpoint */
4079 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004080 if (used <= buf_len) {
4081 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004082 *p++ = session->endpoint;
4083 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4084 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004085 }
4086
4087 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004088 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004089 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004090#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004091 case MBEDTLS_SSL_VERSION_TLS1_2:
4092 used += ssl_tls12_session_save(session, p, remaining_len);
4093 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004094#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4095
Jerry Yu251a12e2022-07-13 15:15:48 +08004096#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 case MBEDTLS_SSL_VERSION_TLS1_3:
4098 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4099 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4100 return ret;
4101 }
4102 used += out_len;
4103 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004104#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4105
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 default:
4107 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004108 }
4109
4110 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 if (used > buf_len) {
4112 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4113 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004114
Gilles Peskine449bd832023-01-11 14:50:10 +01004115 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004116}
4117
4118/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004119 * Public wrapper for ssl_session_save()
4120 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004121int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4122 unsigned char *buf,
4123 size_t buf_len,
4124 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004125{
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004127}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004128
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004129/*
4130 * Deserialize session, see mbedtls_ssl_session_save() for format.
4131 *
4132 * This internal version is wrapped by a public function that cleans up in
4133 * case of error, and has an extra option omit_header.
4134 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004135MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004136static int ssl_session_load(mbedtls_ssl_session *session,
4137 unsigned char omit_header,
4138 const unsigned char *buf,
4139 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004140{
4141 const unsigned char *p = buf;
4142 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004143 size_t remaining_len;
4144
4145
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 if (session == NULL) {
4147 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4148 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004149
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004151 /*
4152 * Check Mbed TLS version identifier
4153 */
4154
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4156 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004157 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004158
4159 if (memcmp(p, ssl_serialized_session_header,
4160 sizeof(ssl_serialized_session_header)) != 0) {
4161 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4162 }
4163 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004164 }
4165
4166 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004167 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004168 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004169 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4171 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004172 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004173 session->endpoint = *p++;
4174 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4175 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004176
4177 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004178 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004180#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004181 case MBEDTLS_SSL_VERSION_TLS1_2:
4182 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004183#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4184
Jerry Yu438ddd82022-07-07 06:55:50 +00004185#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004186 case MBEDTLS_SSL_VERSION_TLS1_3:
4187 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004188#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4189
Gilles Peskine449bd832023-01-11 14:50:10 +01004190 default:
4191 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004192 }
4193}
4194
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004195/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004196 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004197 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004198int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4199 const unsigned char *buf,
4200 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004201{
Gilles Peskine449bd832023-01-11 14:50:10 +01004202 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004203
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 if (ret != 0) {
4205 mbedtls_ssl_session_free(session);
4206 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004207
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004209}
4210
4211/*
Paul Bakker1961b702013-01-25 14:49:24 +01004212 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004213 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004214MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004215static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004216{
4217 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4218
Ronald Cron66dbf912022-02-02 15:33:46 +01004219 /*
4220 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004221 * that were written into the output buffer by the previous handshake step,
4222 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004223 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4224 * We proceed to the next handshake step only when all data from the
4225 * previous one have been sent to the peer, thus we make sure that this is
4226 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4227 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4228 * we have to wait before to go ahead.
4229 * In the case of TLS 1.3, handshake step handlers do not send data to the
4230 * peer. Data are only sent here and through
4231 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004232 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004233 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004234 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4235 return ret;
4236 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004237
4238#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4240 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4241 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4242 return ret;
4243 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004244 }
4245#endif /* MBEDTLS_SSL_PROTO_DTLS */
4246
Gilles Peskine449bd832023-01-11 14:50:10 +01004247 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004248}
4249
Gilles Peskine449bd832023-01-11 14:50:10 +01004250int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004251{
Hanno Becker41934dd2021-08-07 19:13:43 +01004252 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004253
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004255 ssl->conf == NULL ||
4256 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4258 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004259 }
4260
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 ret = ssl_prepare_handshake_step(ssl);
4262 if (ret != 0) {
4263 return ret;
4264 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004265
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 ret = mbedtls_ssl_handle_pending_alert(ssl);
4267 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004268 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004269 }
Jerry Yue7047812021-09-13 19:26:39 +08004270
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004271 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4272 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4273 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004275#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4277 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004278 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004279
Gilles Peskine449bd832023-01-11 14:50:10 +01004280 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004281 case MBEDTLS_SSL_HELLO_REQUEST:
4282 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004283 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004284 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004285
Ronald Cron9f0fba32022-02-10 16:45:15 +01004286 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004288 break;
4289
4290 default:
4291#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4293 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4294 } else {
4295 ret = mbedtls_ssl_handshake_client_step(ssl);
4296 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004297#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004299#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004301#endif
4302 }
Jerry Yub9930e72021-08-06 17:11:51 +08004303 }
Ronald Cron6291b232023-03-08 15:51:25 +01004304#endif /* MBEDTLS_SSL_CLI_C */
4305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004306#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004308#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4309 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004311 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 ret = mbedtls_ssl_handshake_server_step(ssl);
4313 }
Ronald Cron6291b232023-03-08 15:51:25 +01004314#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4315 ret = mbedtls_ssl_handshake_server_step(ssl);
4316#else
4317 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004318#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004319 }
4320#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004321
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004323 /* handshake_step return error. And it is same
4324 * with alert_reason.
4325 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 if (ssl->send_alert) {
4327 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004328 goto cleanup;
4329 }
4330 }
4331
4332cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004334}
4335
4336/*
4337 * Perform the SSL handshake
4338 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004339int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004340{
4341 int ret = 0;
4342
Hanno Beckera817ea42020-10-20 15:20:23 +01004343 /* Sanity checks */
4344
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 if (ssl == NULL || ssl->conf == NULL) {
4346 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4347 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004348
Hanno Beckera817ea42020-10-20 15:20:23 +01004349#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4351 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4352 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4353 "mbedtls_ssl_set_timer_cb() for DTLS"));
4354 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004355 }
4356#endif /* MBEDTLS_SSL_PROTO_DTLS */
4357
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004359
Hanno Beckera817ea42020-10-20 15:20:23 +01004360 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4362 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004363
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004365 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 }
Paul Bakker1961b702013-01-25 14:49:24 +01004367 }
4368
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004370
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004372}
4373
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004374#if defined(MBEDTLS_SSL_RENEGOTIATION)
4375#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004376/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004377 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004378 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004379MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004380static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004381{
Janos Follath865b3eb2019-12-16 11:46:15 +00004382 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004383
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004385
4386 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004387 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4388 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004389
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4391 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4392 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004393 }
4394
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004396
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004398}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004399#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004400
4401/*
4402 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004403 * - any side: calling mbedtls_ssl_renegotiate(),
4404 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4405 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004406 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004407 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004408 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004409 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004410int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004411{
Janos Follath865b3eb2019-12-16 11:46:15 +00004412 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004413
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004415
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 if ((ret = ssl_handshake_init(ssl)) != 0) {
4417 return ret;
4418 }
Paul Bakker48916f92012-09-16 19:57:18 +00004419
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004420 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4421 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004422#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4424 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4425 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004426 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004428 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004430 }
4431#endif
4432
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004433 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4434 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004435
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4437 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4438 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004439 }
4440
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004442
Gilles Peskine449bd832023-01-11 14:50:10 +01004443 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004444}
4445
4446/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004447 * Renegotiate current connection on client,
4448 * or request renegotiation on server
4449 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004450int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004451{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004452 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004453
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 if (ssl == NULL || ssl->conf == NULL) {
4455 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4456 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004457
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004458#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004459 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4461 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4462 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4463 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004464
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004465 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004466
4467 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 if (ssl->out_left != 0) {
4469 return mbedtls_ssl_flush_output(ssl);
4470 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004471
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004473 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004474#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004475
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004476#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004477 /*
4478 * On client, either start the renegotiation process or,
4479 * if already in progress, continue the handshake
4480 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4482 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4483 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004484 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004485
4486 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4487 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4488 return ret;
4489 }
4490 } else {
4491 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4492 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4493 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004494 }
4495 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004496#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004499}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004500#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004501
Gilles Peskine449bd832023-01-11 14:50:10 +01004502void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004503{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004504 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4505
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004507 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004509
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004510#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004511#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 if (ssl->handshake->group_list_heap_allocated) {
4513 mbedtls_free((void *) handshake->group_list);
4514 }
Brett Warrene0edc842021-08-17 09:53:13 +01004515 handshake->group_list = NULL;
4516#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004517#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004518
Ronald Crone68ab4f2022-10-05 12:46:29 +02004519#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004520#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 if (ssl->handshake->sig_algs_heap_allocated) {
4522 mbedtls_free((void *) handshake->sig_algs);
4523 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004524 handshake->sig_algs = NULL;
4525#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004526#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (ssl->handshake->certificate_request_context) {
4528 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004529 }
4530#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004531#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004532
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004533#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4535 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004536 handshake->async_in_progress = 0;
4537 }
4538#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4539
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004540#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004542#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004543#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004545#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004546
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004547#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004549#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004550
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004551#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004553 /*
4554 * Opaque keys are not stored in the handshake's data and it's the user
4555 * responsibility to destroy them. Clear ones, instead, are created by
4556 * the TLS library and should be destroyed at the same level
4557 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4559 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004560 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004561 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004562#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004564 handshake->ecjpake_cache = NULL;
4565 handshake->ecjpake_cache_len = 0;
4566#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004567#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004568
Valerio Setti7aeec542023-07-05 18:57:21 +02004569#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004570 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004571 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004572 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004574#endif
4575
Ronald Cron73fe8df2022-10-05 14:31:43 +02004576#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004578 /* The maintenance of the external PSK key slot is the
4579 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (ssl->handshake->psk_opaque_is_internal) {
4581 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004582 ssl->handshake->psk_opaque_is_internal = 0;
4583 }
4584 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4585 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004586#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004587
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004588#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4589 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004590 /*
4591 * Free only the linked list wrapper, not the keys themselves
4592 * since the belong to the SNI callback
4593 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004595#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004596
Gilles Peskineeccd8882020-03-10 12:19:08 +01004597#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4599 if (handshake->ecrs_peer_cert != NULL) {
4600 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4601 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004602 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004603#endif
4604
Hanno Becker75173122019-02-06 16:18:31 +00004605#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4606 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004608#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4609
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004610#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4612 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004613#endif /* MBEDTLS_SSL_CLI_C &&
4614 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004615
4616#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 mbedtls_ssl_flight_free(handshake->flight);
4618 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004619#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004620
Valerio Settiea59c432023-07-25 11:14:03 +02004621#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004622 if (handshake->xxdh_psa_privkey_is_external == 0) {
4623 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 }
Valerio Settiea59c432023-07-25 11:14:03 +02004625#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004626
Ronald Cron6f135e12021-12-08 16:57:54 +01004627#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 mbedtls_ssl_transform_free(handshake->transform_handshake);
4629 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004630#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4632 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004633#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004634#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004635
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004636
4637#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4638 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4639 * processes datagrams and the fact that a datagram is allowed to have
4640 * several records in it, it is possible that the I/O buffers are not
4641 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4643 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004644#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004645
Jerry Yuba9c7272021-10-30 11:54:10 +08004646 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 mbedtls_platform_zeroize(handshake,
4648 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004649}
4650
Gilles Peskine449bd832023-01-11 14:50:10 +01004651void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004652{
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004654 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004656
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004657#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004659#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004660
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004661#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004662#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4663 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004665#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004667#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004668
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004669#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4670 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004671 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004672#endif
4673
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004675}
4676
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004677#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004678
4679#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4680#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4681#else
4682#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4683#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4684
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004685#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004686
4687#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4688#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4689#else
4690#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4691#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4692
4693#if defined(MBEDTLS_SSL_ALPN)
4694#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4695#else
4696#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4697#endif /* MBEDTLS_SSL_ALPN */
4698
4699#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4700#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4701#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4702#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4703
4704#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 ((uint32_t) ( \
4706 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4707 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4708 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4709 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4710 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4711 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4712 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4713 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004714
Chien Wong4e9683e2023-12-28 17:07:43 +08004715static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004716 MBEDTLS_VERSION_MAJOR,
4717 MBEDTLS_VERSION_MINOR,
4718 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4720 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4721 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4722 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4723 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004724};
4725
Paul Bakker5121ce52009-01-03 21:22:43 +00004726/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004727 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004728 *
4729 * The format of the serialized data is:
4730 * (in the presentation language of TLS, RFC 8446 section 3)
4731 *
4732 * // header
4733 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004734 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004735 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004736 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004737 * Note: When updating the format, remember to keep these
4738 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004739 *
4740 * // session sub-structure
4741 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4742 * // transform sub-structure
4743 * uint8 random[64]; // ServerHello.random+ClientHello.random
4744 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4745 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4746 * // fields from ssl_context
4747 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4748 * uint64 in_window_top; // DTLS: last validated record seq_num
4749 * uint64 in_window; // DTLS: bitmask for replay protection
4750 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4751 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4752 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4753 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4754 *
4755 * Note that many fields of the ssl_context or sub-structures are not
4756 * serialized, as they fall in one of the following categories:
4757 *
4758 * 1. forced value (eg in_left must be 0)
4759 * 2. pointer to dynamically-allocated memory (eg session, transform)
4760 * 3. value can be re-derived from other data (eg session keys from MS)
4761 * 4. value was temporary (eg content of input buffer)
4762 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004763 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004764int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4765 unsigned char *buf,
4766 size_t buf_len,
4767 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004768{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004769 unsigned char *p = buf;
4770 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004771 size_t session_len;
4772 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004773
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004774 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004775 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4776 * this function's documentation.
4777 *
4778 * These are due to assumptions/limitations in the implementation. Some of
4779 * them are likely to stay (no handshake in progress) some might go away
4780 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004781 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004782 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4784 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4785 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004786 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 if (ssl->handshake != NULL) {
4788 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4789 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004790 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004791 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 if (ssl->transform == NULL || ssl->session == NULL) {
4793 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4794 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004795 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004796 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if (mbedtls_ssl_check_pending(ssl) != 0) {
4798 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4799 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004800 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 if (ssl->out_left != 0) {
4802 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4803 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004804 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004805 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4807 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4808 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004809 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004810 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4812 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4813 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004814 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004815 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4817 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4818 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004819 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004820 /* Renegotiation must not be enabled */
4821#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4823 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4824 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004825 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004826#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004827
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004828 /*
4829 * Version and format identifier
4830 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 if (used <= buf_len) {
4834 memcpy(p, ssl_serialized_context_header,
4835 sizeof(ssl_serialized_context_header));
4836 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004837 }
4838
4839 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004840 * Session (length + data)
4841 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4843 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4844 return ret;
4845 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004846
4847 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 if (used <= buf_len) {
4849 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004850 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004851
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 ret = ssl_session_save(ssl->session, 1,
4853 p, session_len, &session_len);
4854 if (ret != 0) {
4855 return ret;
4856 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004857
4858 p += session_len;
4859 }
4860
4861 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004862 * Transform
4863 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 used += sizeof(ssl->transform->randbytes);
4865 if (used <= buf_len) {
4866 memcpy(p, ssl->transform->randbytes,
4867 sizeof(ssl->transform->randbytes));
4868 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004869 }
4870
4871#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004872 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004874 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004876 p += ssl->transform->in_cid_len;
4877
4878 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004879 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004880 p += ssl->transform->out_cid_len;
4881 }
4882#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4883
4884 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004885 * Saved fields from top-level ssl_context structure
4886 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004887 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 if (used <= buf_len) {
4889 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004890 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004891 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004892
4893#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4894 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 if (used <= buf_len) {
4896 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004897 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004898
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004900 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004901 }
4902#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4903
4904#if defined(MBEDTLS_SSL_PROTO_DTLS)
4905 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004907 *p++ = ssl->disable_datagram_packing;
4908 }
4909#endif /* MBEDTLS_SSL_PROTO_DTLS */
4910
Jerry Yuae0b2e22021-10-08 15:21:19 +08004911 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 if (used <= buf_len) {
4913 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004914 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004915 }
4916
4917#if defined(MBEDTLS_SSL_PROTO_DTLS)
4918 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 if (used <= buf_len) {
4920 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004921 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004922 }
4923#endif /* MBEDTLS_SSL_PROTO_DTLS */
4924
4925#if defined(MBEDTLS_SSL_ALPN)
4926 {
4927 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004929 : 0;
4930
4931 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004933 *p++ = alpn_len;
4934
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 if (ssl->alpn_chosen != NULL) {
4936 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004937 p += alpn_len;
4938 }
4939 }
4940 }
4941#endif /* MBEDTLS_SSL_ALPN */
4942
4943 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004944 * Done
4945 */
4946 *olen = used;
4947
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 if (used > buf_len) {
4949 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4950 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004951
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004953
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004955}
4956
4957/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004958 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004959 *
4960 * This internal version is wrapped by a public function that cleans up in
4961 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004962 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004963MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004964static int ssl_context_load(mbedtls_ssl_context *ssl,
4965 const unsigned char *buf,
4966 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004967{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004968 const unsigned char *p = buf;
4969 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004970 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004971 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004972#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004973 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004974#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004975
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004976 /*
4977 * The context should have been freshly setup or reset.
4978 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004979 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004980 * renegotiating, or if the user mistakenly loaded a session first.)
4981 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004982 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4983 ssl->session != NULL) {
4984 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004985 }
4986
4987 /*
4988 * We can't check that the config matches the initial one, but we can at
4989 * least check it matches the requirements for serializing.
4990 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004991 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004992#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004993 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004994#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004995 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4996 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4997 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4998 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005000 }
5001
Gilles Peskine449bd832023-01-11 14:50:10 +01005002 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005003
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005004 /*
5005 * Check version identifier
5006 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005007 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5008 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005009 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005010
5011 if (memcmp(p, ssl_serialized_context_header,
5012 sizeof(ssl_serialized_context_header)) != 0) {
5013 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5014 }
5015 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005016
5017 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005018 * Session
5019 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 if ((size_t) (end - p) < 4) {
5021 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5022 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005023
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005024 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005025 p += 4;
5026
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005027 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005028 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005029 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005030 ssl->session_in = ssl->session;
5031 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005032 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005033
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 if ((size_t) (end - p) < session_len) {
5035 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5036 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005037
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 ret = ssl_session_load(ssl->session, 1, p, session_len);
5039 if (ret != 0) {
5040 mbedtls_ssl_session_free(ssl->session);
5041 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005042 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005043
5044 p += session_len;
5045
5046 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005047 * Transform
5048 */
5049
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005050 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005051 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005052#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005053 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005054 ssl->transform_in = ssl->transform;
5055 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005056 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005057#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005058
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005059#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5061 if (prf_func == NULL) {
5062 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5063 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005064
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005065 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005066 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5067 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5068 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005069
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 ret = ssl_tls12_populate_transform(ssl->transform,
5071 ssl->session->ciphersuite,
5072 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005073#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005074 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005075#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 prf_func,
5077 p, /* currently pointing to randbytes */
5078 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5079 ssl->conf->endpoint,
5080 ssl);
5081 if (ret != 0) {
5082 return ret;
5083 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005084#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005086
5087#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5088 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 if ((size_t) (end - p) < 1) {
5090 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5091 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005092
5093 ssl->transform->in_cid_len = *p++;
5094
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5097 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005098
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005100 p += ssl->transform->in_cid_len;
5101
5102 ssl->transform->out_cid_len = *p++;
5103
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5105 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5106 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005107
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005109 p += ssl->transform->out_cid_len;
5110#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5111
5112 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005113 * Saved fields from top-level ssl_context structure
5114 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 if ((size_t) (end - p) < 4) {
5116 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5117 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005118
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005119 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005120 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005121
5122#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 if ((size_t) (end - p) < 16) {
5124 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5125 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005126
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005127 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005128 p += 8;
5129
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005130 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005131 p += 8;
5132#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5133
5134#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 if ((size_t) (end - p) < 1) {
5136 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5137 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005138
5139 ssl->disable_datagram_packing = *p++;
5140#endif /* MBEDTLS_SSL_PROTO_DTLS */
5141
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5143 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5144 }
5145 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5146 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005147
5148#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 if ((size_t) (end - p) < 2) {
5150 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5151 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005152
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005153 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005154 p += 2;
5155#endif /* MBEDTLS_SSL_PROTO_DTLS */
5156
5157#if defined(MBEDTLS_SSL_ALPN)
5158 {
5159 uint8_t alpn_len;
5160 const char **cur;
5161
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 if ((size_t) (end - p) < 1) {
5163 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5164 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005165
5166 alpn_len = *p++;
5167
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005169 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5171 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005172 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005173 ssl->alpn_chosen = *cur;
5174 break;
5175 }
5176 }
5177 }
5178
5179 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5181 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5182 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005183
5184 p += alpn_len;
5185 }
5186#endif /* MBEDTLS_SSL_ALPN */
5187
5188 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005189 * Forced fields from top-level ssl_context structure
5190 *
5191 * Most of them already set to the correct value by mbedtls_ssl_init() and
5192 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5193 */
5194 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005195 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005196
Hanno Becker361b10d2019-08-30 10:42:49 +01005197 /* Adjust pointers for header fields of outgoing records to
5198 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005200
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005201#if defined(MBEDTLS_SSL_PROTO_DTLS)
5202 ssl->in_epoch = 1;
5203#endif
5204
5205 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5206 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005207 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5208 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005209 if (ssl->handshake != NULL) {
5210 mbedtls_ssl_handshake_free(ssl);
5211 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005212 ssl->handshake = NULL;
5213 }
5214
5215 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005216 * Done - should have consumed entire buffer
5217 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 if (p != end) {
5219 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5220 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005221
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005223}
5224
5225/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005226 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005227 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005228int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5229 const unsigned char *buf,
5230 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005231{
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005233
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 if (ret != 0) {
5235 mbedtls_ssl_free(context);
5236 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005237
Gilles Peskine449bd832023-01-11 14:50:10 +01005238 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005239}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005240#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005241
5242/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005243 * Free an SSL context
5244 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005245void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005246{
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005248 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005249 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005250
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005252
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005254#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5255 size_t out_buf_len = ssl->out_buf_len;
5256#else
5257 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5258#endif
5259
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005260 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005261 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005262 }
5263
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005265#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5266 size_t in_buf_len = ssl->in_buf_len;
5267#else
5268 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5269#endif
5270
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005271 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005272 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005273 }
5274
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 if (ssl->transform) {
5276 mbedtls_ssl_transform_free(ssl->transform);
5277 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005278 }
5279
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 if (ssl->handshake) {
5281 mbedtls_ssl_handshake_free(ssl);
5282 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005283
5284#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5286 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005287#endif
5288
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 mbedtls_ssl_session_free(ssl->session_negotiate);
5290 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005291 }
5292
Ronald Cron6f135e12021-12-08 16:57:54 +01005293#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 mbedtls_ssl_transform_free(ssl->transform_application);
5295 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005296#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005297
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 if (ssl->session) {
5299 mbedtls_ssl_session_free(ssl->session);
5300 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005301 }
5302
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005303#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005305 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005306 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005307#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005308
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005309#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005311#endif
5312
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005314
Paul Bakker86f04f42013-02-14 11:20:09 +01005315 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005317}
5318
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005319/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005320 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005321 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005322void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005323{
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005325}
5326
Gilles Peskineae270bf2021-06-02 00:05:29 +02005327/* The selection should be the same as mbedtls_x509_crt_profile_default in
5328 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005329 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005330 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005331 * about this list.
5332 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005333static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005334#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005335 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005336#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005337#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005338 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005339#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005340#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005341 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005342#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005343#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005344 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005345#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005346#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005347 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005348#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005349#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005350 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005351#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005352#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005353 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005354#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005355#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005356 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005357#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005358#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005359 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5360 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5361 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5362 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5363 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5364#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005365 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005366};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005367
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005368static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005369 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5370 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5371 0
5372};
5373
Ronald Crone68ab4f2022-10-05 12:46:29 +02005374#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005375
Jerry Yu909df7b2022-01-22 11:56:27 +08005376/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005377 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005378 * rules SHOULD be upheld.
5379 * - No duplicate entries.
5380 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005381 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005382 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005383 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005384static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005385
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005386#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005387 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005388 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005389 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005390 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
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) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005394 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005395 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005396 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005397 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5398#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005399
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005400#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005401 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005402 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005403 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005404 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5405#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005406
Gabor Mezeic15ef932024-06-13 12:53:54 +02005407#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005408 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005409#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005410
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005411#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005412 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005413#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005414
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005415#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005416 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005417#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005418
Gabor Mezeic15ef932024-06-13 12:53:54 +02005419#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005420 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005421#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005422
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005423#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005424 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005425#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005426
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005427#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005428 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005429#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005430
Gabor Mezei15b95a62022-05-09 16:37:58 +02005431 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005432};
5433
5434/* NOTICE: see above */
5435#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5436static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005437
Gabor Mezeic15ef932024-06-13 12:53:54 +02005438#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005439#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005441#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005442#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5443 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005444#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005445#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005447#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005448#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005449
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005450#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005451#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005453#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005454#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5455 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005456#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005457#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005459#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005460#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005461
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005462#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005463#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005465#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005466#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5467 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005468#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005469#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005471#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005472#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005473
Gabor Mezei15b95a62022-05-09 16:37:58 +02005474 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005475};
5476#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005477
Jerry Yu909df7b2022-01-22 11:56:27 +08005478/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005479static const uint16_t ssl_preset_suiteb_sig_algs[] = {
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 Uziunaite0916cd72024-05-23 17:01:07 +01005482 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005483 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005484 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005485 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5486#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005487
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005488#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005489 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005490 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005491 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005492 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5493#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005494
Gabor Mezei15b95a62022-05-09 16:37:58 +02005495 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005496};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005497
Jerry Yu909df7b2022-01-22 11:56:27 +08005498/* NOTICE: see above */
5499#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5500static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005501
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005502#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005503#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005505#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005506#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005507
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005508#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005509#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005510 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005511#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005512#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005513
Gabor Mezei15b95a62022-05-09 16:37:58 +02005514 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005515};
Jerry Yu909df7b2022-01-22 11:56:27 +08005516#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5517
Ronald Crone68ab4f2022-10-05 12:46:29 +02005518#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005519
Chien Wong4e9683e2023-12-28 17:07:43 +08005520static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005521#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005522 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005523#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005524#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005525 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005526#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005527 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005528};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005529
Ronald Crone68ab4f2022-10-05 12:46:29 +02005530#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005531/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005532 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005533MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005534static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005535{
5536 size_t i, j;
5537 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005538
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5540 for (j = 0; j < i; j++) {
5541 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005542 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 }
5544 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5545 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5546 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005547 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005548 }
5549 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005551}
5552
Ronald Crone68ab4f2022-10-05 12:46:29 +02005553#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005554
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005555/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005556 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005557 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005558int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5559 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005560{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005561#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005562 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005563#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005564
Ronald Crone68ab4f2022-10-05 12:46:29 +02005565#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5567 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5568 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005569 }
5570
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5572 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5573 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005574 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005575
5576#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005577 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5578 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5579 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005580 }
5581
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5583 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5584 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005585 }
5586#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005587#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005588
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005589 /* Use the functions here so that they are covered in tests,
5590 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 mbedtls_ssl_conf_endpoint(conf, endpoint);
5592 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005593
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005594 /*
5595 * Things that are common to all presets
5596 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005597#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005599 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5600#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5601 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5602#endif
5603 }
5604#endif
5605
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005606#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5607 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5608#endif
5609
5610#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5611 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5612#endif
5613
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005614#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005615 conf->f_cookie_write = ssl_cookie_write_dummy;
5616 conf->f_cookie_check = ssl_cookie_check_dummy;
5617#endif
5618
5619#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5620 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5621#endif
5622
Janos Follath088ce432017-04-10 12:42:31 +01005623#if defined(MBEDTLS_SSL_SRV_C)
5624 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005625 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005626#endif
5627
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005628#if defined(MBEDTLS_SSL_PROTO_DTLS)
5629 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5630 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5631#endif
5632
5633#if defined(MBEDTLS_SSL_RENEGOTIATION)
5634 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 memset(conf->renego_period, 0x00, 2);
5636 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005637#endif
5638
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005639#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005641 const unsigned char dhm_p[] =
5642 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5643 const unsigned char dhm_g[] =
5644 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005645
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5647 dhm_p, sizeof(dhm_p),
5648 dhm_g, sizeof(dhm_g))) != 0) {
5649 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005650 }
5651 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005652#endif
5653
Ronald Cron6f135e12021-12-08 16:57:54 +01005654#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005655
5656#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005657 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005658#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005659 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005660#endif
5661#endif /* MBEDTLS_SSL_EARLY_DATA */
5662
Jerry Yud0766ec2022-09-22 10:46:57 +08005663#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005664 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005666#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005667 /*
5668 * Allow all TLS 1.3 key exchange modes by default.
5669 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005670 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005671#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005672
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005674#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005675 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005676 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005677#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005679#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005680 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005681#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005682 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5683 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005684#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5685 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5686 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5687#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5688 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5689 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5690#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005692#endif
5693 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005694
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005695 /*
5696 * Preset-specific defaults
5697 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005699 /*
5700 * NSA Suite B
5701 */
5702 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005703
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005704 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005705
5706#if defined(MBEDTLS_X509_CRT_PARSE_C)
5707 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005708#endif
5709
Ronald Crone68ab4f2022-10-05 12:46:29 +02005710#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005711#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005713 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005715#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005716 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005717#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005718
Brett Warrene0edc842021-08-17 09:53:13 +01005719 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005720 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005721
5722 /*
5723 * Default
5724 */
5725 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005726
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005727 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005728
5729#if defined(MBEDTLS_X509_CRT_PARSE_C)
5730 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5731#endif
5732
Ronald Crone68ab4f2022-10-05 12:46:29 +02005733#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005734#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005736 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005738#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005740#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005741
Brett Warrene0edc842021-08-17 09:53:13 +01005742 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005743
5744#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5745 conf->dhm_min_bitlen = 1024;
5746#endif
5747 }
5748
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005750}
5751
5752/*
5753 * Free mbedtls_ssl_config
5754 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005755void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005756{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005757 if (conf == NULL) {
5758 return;
5759 }
5760
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005761#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005762 mbedtls_mpi_free(&conf->dhm_P);
5763 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005764#endif
5765
Ronald Cron73fe8df2022-10-05 14:31:43 +02005766#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005768 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5769 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005771 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005772 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005773 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005774 }
5775
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005777 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005778 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005779 conf->psk_identity_len = 0;
5780 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005781#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005782
5783#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005785#endif
5786
Gilles Peskine449bd832023-01-11 14:50:10 +01005787 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005788}
5789
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005790#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005791 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005792/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005793 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005794 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005795unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005796{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005797#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5799 return MBEDTLS_SSL_SIG_RSA;
5800 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005801#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005802#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5804 return MBEDTLS_SSL_SIG_ECDSA;
5805 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005806#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005807 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005808}
5809
Gilles Peskine449bd832023-01-11 14:50:10 +01005810unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005811{
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005813 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005815 case MBEDTLS_PK_ECDSA:
5816 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005817 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005818 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005820 }
5821}
5822
Gilles Peskine449bd832023-01-11 14:50:10 +01005823mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005824{
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005826#if defined(MBEDTLS_RSA_C)
5827 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005829#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005830#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005831 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005833#endif
5834 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005835 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005836 }
5837}
Valerio Settie9646ec2023-08-02 20:02:28 +02005838#endif /* MBEDTLS_PK_C &&
5839 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005840
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005841/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005842 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005843 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005844mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005845{
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005847#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005848 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005850#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005851#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005852 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005853 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005854#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005855#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005856 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005858#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005859#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005860 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005861 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005862#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005863#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005864 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005866#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005867#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005868 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005870#endif
5871 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005873 }
5874}
5875
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005876/*
5877 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5878 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005879unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005880{
Gilles Peskine449bd832023-01-11 14:50:10 +01005881 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005882#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005883 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005885#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005886#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005887 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005889#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005890#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005891 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005893#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005894#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005895 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005897#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005898#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005899 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005901#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005902#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005903 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005904 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005905#endif
5906 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005907 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005908 }
5909}
5910
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005911/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005912 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005913 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005914 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005915int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005916{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005917 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005918
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 if (group_list == NULL) {
5920 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005921 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005922
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 for (; *group_list != 0; group_list++) {
5924 if (*group_list == tls_id) {
5925 return 0;
5926 }
5927 }
5928
5929 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005930}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005931
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005932#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005933/*
5934 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5935 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005936int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005937{
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005939
Gilles Peskine449bd832023-01-11 14:50:10 +01005940 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005941 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005943
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005945}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005946#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005947
Valerio Setti18c9fed2022-12-30 17:44:24 +01005948static const struct {
5949 uint16_t tls_id;
5950 mbedtls_ecp_group_id ecp_group_id;
5951 psa_ecc_family_t psa_family;
5952 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005953} tls_id_match_table[] =
5954{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005955#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005956 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005957#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005958#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005959 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005960#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005961#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005962 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005963#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005964#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005965 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005966#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005967#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005968 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005969#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005970#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005971 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005972#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005973#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005974 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005975#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005976#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005977 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005978#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005979#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005980 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005981#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005982#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005983 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005984#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005985#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005986 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005987#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005988#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005989 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005990#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005991 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005992};
5993
Gilles Peskine449bd832023-01-11 14:50:10 +01005994int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005995 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005997{
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5999 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006000 if (type != NULL) {
6001 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 }
6003 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006004 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006006 return PSA_SUCCESS;
6007 }
6008 }
6009
6010 return PSA_ERROR_NOT_SUPPORTED;
6011}
6012
Gilles Peskine449bd832023-01-11 14:50:10 +01006013mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006014{
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6016 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006017 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006019 }
6020
6021 return MBEDTLS_ECP_DP_NONE;
6022}
6023
Gilles Peskine449bd832023-01-11 14:50:10 +01006024uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006025{
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6027 i++) {
6028 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006029 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006031 }
6032
6033 return 0;
6034}
6035
Valerio Setti67419f02023-01-04 16:12:42 +01006036#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006037static const struct {
6038 uint16_t tls_id;
6039 const char *name;
6040} tls_id_curve_name_table[] =
6041{
Valerio Setti54e23792023-07-07 10:49:27 +02006042 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6043 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6044 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6045 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6046 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6047 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6048 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6049 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6050 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6051 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6052 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6053 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6054 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006055 { 0, NULL },
6056};
6057
Gilles Peskine449bd832023-01-11 14:50:10 +01006058const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006059{
Valerio Settiacd32c02023-06-29 18:06:29 +02006060 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6061 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6062 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006064 }
6065
6066 return NULL;
6067}
Valerio Setti67419f02023-01-04 16:12:42 +01006068#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006069
Gilles Peskine449bd832023-01-11 14:50:10 +01006070int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6071 const mbedtls_md_type_t md,
6072 unsigned char *dst,
6073 size_t dst_len,
6074 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006075{
Ronald Cronf6893e12022-01-07 22:09:01 +01006076 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6077 psa_hash_operation_t *hash_operation_to_clone;
6078 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6079
Jerry Yu148165c2021-09-24 23:20:59 +08006080 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006081
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006083#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 case MBEDTLS_MD_SHA384:
6085 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6086 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006087#endif
6088
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006089#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 case MBEDTLS_MD_SHA256:
6091 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6092 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006093#endif
6094
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 default:
6096 goto exit;
6097 }
6098
6099 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6100 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006101 goto exit;
6102 }
6103
Gilles Peskine449bd832023-01-11 14:50:10 +01006104 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6105 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006106 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006108
6109exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006110#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006111 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006112 (void) ssl;
6113#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006114 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006115}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006116
Ronald Crone68ab4f2022-10-05 12:46:29 +02006117#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006118/* mbedtls_ssl_parse_sig_alg_ext()
6119 *
6120 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6121 * value (TLS 1.3 RFC8446):
6122 * enum {
6123 * ....
6124 * ecdsa_secp256r1_sha256( 0x0403 ),
6125 * ecdsa_secp384r1_sha384( 0x0503 ),
6126 * ecdsa_secp521r1_sha512( 0x0603 ),
6127 * ....
6128 * } SignatureScheme;
6129 *
6130 * struct {
6131 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6132 * } SignatureSchemeList;
6133 *
6134 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6135 * value (TLS 1.2 RFC5246):
6136 * enum {
6137 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6138 * sha512(6), (255)
6139 * } HashAlgorithm;
6140 *
6141 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6142 * SignatureAlgorithm;
6143 *
6144 * struct {
6145 * HashAlgorithm hash;
6146 * SignatureAlgorithm signature;
6147 * } SignatureAndHashAlgorithm;
6148 *
6149 * SignatureAndHashAlgorithm
6150 * supported_signature_algorithms<2..2^16-2>;
6151 *
6152 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6153 * generalization of the TLS 1.2 signature algorithm extension.
6154 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6155 * `SignatureScheme` field of TLS 1.3
6156 *
6157 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006158int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6159 const unsigned char *buf,
6160 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006161{
6162 const unsigned char *p = buf;
6163 size_t supported_sig_algs_len = 0;
6164 const unsigned char *supported_sig_algs_end;
6165 uint16_t sig_alg;
6166 uint32_t common_idx = 0;
6167
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6169 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006170 p += 2;
6171
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 memset(ssl->handshake->received_sig_algs, 0,
6173 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006174
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006176 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 while (p < supported_sig_algs_end) {
6178 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6179 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006180 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006181 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6182 sig_alg,
6183 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006184#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6186 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6187 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006188 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006189 }
6190#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006191
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6193 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006194
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006196 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6197 common_idx += 1;
6198 }
6199 }
6200 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 if (p != end) {
6202 MBEDTLS_SSL_DEBUG_MSG(1,
6203 ("Signature algorithms extension length misaligned"));
6204 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6205 MBEDTLS_ERR_SSL_DECODE_ERROR);
6206 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006207 }
6208
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 if (common_idx == 0) {
6210 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6211 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6212 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6213 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006214 }
6215
Gabor Mezei15b95a62022-05-09 16:37:58 +02006216 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006218}
6219
Ronald Crone68ab4f2022-10-05 12:46:29 +02006220#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006221
Jerry Yudc7bd172022-02-17 13:44:15 +08006222#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6223
Jerry Yudc7bd172022-02-17 13:44:15 +08006224
Gilles Peskine449bd832023-01-11 14:50:10 +01006225static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6226 mbedtls_svc_key_id_t key,
6227 psa_algorithm_t alg,
6228 const unsigned char *raw_psk, size_t raw_psk_length,
6229 const unsigned char *seed, size_t seed_length,
6230 const unsigned char *label, size_t label_length,
6231 const unsigned char *other_secret,
6232 size_t other_secret_length,
6233 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006234{
6235 psa_status_t status;
6236
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 status = psa_key_derivation_setup(derivation, alg);
6238 if (status != PSA_SUCCESS) {
6239 return status;
6240 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006241
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6243 status = psa_key_derivation_input_bytes(derivation,
6244 PSA_KEY_DERIVATION_INPUT_SEED,
6245 seed, seed_length);
6246 if (status != PSA_SUCCESS) {
6247 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006248 }
6249
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 if (other_secret != NULL) {
6251 status = psa_key_derivation_input_bytes(derivation,
6252 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6253 other_secret, other_secret_length);
6254 if (status != PSA_SUCCESS) {
6255 return status;
6256 }
6257 }
6258
6259 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006260 status = psa_key_derivation_input_bytes(
6261 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 raw_psk, raw_psk_length);
6263 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006264 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006266 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 if (status != PSA_SUCCESS) {
6268 return status;
6269 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006270
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 status = psa_key_derivation_input_bytes(derivation,
6272 PSA_KEY_DERIVATION_INPUT_LABEL,
6273 label, label_length);
6274 if (status != PSA_SUCCESS) {
6275 return status;
6276 }
6277 } else {
6278 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006279 }
6280
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 status = psa_key_derivation_set_capacity(derivation, capacity);
6282 if (status != PSA_SUCCESS) {
6283 return status;
6284 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006285
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006287}
6288
Andrzej Kurek57d10632022-10-24 10:32:01 -04006289#if defined(PSA_WANT_ALG_SHA_384) || \
6290 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006291MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006292static int tls_prf_generic(mbedtls_md_type_t md_type,
6293 const unsigned char *secret, size_t slen,
6294 const char *label,
6295 const unsigned char *random, size_t rlen,
6296 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006297{
6298 psa_status_t status;
6299 psa_algorithm_t alg;
6300 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6301 psa_key_derivation_operation_t derivation =
6302 PSA_KEY_DERIVATION_OPERATION_INIT;
6303
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006305 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006307 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006308 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006309
6310 /* Normally a "secret" should be long enough to be impossible to
6311 * find by brute force, and in particular should not be empty. But
6312 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6313 * and for this use case it makes sense to have a 0-length "secret".
6314 * Since the key API doesn't allow importing a key of length 0,
6315 * keep master_key=0, which setup_psa_key_derivation() understands
6316 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006318 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006319 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6320 psa_set_key_algorithm(&key_attributes, alg);
6321 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006322
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6324 if (status != PSA_SUCCESS) {
6325 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6326 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006327 }
6328
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 status = setup_psa_key_derivation(&derivation,
6330 master_key, alg,
6331 NULL, 0,
6332 random, rlen,
6333 (unsigned char const *) label,
6334 (size_t) strlen(label),
6335 NULL, 0,
6336 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_output_bytes(&derivation, dstbuf, dlen);
6344 if (status != PSA_SUCCESS) {
6345 psa_key_derivation_abort(&derivation);
6346 psa_destroy_key(master_key);
6347 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006348 }
6349
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 status = psa_key_derivation_abort(&derivation);
6351 if (status != PSA_SUCCESS) {
6352 psa_destroy_key(master_key);
6353 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006354 }
6355
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 if (!mbedtls_svc_key_id_is_null(master_key)) {
6357 status = psa_destroy_key(master_key);
6358 }
6359 if (status != PSA_SUCCESS) {
6360 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6361 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006362
Gilles Peskine449bd832023-01-11 14:50:10 +01006363 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006364}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006365#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006366
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006367#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006368MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006369static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6370 const char *label,
6371 const unsigned char *random, size_t rlen,
6372 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006373{
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6375 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006376}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006377#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006378
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006379#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006380MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006381static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6382 const char *label,
6383 const unsigned char *random, size_t rlen,
6384 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006385{
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6387 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006388}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006389#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006390
Jerry Yuf009d862022-02-17 14:01:37 +08006391/*
6392 * Set appropriate PRF function and other SSL / TLS1.2 functions
6393 *
6394 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006395 * - hash associated with the ciphersuite (only used by TLS 1.2)
6396 *
6397 * Outputs:
6398 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6399 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006400MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006401static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6402 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006403{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006404#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006406 handshake->tls_prf = tls_prf_sha384;
6407 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6408 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006410#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006411#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006412 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006413 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006414 handshake->tls_prf = tls_prf_sha256;
6415 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6416 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6417 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006418#else
Jerry Yuf009d862022-02-17 14:01:37 +08006419 {
Jerry Yuf009d862022-02-17 14:01:37 +08006420 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006421 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006423 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006424#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006427}
Jerry Yud6ab2352022-02-17 14:03:43 +08006428
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006429/*
6430 * Compute master secret if needed
6431 *
6432 * Parameters:
6433 * [in/out] handshake
6434 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6435 * (PSA-PSK) ciphersuite_info, psk_opaque
6436 * [out] premaster (cleared)
6437 * [out] master
6438 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6439 * debug: conf->f_dbg, conf->p_dbg
6440 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006441 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006442 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006443MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006444static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6445 unsigned char *master,
6446 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006447{
6448 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6449
6450 /* cf. RFC 5246, Section 8.1:
6451 * "The master secret is always exactly 48 bytes in length." */
6452 size_t const master_secret_len = 48;
6453
6454#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6455 unsigned char session_hash[48];
6456#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6457
6458 /* The label for the KDF used for key expansion.
6459 * This is either "master secret" or "extended master secret"
6460 * depending on whether the Extended Master Secret extension
6461 * is used. */
6462 char const *lbl = "master secret";
6463
Przemek Stekielae4ed302022-04-05 17:15:55 +02006464 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006465 * - If the Extended Master Secret extension is not used,
6466 * this is ClientHello.Random + ServerHello.Random
6467 * (see Sect. 8.1 in RFC 5246).
6468 * - If the Extended Master Secret extension is used,
6469 * this is the transcript of the handshake so far.
6470 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006471 unsigned char const *seed = handshake->randbytes;
6472 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006473
6474#if !defined(MBEDTLS_DEBUG_C) && \
6475 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006476 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006477 ssl = NULL; /* make sure we don't use it except for those cases */
6478 (void) ssl;
6479#endif
6480
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 if (handshake->resume != 0) {
6482 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6483 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006484 }
6485
6486#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006488 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006489 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006490 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6491 if (ret != 0) {
6492 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6493 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006494
Gilles Peskine449bd832023-01-11 14:50:10 +01006495 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6496 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006497 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006498#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006499
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006500#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006502 /* Perform PSK-to-MS expansion in a single step. */
6503 psa_status_t status;
6504 psa_algorithm_t alg;
6505 mbedtls_svc_key_id_t psk;
6506 psa_key_derivation_operation_t derivation =
6507 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006508 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006509
Gilles Peskine449bd832023-01-11 14:50:10 +01006510 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006511
Gilles Peskine449bd832023-01-11 14:50:10 +01006512 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006513
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006515 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006516 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006517 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006518 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006519
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006520 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006522
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006524 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006525 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006526 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006527 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006528 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6529 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6530 other_secret = handshake->premaster + 2;
6531 break;
6532 default:
6533 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006534 }
6535
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 status = setup_psa_key_derivation(&derivation, psk, alg,
6537 ssl->conf->psk, ssl->conf->psk_len,
6538 seed, seed_len,
6539 (unsigned char const *) lbl,
6540 (size_t) strlen(lbl),
6541 other_secret, other_secret_len,
6542 master_secret_len);
6543 if (status != PSA_SUCCESS) {
6544 psa_key_derivation_abort(&derivation);
6545 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006546 }
6547
Gilles Peskine449bd832023-01-11 14:50:10 +01006548 status = psa_key_derivation_output_bytes(&derivation,
6549 master,
6550 master_secret_len);
6551 if (status != PSA_SUCCESS) {
6552 psa_key_derivation_abort(&derivation);
6553 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006554 }
6555
Gilles Peskine449bd832023-01-11 14:50:10 +01006556 status = psa_key_derivation_abort(&derivation);
6557 if (status != PSA_SUCCESS) {
6558 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6559 }
6560 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006561#endif
6562 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006563#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006565 psa_status_t status;
6566 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6567 psa_key_derivation_operation_t derivation =
6568 PSA_KEY_DERIVATION_OPERATION_INIT;
6569
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006571
6572 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6573
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 status = psa_key_derivation_setup(&derivation, alg);
6575 if (status != PSA_SUCCESS) {
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_key_derivation_set_capacity(&derivation,
6580 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
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_pake_get_implicit_key(&handshake->psa_pake_ctx,
6587 &derivation);
6588 if (status != PSA_SUCCESS) {
6589 psa_key_derivation_abort(&derivation);
6590 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006591 }
6592
Gilles Peskine449bd832023-01-11 14:50:10 +01006593 status = psa_key_derivation_output_bytes(&derivation,
6594 handshake->premaster,
6595 handshake->pmslen);
6596 if (status != PSA_SUCCESS) {
6597 psa_key_derivation_abort(&derivation);
6598 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6599 }
6600
6601 status = psa_key_derivation_abort(&derivation);
6602 if (status != PSA_SUCCESS) {
6603 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006604 }
6605 }
6606#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006607 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6608 lbl, seed, seed_len,
6609 master,
6610 master_secret_len);
6611 if (ret != 0) {
6612 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6613 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006614 }
6615
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6617 handshake->premaster,
6618 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006619
Gilles Peskine449bd832023-01-11 14:50:10 +01006620 mbedtls_platform_zeroize(handshake->premaster,
6621 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006622 }
6623
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006625}
6626
Gilles Peskine449bd832023-01-11 14:50:10 +01006627int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006628{
6629 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6630 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6631 ssl->handshake->ciphersuite_info;
6632
Gilles Peskine449bd832023-01-11 14:50:10 +01006633 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006634
6635 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006637 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 if (ret != 0) {
6639 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6640 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006641 }
6642
6643 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 ret = ssl_compute_master(ssl->handshake,
6645 ssl->session_negotiate->master,
6646 ssl);
6647 if (ret != 0) {
6648 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6649 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006650 }
6651
6652 /* Swap the client and server random values:
6653 * - MS derivation wanted client+server (RFC 5246 8.1)
6654 * - key derivation wants server+client (RFC 5246 6.3) */
6655 {
6656 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006657 memcpy(tmp, ssl->handshake->randbytes, 64);
6658 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6659 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6660 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006661 }
6662
6663 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006664 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6665 ssl->session_negotiate->ciphersuite,
6666 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006667#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006668 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006669#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006670 ssl->handshake->tls_prf,
6671 ssl->handshake->randbytes,
6672 ssl->tls_version,
6673 ssl->conf->endpoint,
6674 ssl);
6675 if (ret != 0) {
6676 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6677 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006678 }
6679
6680 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006681 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6682 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006683
Gilles Peskine449bd832023-01-11 14:50:10 +01006684 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006685
Gilles Peskine449bd832023-01-11 14:50:10 +01006686 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006687}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006688
Gilles Peskine449bd832023-01-11 14:50:10 +01006689int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006690{
Gilles Peskine449bd832023-01-11 14:50:10 +01006691 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006692#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006693 case MBEDTLS_SSL_HASH_SHA384:
6694 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6695 break;
6696#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006697#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006698 case MBEDTLS_SSL_HASH_SHA256:
6699 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6700 break;
6701#endif
6702 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006704 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006705#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006706 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006707 (void) ssl;
6708#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006709 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006710}
6711
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006712static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6713 const psa_hash_operation_t *hs_op,
6714 size_t buffer_size,
6715 unsigned char *hash,
6716 size_t *hlen)
6717{
6718 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006719 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006720
6721#if !defined(MBEDTLS_DEBUG_C)
6722 (void) ssl;
6723#endif
6724 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006725 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006726 if (status != PSA_SUCCESS) {
6727 goto exit;
6728 }
6729
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006730 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006731 if (status != PSA_SUCCESS) {
6732 goto exit;
6733 }
6734
6735 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6736 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6737
6738exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006739 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006740 return mbedtls_md_error_from_psa(status);
6741}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006742
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006743#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006744int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6745 unsigned char *hash,
6746 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006747{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006748 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6749 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006750}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006751#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006752
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006753#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006754int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6755 unsigned char *hash,
6756 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006757{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006758 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6759 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006760}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006761#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006762
Jerry Yuc2c673d2022-02-17 14:20:39 +08006763#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006764MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006765static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006766
6767#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006768int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006769{
6770 /* If renegotiation is not enforced, retransmit until we would reach max
6771 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006773 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6774 unsigned char doublings = 1;
6775
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006777 ++doublings;
6778 ratio >>= 1;
6779 }
6780
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 if (++ssl->renego_records_seen > doublings) {
6782 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6783 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006784 }
6785 }
6786
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006788}
6789#endif
6790#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006791
Jerry Yud9526692022-02-17 14:23:47 +08006792/*
6793 * Handshake functions
6794 */
6795#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6796/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006797int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006798{
6799 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6800 ssl->handshake->ciphersuite_info;
6801
Gilles Peskine449bd832023-01-11 14:50:10 +01006802 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006803
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6805 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006806 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006808 }
6809
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6811 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006812}
6813
Gilles Peskine449bd832023-01-11 14:50:10 +01006814int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006815{
6816 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6817 ssl->handshake->ciphersuite_info;
6818
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6822 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006823 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006825 }
6826
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6828 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006829}
6830
6831#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6832/* Some certificate support -> implement write and parse */
6833
Gilles Peskine449bd832023-01-11 14:50:10 +01006834int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006835{
6836 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6837 size_t i, n;
6838 const mbedtls_x509_crt *crt;
6839 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6840 ssl->handshake->ciphersuite_info;
6841
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006843
Gilles Peskine449bd832023-01-11 14:50:10 +01006844 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6845 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006846 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006848 }
6849
6850#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6852 if (ssl->handshake->client_auth == 0) {
6853 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006854 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006856 }
6857 }
6858#endif /* MBEDTLS_SSL_CLI_C */
6859#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6861 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006862 /* Should never happen because we shouldn't have picked the
6863 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006865 }
6866 }
6867#endif
6868
Gilles Peskine449bd832023-01-11 14:50:10 +01006869 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006870
6871 /*
6872 * 0 . 0 handshake type
6873 * 1 . 3 handshake length
6874 * 4 . 6 length of all certs
6875 * 7 . 9 length of cert. 1
6876 * 10 . n-1 peer certificate
6877 * n . n+2 length of cert. 2
6878 * n+3 . ... upper level cert, etc.
6879 */
6880 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006882
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006884 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6886 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6887 " > %" MBEDTLS_PRINTF_SIZET,
6888 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6889 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006890 }
6891
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6893 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6894 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006897 i += n; crt = crt->next;
6898 }
6899
Gilles Peskine449bd832023-01-11 14:50:10 +01006900 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6901 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6902 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006903
6904 ssl->out_msglen = i;
6905 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6906 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6907
6908 ssl->state++;
6909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6911 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6912 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006913 }
6914
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006916
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006918}
6919
6920#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6921
6922#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006923MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006924static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6925 unsigned char *crt_buf,
6926 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006927{
6928 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6929
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 if (peer_crt == NULL) {
6931 return -1;
6932 }
Jerry Yud9526692022-02-17 14:23:47 +08006933
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 if (peer_crt->raw.len != crt_buf_len) {
6935 return -1;
6936 }
Jerry Yud9526692022-02-17 14:23:47 +08006937
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006939}
6940#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006941MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006942static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6943 unsigned char *crt_buf,
6944 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006945{
6946 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6947 unsigned char const * const peer_cert_digest =
6948 ssl->session->peer_cert_digest;
6949 mbedtls_md_type_t const peer_cert_digest_type =
6950 ssl->session->peer_cert_digest_type;
6951 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006952 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006953 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6954 size_t digest_len;
6955
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 if (peer_cert_digest == NULL || digest_info == NULL) {
6957 return -1;
6958 }
Jerry Yud9526692022-02-17 14:23:47 +08006959
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 digest_len = mbedtls_md_get_size(digest_info);
6961 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6962 return -1;
6963 }
Jerry Yud9526692022-02-17 14:23:47 +08006964
Gilles Peskine449bd832023-01-11 14:50:10 +01006965 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6966 if (ret != 0) {
6967 return -1;
6968 }
Jerry Yud9526692022-02-17 14:23:47 +08006969
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006971}
6972#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6973#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6974
6975/*
6976 * Once the certificate message is read, parse it into a cert chain and
6977 * perform basic checks, but leave actual verification to the caller
6978 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006979MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006980static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6981 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006982{
6983 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6984#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006985 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006986#endif
6987 size_t i, n;
6988 uint8_t alert;
6989
Gilles Peskine449bd832023-01-11 14:50:10 +01006990 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6991 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6992 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6993 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6994 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006995 }
6996
Gilles Peskine449bd832023-01-11 14:50:10 +01006997 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6998 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6999 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7000 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007001 }
7002
Gilles Peskine449bd832023-01-11 14:50:10 +01007003 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7004 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7005 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7006 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7007 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007008 }
7009
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007011
7012 /*
7013 * Same message structure as in mbedtls_ssl_write_certificate()
7014 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007015 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007016
Gilles Peskine449bd832023-01-11 14:50:10 +01007017 if (ssl->in_msg[i] != 0 ||
7018 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7019 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7020 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7021 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7022 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007023 }
7024
7025 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7026 i += 3;
7027
7028 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007030 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007031 if (i + 3 > ssl->in_hslen) {
7032 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7033 mbedtls_ssl_send_alert_message(ssl,
7034 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7035 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7036 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007037 }
7038 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7039 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 if (ssl->in_msg[i] != 0) {
7041 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7042 mbedtls_ssl_send_alert_message(ssl,
7043 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7044 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7045 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007046 }
7047
7048 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007049 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007050 i += 3;
7051
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 if (n < 128 || i + n > ssl->in_hslen) {
7053 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7054 mbedtls_ssl_send_alert_message(ssl,
7055 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7056 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7057 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007058 }
7059
7060 /* Check if we're handling the first CRT in the chain. */
7061#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007063 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007065 /* During client-side renegotiation, check that the server's
7066 * end-CRTs hasn't changed compared to the initial handshake,
7067 * mitigating the triple handshake attack. On success, reuse
7068 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7070 if (ssl_check_peer_crt_unchanged(ssl,
7071 &ssl->in_msg[i],
7072 n) != 0) {
7073 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7074 mbedtls_ssl_send_alert_message(ssl,
7075 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7076 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7077 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007078 }
7079
7080 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007082 }
7083#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7084
7085 /* Parse the next certificate in the chain. */
7086#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007088#else
7089 /* If we don't need to store the CRT chain permanently, parse
7090 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007092#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007094 case 0: /*ok*/
7095 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7096 /* Ignore certificate with an unknown algorithm: maybe a
7097 prior certificate was already trusted. */
7098 break;
7099
7100 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7101 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7102 goto crt_parse_der_failed;
7103
7104 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7105 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7106 goto crt_parse_der_failed;
7107
7108 default:
7109 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007110crt_parse_der_failed:
7111 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7112 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7113 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007114 }
7115
7116 i += n;
7117 }
7118
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7120 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007121}
7122
7123#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007124MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007125static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007126{
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7128 return -1;
7129 }
Jerry Yud9526692022-02-17 14:23:47 +08007130
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007132 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7133 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7135 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7136 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007137 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007139}
7140#endif /* MBEDTLS_SSL_SRV_C */
7141
7142/* Check if a certificate message is expected.
7143 * Return either
7144 * - SSL_CERTIFICATE_EXPECTED, or
7145 * - SSL_CERTIFICATE_SKIP
7146 * indicating whether a Certificate message is expected or not.
7147 */
7148#define SSL_CERTIFICATE_EXPECTED 0
7149#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007150MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007151static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7152 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007153{
7154 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7155 ssl->handshake->ciphersuite_info;
7156
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7158 return SSL_CERTIFICATE_SKIP;
7159 }
Jerry Yud9526692022-02-17 14:23:47 +08007160
7161#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007164 ssl->session_negotiate->verify_result =
7165 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007167 }
7168 }
7169#else
7170 ((void) authmode);
7171#endif /* MBEDTLS_SSL_SRV_C */
7172
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007174}
7175
Jerry Yud9526692022-02-17 14:23:47 +08007176#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007177MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007178static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7179 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007180{
7181 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7182 /* Remember digest of the peer's end-CRT. */
7183 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007184 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7185 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7186 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7187 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7188 mbedtls_ssl_send_alert_message(ssl,
7189 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7190 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007191
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007193 }
7194
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 ret = mbedtls_md(mbedtls_md_info_from_type(
7196 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7197 start, len,
7198 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007199
7200 ssl->session_negotiate->peer_cert_digest_type =
7201 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7202 ssl->session_negotiate->peer_cert_digest_len =
7203 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7204
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007206}
7207
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007208MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007209static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7210 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007211{
7212 unsigned char *end = start + len;
7213 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7214
7215 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7217 ret = mbedtls_pk_parse_subpubkey(&start, end,
7218 &ssl->handshake->peer_pubkey);
7219 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007220 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007221 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007222 }
7223
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007225}
7226#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7227
Gilles Peskine449bd832023-01-11 14:50:10 +01007228int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007229{
7230 int ret = 0;
7231 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007232 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007233#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7234 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7235 ? ssl->handshake->sni_authmode
7236 : ssl->conf->authmode;
7237#else
7238 const int authmode = ssl->conf->authmode;
7239#endif
7240 void *rs_ctx = NULL;
7241 mbedtls_x509_crt *chain = NULL;
7242
Gilles Peskine449bd832023-01-11 14:50:10 +01007243 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007244
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7246 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7247 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007248 goto exit;
7249 }
7250
7251#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 if (ssl->handshake->ecrs_enabled &&
7253 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007254 chain = ssl->handshake->ecrs_peer_cert;
7255 ssl->handshake->ecrs_peer_cert = NULL;
7256 goto crt_verify;
7257 }
7258#endif
7259
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007261 /* mbedtls_ssl_read_record may have sent an alert already. We
7262 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007264 goto exit;
7265 }
7266
7267#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007269 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7270
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007272 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007273 }
Jerry Yud9526692022-02-17 14:23:47 +08007274
7275 goto exit;
7276 }
7277#endif /* MBEDTLS_SSL_SRV_C */
7278
7279 /* Clear existing peer CRT structure in case we tried to
7280 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007282
Gilles Peskine449bd832023-01-11 14:50:10 +01007283 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7284 if (chain == NULL) {
7285 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7286 sizeof(mbedtls_x509_crt)));
7287 mbedtls_ssl_send_alert_message(ssl,
7288 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7289 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007290
7291 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7292 goto exit;
7293 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007295
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 ret = ssl_parse_certificate_chain(ssl, chain);
7297 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007298 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 }
Jerry Yud9526692022-02-17 14:23:47 +08007300
7301#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007303 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 }
Jerry Yud9526692022-02-17 14:23:47 +08007305
7306crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007308 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 }
Jerry Yud9526692022-02-17 14:23:47 +08007310#endif
7311
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007312 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7313 ssl->handshake->ciphersuite_info,
7314 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007316 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 }
Jerry Yud9526692022-02-17 14:23:47 +08007318
7319#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7320 {
7321 unsigned char *crt_start, *pk_start;
7322 size_t crt_len, pk_len;
7323
7324 /* We parse the CRT chain without copying, so
7325 * these pointers point into the input buffer,
7326 * and are hence still valid after freeing the
7327 * CRT chain. */
7328
7329 crt_start = chain->raw.p;
7330 crt_len = chain->raw.len;
7331
7332 pk_start = chain->pk_raw.p;
7333 pk_len = chain->pk_raw.len;
7334
7335 /* Free the CRT structures before computing
7336 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007337 mbedtls_x509_crt_free(chain);
7338 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007339 chain = NULL;
7340
Gilles Peskine449bd832023-01-11 14:50:10 +01007341 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7342 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007343 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 }
Jerry Yud9526692022-02-17 14:23:47 +08007345
Gilles Peskine449bd832023-01-11 14:50:10 +01007346 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7347 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007348 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007349 }
Jerry Yud9526692022-02-17 14:23:47 +08007350 }
7351#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7352 /* Pass ownership to session structure. */
7353 ssl->session_negotiate->peer_cert = chain;
7354 chain = NULL;
7355#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7356
Gilles Peskine449bd832023-01-11 14:50:10 +01007357 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007358
7359exit:
7360
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007362 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007363 }
Jerry Yud9526692022-02-17 14:23:47 +08007364
7365#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007367 ssl->handshake->ecrs_peer_cert = chain;
7368 chain = NULL;
7369 }
7370#endif
7371
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 if (chain != NULL) {
7373 mbedtls_x509_crt_free(chain);
7374 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007375 }
7376
Gilles Peskine449bd832023-01-11 14:50:10 +01007377 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007378}
7379#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7380
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007381static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7382 unsigned char *padbuf, size_t hlen,
7383 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007384{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007385 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007386 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007387 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007388 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007389 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007390 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007391
7392 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007393 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007394 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007395 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007396
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007398 ? "client finished"
7399 : "server finished";
7400
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007401 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007402
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007403 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007405 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007406 }
7407
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007408 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007409 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007410 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007411 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007412 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007413
7414 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7415
Jerry Yu615bd6f2022-02-17 14:25:15 +08007416 /*
7417 * TLSv1.2:
7418 * hash = PRF( master, finished_label,
7419 * Hash( handshake ) )[0.11]
7420 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007422 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007423
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007425
Paul Elliottecb95be2023-08-11 16:41:04 +01007426 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007427
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007428 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007429
7430exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007431 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007432 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007433}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007434
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007435#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007436static int ssl_calc_finished_tls_sha256(
7437 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7438{
7439 unsigned char padbuf[32];
7440 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007441 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007442 padbuf, sizeof(padbuf),
7443 buf, from);
7444}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007445#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007446
Jerry Yub7ba49e2022-02-17 14:25:53 +08007447
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007448#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007449static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007451{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007452 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007453 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007454 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007455 padbuf, sizeof(padbuf),
7456 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007457}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007458#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007459
Gilles Peskine449bd832023-01-11 14:50:10 +01007460void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007461{
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007463
7464 /*
7465 * Free our handshake params
7466 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 mbedtls_ssl_handshake_free(ssl);
7468 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007469 ssl->handshake = NULL;
7470
7471 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007472 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007473 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 if (ssl->transform) {
7475 mbedtls_ssl_transform_free(ssl->transform);
7476 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007477 }
7478 ssl->transform = ssl->transform_negotiate;
7479 ssl->transform_negotiate = NULL;
7480
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007482}
7483
Gilles Peskine449bd832023-01-11 14:50:10 +01007484void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007485{
7486 int resume = ssl->handshake->resume;
7487
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007489
7490#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007492 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7493 ssl->renego_records_seen = 0;
7494 }
7495#endif
7496
7497 /*
7498 * Free the previous session and switch in the current one
7499 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007501#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7502 /* RFC 7366 3.1: keep the EtM state */
7503 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007505#endif
7506
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 mbedtls_ssl_session_free(ssl->session);
7508 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007509 }
7510 ssl->session = ssl->session_negotiate;
7511 ssl->session_negotiate = NULL;
7512
7513 /*
7514 * Add cache entry
7515 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007517 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 resume == 0) {
7519 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7520 ssl->session->id,
7521 ssl->session->id_len,
7522 ssl->session) != 0) {
7523 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7524 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007525 }
7526
7527#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7529 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007530 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007532
7533 /* Keep last flight around in case we need to resend it:
7534 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7536 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007537#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007539
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007540 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007541
Gilles Peskine449bd832023-01-11 14:50:10 +01007542 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007543}
7544
Gilles Peskine449bd832023-01-11 14:50:10 +01007545int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007546{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007547 int ret;
7548 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007549
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007551
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007553
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007554 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7555 if (ret != 0) {
7556 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7557 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007558
7559 /*
7560 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7561 * may define some other value. Currently (early 2016), no defined
7562 * ciphersuite does this (and this is unlikely to change as activity has
7563 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7564 */
7565 hash_len = 12;
7566
7567#if defined(MBEDTLS_SSL_RENEGOTIATION)
7568 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007570#endif
7571
7572 ssl->out_msglen = 4 + hash_len;
7573 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7574 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7575
7576 /*
7577 * In case of session resuming, invert the client and server
7578 * ChangeCipherSpec messages order.
7579 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007581#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007583 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007585#endif
7586#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007588 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007590#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007592 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007594
7595 /*
7596 * Switch to our negotiated transform and session parameters for outbound
7597 * data.
7598 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007600
7601#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007603 unsigned char i;
7604
7605 /* Remember current epoch settings for resending */
7606 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007607 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7608 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007609
7610 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007612
7613
7614 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 for (i = 2; i > 0; i--) {
7616 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007617 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 }
7619 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007620
7621 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 if (i == 0) {
7623 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7624 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007625 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007627#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007629
7630 ssl->transform_out = ssl->transform_negotiate;
7631 ssl->session_out = ssl->session_negotiate;
7632
7633#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7635 mbedtls_ssl_send_flight_completed(ssl);
7636 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007637#endif
7638
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7640 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7641 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007642 }
7643
7644#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7646 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7647 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7648 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007649 }
7650#endif
7651
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007653
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007655}
7656
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007657#define SSL_MAX_HASH_LEN 12
7658
Gilles Peskine449bd832023-01-11 14:50:10 +01007659int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007660{
7661 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7662 unsigned int hash_len = 12;
7663 unsigned char buf[SSL_MAX_HASH_LEN];
7664
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007666
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007667 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7668 if (ret != 0) {
7669 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7670 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007671
Gilles Peskine449bd832023-01-11 14:50:10 +01007672 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7673 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007674 goto exit;
7675 }
7676
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7678 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
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_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7686 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7687 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007688 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7689 goto exit;
7690 }
7691
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7693 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7694 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7695 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007696 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7697 goto exit;
7698 }
7699
Gilles Peskine449bd832023-01-11 14:50:10 +01007700 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7701 buf, hash_len) != 0) {
7702 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7703 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7704 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007705 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7706 goto exit;
7707 }
7708
7709#if defined(MBEDTLS_SSL_RENEGOTIATION)
7710 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007711 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007712#endif
7713
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007715#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007717 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007719#endif
7720#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007722 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007724#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007726 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007727 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007728
7729#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7731 mbedtls_ssl_recv_flight_completed(ssl);
7732 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007733#endif
7734
Gilles Peskine449bd832023-01-11 14:50:10 +01007735 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007736
7737exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007738 mbedtls_platform_zeroize(buf, hash_len);
7739 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007740}
7741
Jerry Yu392112c2022-02-17 14:34:10 +08007742#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7743/*
7744 * Helper to get TLS 1.2 PRF from ciphersuite
7745 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7746 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007747static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007748{
Jerry Yu392112c2022-02-17 14:34:10 +08007749 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007751#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007752 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7753 return tls_prf_sha384;
7754 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007755#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007756#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007757 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7759 return tls_prf_sha256;
7760 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007761 }
7762#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007763#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007764 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007765 (void) ciphersuite_info;
7766#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007767
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007769}
7770#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007771
Gilles Peskine449bd832023-01-11 14:50:10 +01007772static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007773{
7774 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007775#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007776 if (tls_prf == tls_prf_sha384) {
7777 return MBEDTLS_SSL_TLS_PRF_SHA384;
7778 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007779#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007780#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 if (tls_prf == tls_prf_sha256) {
7782 return MBEDTLS_SSL_TLS_PRF_SHA256;
7783 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007784#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007785 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007786}
7787
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007788/*
7789 * Populate a transform structure with session keys and all the other
7790 * necessary information.
7791 *
7792 * Parameters:
7793 * - [in/out]: transform: structure to populate
7794 * [in] must be just initialised with mbedtls_ssl_transform_init()
7795 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7796 * - [in] ciphersuite
7797 * - [in] master
7798 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007799 * - [in] tls_prf: pointer to PRF to use for key derivation
7800 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007801 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007802 * - [in] endpoint: client or server
7803 * - [in] ssl: used for:
7804 * - ssl->conf->{f,p}_export_keys
7805 * [in] optionally used for:
7806 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7807 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007808MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007809static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7810 int ciphersuite,
7811 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007812#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007814#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 ssl_tls_prf_t tls_prf,
7816 const unsigned char randbytes[64],
7817 mbedtls_ssl_protocol_version tls_version,
7818 unsigned endpoint,
7819 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007820{
7821 int ret = 0;
7822 unsigned char keyblk[256];
7823 unsigned char *key1;
7824 unsigned char *key2;
7825 unsigned char *mac_enc;
7826 unsigned char *mac_dec;
7827 size_t mac_key_len = 0;
7828 size_t iv_copy_len;
7829 size_t keylen;
7830 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007831 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007832
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007833 psa_key_type_t key_type;
7834 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7835 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007836 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007837 size_t key_bits;
7838 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007839
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007840 /*
7841 * Some data just needs copying into the structure
7842 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007843#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007844 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007845#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007846 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007847
7848#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007849 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007850#endif
7851
7852#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007854 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7855 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007856 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007857 }
7858#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7859
7860 /*
7861 * Get various info structures
7862 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7864 if (ciphersuite_info == NULL) {
7865 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7866 ciphersuite));
7867 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007868 }
7869
Neil Armstrongab555e02022-04-04 11:07:59 +02007870 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007871#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007873#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007874 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007875
Gilles Peskine449bd832023-01-11 14:50:10 +01007876 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007877 transform->taglen =
7878 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007879 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007880
Dave Rodgman2eab4622023-10-05 13:30:37 +01007881 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007882 transform->taglen,
7883 &alg,
7884 &key_type,
7885 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007886 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007888 goto end;
7889 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007890
Dave Rodgman2eab4622023-10-05 13:30:37 +01007891 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007893 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007894 (unsigned) ciphersuite_info->mac));
7895 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007896 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007897
7898#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7899 /* Copy own and peer's CID if the use of the CID
7900 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7902 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007903
7904 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7906 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7907 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007908
7909 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7911 ssl->handshake->peer_cid_len);
7912 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7913 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007914 }
7915#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7916
7917 /*
7918 * Compute key block using the PRF
7919 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7921 if (ret != 0) {
7922 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7923 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007924 }
7925
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7927 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7928 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7929 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7930 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007931
7932 /*
7933 * Determine the appropriate key, IV and MAC length.
7934 */
7935
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007936 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007937
Valerio Settie5707042023-10-11 11:54:42 +02007938#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007939 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007940 size_t explicit_ivlen;
7941
7942 transform->maclen = 0;
7943 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007944
7945 /* All modes haves 96-bit IVs, but the length of the static parts vary
7946 * with mode and version:
7947 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7948 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7949 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7950 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7951 * sequence number).
7952 */
7953 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007954
7955 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007956 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007957
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007959 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007961 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007962 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007963
7964 /* Minimum length of encrypted record */
7965 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7966 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007967 } else
Valerio Settie5707042023-10-11 11:54:42 +02007968#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007969#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007971 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007972 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007974
Neil Armstronge4512952022-03-08 09:08:22 +01007975 /* Get MAC length */
7976 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007977 transform->maclen = mac_key_len;
7978
7979 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007980 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007981
7982 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007984 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007985 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007986 /*
7987 * GenericBlockCipher:
7988 * 1. if EtM is in use: one block plus MAC
7989 * otherwise: * first multiple of blocklen greater than maclen
7990 * 2. IV
7991 */
7992#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007994 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007995 + block_size;
7996 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007997#endif
7998 {
7999 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 + block_size
8001 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008002 }
8003
Gilles Peskine449bd832023-01-11 14:50:10 +01008004 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008005 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 } else {
8007 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008008 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8009 goto end;
8010 }
8011 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008013#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8014 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008015 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8016 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008017 }
8018
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8020 (unsigned) keylen,
8021 (unsigned) transform->minlen,
8022 (unsigned) transform->ivlen,
8023 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008024
8025 /*
8026 * Finally setup the cipher contexts, IVs and MAC secrets.
8027 */
8028#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008030 key1 = keyblk + mac_key_len * 2;
8031 key2 = keyblk + mac_key_len * 2 + keylen;
8032
8033 mac_enc = keyblk;
8034 mac_dec = keyblk + mac_key_len;
8035
Gilles Peskine449bd832023-01-11 14:50:10 +01008036 iv_copy_len = (transform->fixed_ivlen) ?
8037 transform->fixed_ivlen : transform->ivlen;
8038 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8039 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8040 iv_copy_len);
8041 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008042#endif /* MBEDTLS_SSL_CLI_C */
8043#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008045 key1 = keyblk + mac_key_len * 2 + keylen;
8046 key2 = keyblk + mac_key_len * 2;
8047
8048 mac_enc = keyblk + mac_key_len;
8049 mac_dec = keyblk;
8050
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 iv_copy_len = (transform->fixed_ivlen) ?
8052 transform->fixed_ivlen : transform->ivlen;
8053 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8054 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8055 iv_copy_len);
8056 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008057#endif /* MBEDTLS_SSL_SRV_C */
8058 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008060 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8061 goto end;
8062 }
8063
Paul Elliott4fb19552023-10-18 12:15:30 +01008064 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008065 ssl->f_export_keys(ssl->p_export_keys,
8066 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8067 master, 48,
8068 randbytes + 32,
8069 randbytes,
8070 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008071 }
8072
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008073 transform->psa_alg = alg;
8074
Gilles Peskine449bd832023-01-11 14:50:10 +01008075 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8076 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8077 psa_set_key_algorithm(&attributes, alg);
8078 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008079
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 if ((status = psa_import_key(&attributes,
8081 key1,
8082 PSA_BITS_TO_BYTES(key_bits),
8083 &transform->psa_key_enc)) != PSA_SUCCESS) {
8084 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008085 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008087 goto end;
8088 }
8089
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008091
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 if ((status = psa_import_key(&attributes,
8093 key2,
8094 PSA_BITS_TO_BYTES(key_bits),
8095 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008096 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008097 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008098 goto end;
8099 }
8100 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008101
Neil Armstrong29c0c042022-03-17 17:47:28 +01008102#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8103 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8104 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008105 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008106 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008107
Gilles Peskine449bd832023-01-11 14:50:10 +01008108 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8109 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8110 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008111
Gilles Peskine449bd832023-01-11 14:50:10 +01008112 if ((status = psa_import_key(&attributes,
8113 mac_enc, mac_key_len,
8114 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008115 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008116 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008117 goto end;
8118 }
8119
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8121 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008122#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008123 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008124#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008126 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008127 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8128 PSA_KEY_USAGE_VERIFY_HASH);
8129 } else {
8130 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8131 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008132
Gilles Peskine449bd832023-01-11 14:50:10 +01008133 if ((status = psa_import_key(&attributes,
8134 mac_dec, mac_key_len,
8135 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008136 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008137 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008138 goto end;
8139 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008140 }
8141#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8142
8143 ((void) mac_dec);
8144 ((void) mac_enc);
8145
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008146end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8148 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008149}
8150
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008151#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008152int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008153 psa_pake_operation_t *pake_ctx,
8154 const unsigned char *buf,
8155 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008156{
8157 psa_status_t status;
8158 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008159 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008160 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8161 * At round two perform a single cycle
8162 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008163 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008164
Gilles Peskine449bd832023-01-11 14:50:10 +01008165 for (; remaining_steps > 0; remaining_steps--) {
8166 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008167 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008168 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008169 /* Length is stored at the first byte */
8170 size_t length = buf[input_offset];
8171 input_offset += 1;
8172
Gilles Peskine449bd832023-01-11 14:50:10 +01008173 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008174 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8175 }
8176
Gilles Peskine449bd832023-01-11 14:50:10 +01008177 status = psa_pake_input(pake_ctx, step,
8178 buf + input_offset, length);
8179 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008180 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008181 }
8182
8183 input_offset += length;
8184 }
8185 }
8186
Gilles Peskine449bd832023-01-11 14:50:10 +01008187 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008188 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008189 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008190
Gilles Peskine449bd832023-01-11 14:50:10 +01008191 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008192}
8193
Valerio Setti6b3dab02022-11-17 17:14:54 +01008194int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008195 psa_pake_operation_t *pake_ctx,
8196 unsigned char *buf,
8197 size_t len, size_t *olen,
8198 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008199{
8200 psa_status_t status;
8201 size_t output_offset = 0;
8202 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008203 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008204 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8205 * At round two perform a single cycle
8206 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008208
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 for (; remaining_steps > 0; remaining_steps--) {
8210 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8211 step <= PSA_PAKE_STEP_ZK_PROOF;
8212 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008213 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008214 * For each step, prepend 1 byte with the length of the data as
8215 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008216 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008217 status = psa_pake_output(pake_ctx, step,
8218 buf + output_offset + 1,
8219 len - output_offset - 1,
8220 &output_len);
8221 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008222 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008223 }
8224
Valerio Setti99d88c12022-11-22 16:03:43 +01008225 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008226
8227 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008228 }
8229 }
8230
8231 *olen = output_offset;
8232
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008234}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008235#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008236
Gilles Peskine449bd832023-01-11 14:50:10 +01008237int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8238 unsigned char *hash, size_t *hashlen,
8239 unsigned char *data, size_t data_len,
8240 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008241{
8242 psa_status_t status;
8243 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008244 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008245
Gilles Peskine449bd832023-01-11 14:50:10 +01008246 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008247
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 if ((status = psa_hash_setup(&hash_operation,
8249 hash_alg)) != PSA_SUCCESS) {
8250 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008251 goto exit;
8252 }
8253
Gilles Peskine449bd832023-01-11 14:50:10 +01008254 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8255 64)) != PSA_SUCCESS) {
8256 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008257 goto exit;
8258 }
8259
Gilles Peskine449bd832023-01-11 14:50:10 +01008260 if ((status = psa_hash_update(&hash_operation,
8261 data, data_len)) != PSA_SUCCESS) {
8262 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008263 goto exit;
8264 }
8265
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8267 hashlen)) != PSA_SUCCESS) {
8268 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8269 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008270 }
8271
8272exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008273 if (status != PSA_SUCCESS) {
8274 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8275 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8276 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008277 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008278 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008279 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8280 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008281 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008282 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008283 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008284 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008285 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008286 }
8287 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008288 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008289}
8290
Jerry Yuee40f9d2022-02-17 14:55:16 +08008291
Jerry Yud9d91da2022-02-17 14:57:06 +08008292#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8293
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008294/* Find the preferred hash for a given signature algorithm. */
8295unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008296 mbedtls_ssl_context *ssl,
8297 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008298{
Gabor Mezei078e8032022-04-27 21:17:56 +02008299 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008300 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008301
Gilles Peskine449bd832023-01-11 14:50:10 +01008302 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8303 return MBEDTLS_SSL_HASH_NONE;
8304 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008305
Gilles Peskine449bd832023-01-11 14:50:10 +01008306 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008307 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8309 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008310 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8312 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008313
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008314 mbedtls_md_type_t md_alg =
8315 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8316 if (md_alg == MBEDTLS_MD_NONE) {
8317 continue;
8318 }
8319
Gilles Peskine449bd832023-01-11 14:50:10 +01008320 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008321 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008322 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008323 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008324
Gilles Peskine449bd832023-01-11 14:50:10 +01008325 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8326 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8327 PSA_ALG_ECDSA(psa_hash_alg),
8328 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008329 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008330 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008331
Gilles Peskine449bd832023-01-11 14:50:10 +01008332 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8333 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8334 PSA_ALG_RSA_PKCS1V15_SIGN(
8335 psa_hash_alg),
8336 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008337 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008339 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008340
Gilles Peskine449bd832023-01-11 14:50:10 +01008341 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008342 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008343 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008344
Gilles Peskine449bd832023-01-11 14:50:10 +01008345 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008346}
8347
8348#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8349
Jerry Yudc7bd172022-02-17 13:44:15 +08008350#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8351
XiaokangQian75d40ef2022-04-20 11:05:24 +00008352int mbedtls_ssl_validate_ciphersuite(
8353 const mbedtls_ssl_context *ssl,
8354 const mbedtls_ssl_ciphersuite_t *suite_info,
8355 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008356 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008357{
8358 (void) ssl;
8359
Gilles Peskine449bd832023-01-11 14:50:10 +01008360 if (suite_info == NULL) {
8361 return -1;
8362 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008363
Gilles Peskine449bd832023-01-11 14:50:10 +01008364 if ((suite_info->min_tls_version > max_tls_version) ||
8365 (suite_info->max_tls_version < min_tls_version)) {
8366 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008367 }
8368
XiaokangQian060d8672022-04-21 09:24:56 +00008369#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008370#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008371 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008372 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008373 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008374 }
8375#endif
8376
8377 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8378#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008379 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8380 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8381 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008382 }
8383#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8384#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8385
Gilles Peskine449bd832023-01-11 14:50:10 +01008386 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008387}
8388
Ronald Crone68ab4f2022-10-05 12:46:29 +02008389#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008390/*
8391 * Function for writing a signature algorithm extension.
8392 *
8393 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8394 * value (TLS 1.3 RFC8446):
8395 * enum {
8396 * ....
8397 * ecdsa_secp256r1_sha256( 0x0403 ),
8398 * ecdsa_secp384r1_sha384( 0x0503 ),
8399 * ecdsa_secp521r1_sha512( 0x0603 ),
8400 * ....
8401 * } SignatureScheme;
8402 *
8403 * struct {
8404 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8405 * } SignatureSchemeList;
8406 *
8407 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8408 * value (TLS 1.2 RFC5246):
8409 * enum {
8410 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8411 * sha512(6), (255)
8412 * } HashAlgorithm;
8413 *
8414 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8415 * SignatureAlgorithm;
8416 *
8417 * struct {
8418 * HashAlgorithm hash;
8419 * SignatureAlgorithm signature;
8420 * } SignatureAndHashAlgorithm;
8421 *
8422 * SignatureAndHashAlgorithm
8423 * supported_signature_algorithms<2..2^16-2>;
8424 *
8425 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8426 * generalization of the TLS 1.2 signature algorithm extension.
8427 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8428 * `SignatureScheme` field of TLS 1.3
8429 *
8430 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008431int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8432 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008433{
8434 unsigned char *p = buf;
8435 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8436 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8437
8438 *out_len = 0;
8439
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008441
8442 /* Check if we have space for header and length field:
8443 * - extension_type (2 bytes)
8444 * - extension_data_length (2 bytes)
8445 * - supported_signature_algorithms_length (2 bytes)
8446 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008447 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008448 p += 6;
8449
8450 /*
8451 * Write supported_signature_algorithms
8452 */
8453 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008454 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8455 if (sig_alg == NULL) {
8456 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8457 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008458
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8460 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8461 *sig_alg,
8462 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8463 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008464 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 }
8466 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8467 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008468 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008469 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8470 *sig_alg,
8471 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008472 }
8473
8474 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008475 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 if (supported_sig_alg_len == 0) {
8477 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8478 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008479 }
8480
Gilles Peskine449bd832023-01-11 14:50:10 +01008481 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8482 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8483 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008484
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008485 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008486
8487#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008488 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008489#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008490
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008492}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008493#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008494
XiaokangQian40a35232022-05-07 09:02:40 +00008495#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008496/*
8497 * mbedtls_ssl_parse_server_name_ext
8498 *
8499 * Structure of server_name extension:
8500 *
8501 * enum {
8502 * host_name(0), (255)
8503 * } NameType;
8504 * opaque HostName<1..2^16-1>;
8505 *
8506 * struct {
8507 * NameType name_type;
8508 * select (name_type) {
8509 * case host_name: HostName;
8510 * } name;
8511 * } ServerName;
8512 * struct {
8513 * ServerName server_name_list<1..2^16-1>
8514 * } ServerNameList;
8515 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008516MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008517int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8518 const unsigned char *buf,
8519 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008520{
8521 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8522 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008523 size_t server_name_list_len, hostname_len;
8524 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008525
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008527
Gilles Peskine449bd832023-01-11 14:50:10 +01008528 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8529 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008530 p += 2;
8531
Gilles Peskine449bd832023-01-11 14:50:10 +01008532 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008533 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008534 while (p < server_name_list_end) {
8535 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8536 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8537 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8538 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008539
Gilles Peskine449bd832023-01-11 14:50:10 +01008540 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008541 /* sni_name is intended to be used only during the parsing of the
8542 * ClientHello message (it is reset to NULL before the end of
8543 * the message parsing). Thus it is ok to just point to the
8544 * reception buffer and not make a copy of it.
8545 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008546 ssl->handshake->sni_name = p + 3;
8547 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008548 if (ssl->conf->f_sni == NULL) {
8549 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008550 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8552 ssl, p + 3, hostname_len);
8553 if (ret != 0) {
8554 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8555 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8556 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8557 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8558 }
8559 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008560 }
8561
8562 p += hostname_len + 3;
8563 }
8564
Gilles Peskine449bd832023-01-11 14:50:10 +01008565 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008566}
8567#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8568
XiaokangQianacb39922022-06-17 10:18:48 +00008569#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008570MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008571int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8572 const unsigned char *buf,
8573 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008574{
8575 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008576 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008577 const unsigned char *protocol_name_list;
8578 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008579 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008580
8581 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008582 if (ssl->conf->alpn_list == NULL) {
8583 return 0;
8584 }
XiaokangQianacb39922022-06-17 10:18:48 +00008585
8586 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008587 * RFC7301, section 3.1
8588 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008589 *
XiaokangQianc7403452022-06-23 03:24:12 +00008590 * struct {
8591 * ProtocolName protocol_name_list<2..2^16-1>
8592 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008593 */
8594
XiaokangQianc7403452022-06-23 03:24:12 +00008595 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008596 * protocol_name_list_len 2 bytes
8597 * protocol_name_len 1 bytes
8598 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008599 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008600 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008601
Gilles Peskine449bd832023-01-11 14:50:10 +01008602 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008603 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008605 protocol_name_list = p;
8606 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008607
8608 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008609 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008610 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008611 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8612 protocol_name_len);
8613 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008614 MBEDTLS_SSL_PEND_FATAL_ALERT(
8615 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8617 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008618 }
8619
8620 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008621 }
8622
8623 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01008624 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
8625 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008626 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008628 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 if (protocol_name_len == alpn_len &&
8630 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008631 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008632 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008633 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008634
8635 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008636 }
8637 }
8638
XiaokangQian95d5f542022-06-24 02:29:26 +00008639 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008640 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008641 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8642 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8643 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008644}
8645
Gilles Peskine449bd832023-01-11 14:50:10 +01008646int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8647 unsigned char *buf,
8648 unsigned char *end,
8649 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008650{
8651 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008652 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008653 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008654
Gilles Peskine449bd832023-01-11 14:50:10 +01008655 if (ssl->alpn_chosen == NULL) {
8656 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008657 }
8658
Gilles Peskine449bd832023-01-11 14:50:10 +01008659 protocol_name_len = strlen(ssl->alpn_chosen);
8660 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008661
Gilles Peskine449bd832023-01-11 14:50:10 +01008662 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008663 /*
8664 * 0 . 1 ext identifier
8665 * 2 . 3 ext length
8666 * 4 . 5 protocol list length
8667 * 6 . 6 protocol name length
8668 * 7 . 7+n protocol name
8669 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008670 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008671
XiaokangQian95d5f542022-06-24 02:29:26 +00008672 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008673
Gilles Peskine449bd832023-01-11 14:50:10 +01008674 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8675 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008676 /* Note: the length of the chosen protocol has been checked to be less
8677 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8678 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008679 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008680
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008682
8683#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008684 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008685#endif
8686
Gilles Peskine449bd832023-01-11 14:50:10 +01008687 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008688}
8689#endif /* MBEDTLS_SSL_ALPN */
8690
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008691#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008692 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008693 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008694 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008695int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8696 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008697{
8698 /* Initialize to suppress unnecessary compiler warning */
8699 size_t hostname_len = 0;
8700
8701 /* Check if new hostname is valid before
8702 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008703 if (hostname != NULL) {
8704 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008705
Gilles Peskine449bd832023-01-11 14:50:10 +01008706 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8707 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8708 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008709 }
8710
8711 /* Now it's clear that we will overwrite the old hostname,
8712 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008713 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008714 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008715 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008716 }
8717
8718 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008719 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008720 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008721 } else {
8722 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8723 if (session->hostname == NULL) {
8724 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8725 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008726
Gilles Peskine449bd832023-01-11 14:50:10 +01008727 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008728 }
8729
Gilles Peskine449bd832023-01-11 14:50:10 +01008730 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008731}
Xiaokang Qian03409292022-10-12 02:49:52 +00008732#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8733 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008734 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008735 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008736
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008737#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8738 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008739int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8740 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008741{
8742 size_t alpn_len = 0;
8743
8744 if (alpn != NULL) {
8745 alpn_len = strlen(alpn);
8746
8747 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8748 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8749 }
8750 }
8751
8752 if (session->ticket_alpn != NULL) {
8753 mbedtls_zeroize_and_free(session->ticket_alpn,
8754 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008755 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008756 }
8757
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008758 if (alpn != NULL) {
8759 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008760 if (session->ticket_alpn == NULL) {
8761 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8762 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008763 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008764 }
8765
8766 return 0;
8767}
8768#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008769
8770/*
8771 * The following functions are used by 1.2 and 1.3, client and server.
8772 */
8773#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8774int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8775 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8776 int recv_endpoint,
8777 mbedtls_ssl_protocol_version tls_version,
8778 uint32_t *flags)
8779{
8780 int ret = 0;
8781 unsigned int usage = 0;
8782 const char *ext_oid;
8783 size_t ext_len;
8784
8785 /*
8786 * keyUsage
8787 */
8788
8789 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8790 * to check what a compliant client will think while choosing which cert
8791 * to send to the client. */
8792#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8793 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8794 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8795 /* TLS 1.2 server part of the key exchange */
8796 switch (ciphersuite->key_exchange) {
8797 case MBEDTLS_KEY_EXCHANGE_RSA:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008798 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
8799 break;
8800
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008801 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8802 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8803 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8804 break;
8805
8806 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8807 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8808 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8809 break;
8810
8811 /* Don't use default: we want warnings when adding new values */
8812 case MBEDTLS_KEY_EXCHANGE_NONE:
8813 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008814 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8815 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8816 usage = 0;
8817 }
8818 } else
8819#endif
8820 {
8821 /* This is either TLS 1.3 authentication, which always uses signatures,
8822 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8823 * options we implement, both using signatures. */
8824 (void) tls_version;
8825 (void) ciphersuite;
8826 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8827 }
8828
8829 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8830 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8831 ret = -1;
8832 }
8833
8834 /*
8835 * extKeyUsage
8836 */
8837
8838 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8839 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8840 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8841 } else {
8842 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8843 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8844 }
8845
8846 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8847 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8848 ret = -1;
8849 }
8850
8851 return ret;
8852}
8853
8854int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8855 int authmode,
8856 mbedtls_x509_crt *chain,
8857 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8858 void *rs_ctx)
8859{
8860 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8861 return 0;
8862 }
8863
8864 /*
8865 * Primary check: use the appropriate X.509 verification function
8866 */
8867 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8868 void *p_vrfy;
8869 if (ssl->f_vrfy != NULL) {
8870 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8871 f_vrfy = ssl->f_vrfy;
8872 p_vrfy = ssl->p_vrfy;
8873 } else {
8874 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8875 f_vrfy = ssl->conf->f_vrfy;
8876 p_vrfy = ssl->conf->p_vrfy;
8877 }
8878
8879 int ret = 0;
8880 int have_ca_chain_or_callback = 0;
8881#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8882 if (ssl->conf->f_ca_cb != NULL) {
8883 ((void) rs_ctx);
8884 have_ca_chain_or_callback = 1;
8885
8886 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8887 ret = mbedtls_x509_crt_verify_with_ca_cb(
8888 chain,
8889 ssl->conf->f_ca_cb,
8890 ssl->conf->p_ca_cb,
8891 ssl->conf->cert_profile,
8892 ssl->hostname,
8893 &ssl->session_negotiate->verify_result,
8894 f_vrfy, p_vrfy);
8895 } else
8896#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8897 {
8898 mbedtls_x509_crt *ca_chain;
8899 mbedtls_x509_crl *ca_crl;
8900#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8901 if (ssl->handshake->sni_ca_chain != NULL) {
8902 ca_chain = ssl->handshake->sni_ca_chain;
8903 ca_crl = ssl->handshake->sni_ca_crl;
8904 } else
8905#endif
8906 {
8907 ca_chain = ssl->conf->ca_chain;
8908 ca_crl = ssl->conf->ca_crl;
8909 }
8910
8911 if (ca_chain != NULL) {
8912 have_ca_chain_or_callback = 1;
8913 }
8914
8915 ret = mbedtls_x509_crt_verify_restartable(
8916 chain,
8917 ca_chain, ca_crl,
8918 ssl->conf->cert_profile,
8919 ssl->hostname,
8920 &ssl->session_negotiate->verify_result,
8921 f_vrfy, p_vrfy, rs_ctx);
8922 }
8923
8924 if (ret != 0) {
8925 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8926 }
8927
8928#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8929 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8930 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8931 }
8932#endif
8933
8934 /*
8935 * Secondary checks: always done, but change 'ret' only if it was 0
8936 */
8937
8938 /* With TLS 1.2 and ECC certs, check that the curve used by the
8939 * certificate is on our list of acceptable curves.
8940 *
8941 * With TLS 1.3 this is not needed because the curve is part of the
8942 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8943 * we validate the signature made with the key associated to this cert.
8944 */
8945#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8946 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8947 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8948 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8949 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8950 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8951 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8952 if (ret == 0) {
8953 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8954 }
8955 }
8956 }
8957#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8958
8959 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8960 if (mbedtls_ssl_check_cert_usage(chain,
8961 ciphersuite_info,
8962 ssl->conf->endpoint,
8963 ssl->tls_version,
8964 &ssl->session_negotiate->verify_result) != 0) {
8965 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8966 if (ret == 0) {
8967 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8968 }
8969 }
8970
8971 /* With authmode optional, we want to keep going if the certificate was
8972 * unacceptable, but still fail on other errors (out of memory etc),
8973 * including fatal errors from the f_vrfy callback.
8974 *
8975 * The only acceptable errors are:
8976 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8977 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8978 * Anything else is a fatal error. */
8979 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8980 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8981 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8982 ret = 0;
8983 }
8984
8985 /* Return a specific error as this is a user error: inconsistent
8986 * configuration - can't verify without trust anchors. */
8987 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8988 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8989 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8990 }
8991
8992 if (ret != 0) {
8993 uint8_t alert;
8994
8995 /* The certificate may have been rejected for several reasons.
8996 Pick one and send the corresponding alert. Which alert to send
8997 may be a subject of debate in some cases. */
8998 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8999 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
9000 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
9001 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
9002 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
9003 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9004 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
9005 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9006 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
9007 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9008 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
9009 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9010 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
9011 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
9012 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
9013 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
9014 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
9015 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
9016 } else {
9017 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
9018 }
9019 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9020 alert);
9021 }
9022
9023#if defined(MBEDTLS_DEBUG_C)
9024 if (ssl->session_negotiate->verify_result != 0) {
9025 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
9026 (unsigned int) ssl->session_negotiate->verify_result));
9027 } else {
9028 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
9029 }
9030#endif /* MBEDTLS_DEBUG_C */
9031
9032 return ret;
9033}
9034#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
9035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009036#endif /* MBEDTLS_SSL_TLS_C */