blob: dd1beb98b72726d8743f41348975b6c2622cc680 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Harry Ramsey0f6bc412024-10-04 10:36:54 +010012#include "ssl_misc.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040021
Valerio Settib4f50762024-01-17 10:24:52 +010022#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000023#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050024#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010025#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020026#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020027
Rich Evans00ab4702015-02-06 13:43:58 +000028#include <string.h>
29
Valerio Setti384fbde2024-01-02 13:26:40 +010030#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020031#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020032#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050033#include "psa/crypto.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034
Janos Follath23bdca02016-10-07 14:47:14 +010035#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000036#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020037#endif
38
Andrzej Kurek00644842023-05-30 05:45:00 -040039/* Define local translating functions to save code size by not using too many
40 * arguments in each translating place. */
41static int local_err_translation(psa_status_t status)
42{
43 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040044 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040045 psa_generic_status_to_mbedtls);
46}
47#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050048
Ronald Cronad8c17b2022-06-10 17:18:09 +020049#if defined(MBEDTLS_TEST_HOOKS)
50static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
51
52void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010053 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020054{
55 chk_buf_ptr_fail_args.cur = cur;
56 chk_buf_ptr_fail_args.end = end;
57 chk_buf_ptr_fail_args.need = need;
58}
59
Gilles Peskine449bd832023-01-11 14:50:10 +010060void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020061{
Gilles Peskine449bd832023-01-11 14:50:10 +010062 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020063}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 return (chk_buf_ptr_fail_args.cur != args->cur) ||
68 (chk_buf_ptr_fail_args.end != args->end) ||
69 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020070}
71#endif /* MBEDTLS_TEST_HOOKS */
72
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020073#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010074
Hanno Beckera0e20d02019-05-15 14:03:01 +010075#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010076/* Top-level Connection ID API */
77
Gilles Peskine449bd832023-01-11 14:50:10 +010078int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
79 size_t len,
80 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010081{
Gilles Peskine449bd832023-01-11 14:50:10 +010082 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
83 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
84 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010085
Gilles Peskine449bd832023-01-11 14:50:10 +010086 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
87 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010089 }
90
91 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010092 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010093 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010094}
95
Gilles Peskine449bd832023-01-11 14:50:10 +010096int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
97 int enable,
98 unsigned char const *own_cid,
99 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100100{
Gilles Peskine449bd832023-01-11 14:50:10 +0100101 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
102 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
103 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100104
Hanno Beckerca092242019-04-25 16:01:49 +0100105 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (enable == MBEDTLS_SSL_CID_DISABLED) {
107 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
108 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100109 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
111 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100112
Gilles Peskine449bd832023-01-11 14:50:10 +0100113 if (own_cid_len != ssl->conf->cid_len) {
114 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
115 (unsigned) own_cid_len,
116 (unsigned) ssl->conf->cid_len));
117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100118 }
119
Gilles Peskine449bd832023-01-11 14:50:10 +0100120 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100121 /* Truncation is not an issue here because
122 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
123 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100126}
127
Gilles Peskine449bd832023-01-11 14:50:10 +0100128int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
129 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +0100130 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100131 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000132{
133 *enabled = MBEDTLS_SSL_CID_DISABLED;
134
Gilles Peskine449bd832023-01-11 14:50:10 +0100135 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
136 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
137 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000138
139 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
140 * zero as this is indistinguishable from not requesting to use
141 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100142 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
143 return 0;
144 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000145
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000147 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100148 if (own_cid != NULL) {
149 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
150 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000151 }
152
153 *enabled = MBEDTLS_SSL_CID_ENABLED;
154
Gilles Peskine449bd832023-01-11 14:50:10 +0100155 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000156}
157
Gilles Peskine449bd832023-01-11 14:50:10 +0100158int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
159 int *enabled,
160 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
161 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100162{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100163 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100164
Gilles Peskine449bd832023-01-11 14:50:10 +0100165 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
166 mbedtls_ssl_is_handshake_over(ssl) == 0) {
167 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100168 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Hanno Beckerc5f24222019-05-03 12:54:52 +0100170 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
171 * were used, but client and server requested the empty CID.
172 * This is indistinguishable from not using the CID extension
173 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 if (ssl->transform_in->in_cid_len == 0 &&
175 ssl->transform_in->out_cid_len == 0) {
176 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177 }
178
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100180 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100181 if (peer_cid != NULL) {
182 memcpy(peer_cid, ssl->transform_in->out_cid,
183 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100184 }
185 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100186
187 *enabled = MBEDTLS_SSL_CID_ENABLED;
188
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100190}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100191#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200193#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200195#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200196/*
197 * Convert max_fragment_length codes to length.
198 * RFC 6066 says:
199 * enum{
200 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
201 * } MaxFragmentLength;
202 * and we add 0 -> extension unused
203 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100204static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200205{
Gilles Peskine449bd832023-01-11 14:50:10 +0100206 switch (mfl) {
207 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
208 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
209 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
210 return 512;
211 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
212 return 1024;
213 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
214 return 2048;
215 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
216 return 4096;
217 default:
218 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000219 }
220}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200221#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200222
Gilles Peskine449bd832023-01-11 14:50:10 +0100223int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
224 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200225{
Gilles Peskine449bd832023-01-11 14:50:10 +0100226 mbedtls_ssl_session_free(dst);
227 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800228#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
229 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000230#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
231 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000232 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800233#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000234#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800235
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000236#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
237 defined(MBEDTLS_SSL_EARLY_DATA)
238 dst->ticket_alpn = NULL;
239#endif
240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000242
243#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
248 if (dst->peer_cert == NULL) {
249 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
250 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200253
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
255 src->peer_cert->raw.len)) != 0) {
256 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200257 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259 }
260 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000261#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000263 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 mbedtls_calloc(1, src->peer_cert_digest_len);
265 if (dst->peer_cert_digest == NULL) {
266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
267 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000268
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
270 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000272 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 }
274#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200277
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000278#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
279 defined(MBEDTLS_SSL_EARLY_DATA)
280 {
281 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
282 if (ret != 0) {
283 return ret;
284 }
285 }
286#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
287
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200288#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (src->ticket != NULL) {
290 dst->ticket = mbedtls_calloc(1, src->ticket_len);
291 if (dst->ticket == NULL) {
292 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
293 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200294
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200296 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000297
298#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
299 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000301 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
303 if (ret != 0) {
304 return ret;
305 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000306 }
307#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
308 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200309#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200310
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200312}
313
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500314#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200315MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100316static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500317{
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
319 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800320 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500322
323 /* We want to copy len_new bytes when downsizing the buffer, and
324 * len_old bytes when upsizing, so we choose the smaller of two sizes,
325 * to fit one buffer into another. Size checks, ensuring that no data is
326 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 memcpy(resized_buffer, *buffer,
328 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100329 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500330
331 *buffer = resized_buffer;
332 *len_old = len_new;
333
334 return 0;
335}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200336
Gilles Peskine449bd832023-01-11 14:50:10 +0100337static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
338 size_t in_buf_new_len,
339 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200340{
341 int modified = 0;
342 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
343 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 written_in = ssl->in_msg - ssl->in_buf;
346 iv_offset_in = ssl->in_iv - ssl->in_buf;
347 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200349 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 ssl->in_buf_len < in_buf_new_len) {
351 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
352 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
353 } else {
354 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
355 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200356 modified = 1;
357 }
358 }
359 }
360
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200362 written_out = ssl->out_msg - ssl->out_buf;
363 iv_offset_out = ssl->out_iv - ssl->out_buf;
364 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200366 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 ssl->out_buf_len < out_buf_new_len) {
368 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
369 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
370 } else {
371 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
372 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200373 modified = 1;
374 }
375 }
376 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200378 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200380 /* Fields below might not be properly updated with record
381 * splitting or with CID, so they are manually updated here. */
382 ssl->out_msg = ssl->out_buf + written_out;
383 ssl->out_len = ssl->out_buf + len_offset_out;
384 ssl->out_iv = ssl->out_buf + iv_offset_out;
385
386 ssl->in_msg = ssl->in_buf + written_in;
387 ssl->in_len = ssl->in_buf + len_offset_in;
388 ssl->in_iv = ssl->in_buf + iv_offset_in;
389 }
390}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500391#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
392
Jerry Yudb8c48a2022-01-27 14:54:54 +0800393#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800394
395#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100396typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
397 const char *label,
398 const unsigned char *random, size_t rlen,
399 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800400
Gilles Peskine449bd832023-01-11 14:50:10 +0100401static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800402
403#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
404
405/* Type for the TLS PRF */
406typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
407 const unsigned char *, size_t,
408 unsigned char *, size_t);
409
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200410MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100411static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
412 int ciphersuite,
413 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200414#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200416#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 ssl_tls_prf_t tls_prf,
418 const unsigned char randbytes[64],
419 mbedtls_ssl_protocol_version tls_version,
420 unsigned endpoint,
421 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800422
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100423#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200424MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100425static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300426 const char *label,
427 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100429static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
430static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100431
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100432#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100433
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100434#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100435MBEDTLS_CHECK_RETURN_CRITICAL
436static int tls_prf_sha384(const unsigned char *secret, size_t slen,
437 const char *label,
438 const unsigned char *random, size_t rlen,
439 unsigned char *dstbuf, size_t dlen);
440
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100441static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
442static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100443#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100444
Gilles Peskine449bd832023-01-11 14:50:10 +0100445MBEDTLS_CHECK_RETURN_CRITICAL
446static int ssl_tls12_session_load(mbedtls_ssl_session *session,
447 const unsigned char *buf,
448 size_t len);
449#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
450
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100451static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100452
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100453#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100454static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100455#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100456
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100457#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100458static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100459#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100460
461int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
462 const unsigned char *secret, size_t slen,
463 const char *label,
464 const unsigned char *random, size_t rlen,
465 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300466{
467 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
468
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300470#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100471#if defined(PSA_WANT_ALG_SHA_384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300472 case MBEDTLS_SSL_TLS_PRF_SHA384:
473 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 break;
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100475#endif /* PSA_WANT_ALG_SHA_384*/
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100476#if defined(PSA_WANT_ALG_SHA_256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 case MBEDTLS_SSL_TLS_PRF_SHA256:
478 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 break;
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100480#endif /* PSA_WANT_ALG_SHA_256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300481#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100482 default:
483 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300484 }
485
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300487}
488
Jerry Yuc73c6182022-02-08 20:29:25 +0800489#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100490static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800491{
492#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100493 if (session->peer_cert != NULL) {
494 mbedtls_x509_crt_free(session->peer_cert);
495 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800496 session->peer_cert = NULL;
497 }
498#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100499 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800500 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100501 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800502 session->peer_cert_digest = NULL;
503 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
504 session->peer_cert_digest_len = 0;
505 }
506#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
507}
508#endif /* MBEDTLS_X509_CRT_PARSE_C */
509
Gilles Peskine449bd832023-01-11 14:50:10 +0100510uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800511{
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800513 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800515
516 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800518
519 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800521
522 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100523 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800524
525 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100526 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800527
528 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100529 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800530
531 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800533
534 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800536
537 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800539
540 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800542
543 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800545
546 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800548
549 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800551
552 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800554
555 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800557
558 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800560
561 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800563
564 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800566
567 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800569
570 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800572
573 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800575
576 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800578
579 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800581
582 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800584
585 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800587
588 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800590
Jan Bruckner151f6422023-02-10 12:45:19 +0100591 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
592 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
593
Jerry Yu7a485c12022-10-31 13:08:18 +0800594 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100595 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800596
597 }
598
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800600}
601
Gilles Peskine449bd832023-01-11 14:50:10 +0100602uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800603{
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800605}
606
Jerry Yud25cab02022-10-31 12:48:30 +0800607#if defined(MBEDTLS_DEBUG_C)
608static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800609 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800610 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
611 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
612 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
613 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
614 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
615 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
616 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
617 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
618 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
619 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
620 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
621 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
622 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
623 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
624 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
625 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
626 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
627 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
628 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
629 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
630 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
631 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
632 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
633 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
634 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
635 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100636 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
637 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800638};
639
Chien Wong4e9683e2023-12-28 17:07:43 +0800640static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800641 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
642 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
643 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
644 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
645 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
646 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
647 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
648 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
649 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
650 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
651 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
652 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
653 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
654 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
655 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
656 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
657 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
658 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
659 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
660 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
661 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
662 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
663 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
664 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
665 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
666 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
667 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100668 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
669 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800670};
671
Gilles Peskine449bd832023-01-11 14:50:10 +0100672const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800673{
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 return extension_name_table[
675 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800676}
677
Gilles Peskine449bd832023-01-11 14:50:10 +0100678static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800679{
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800681 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800683 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800685 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800687 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800689 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800691 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800693 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800695 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800697}
698
Gilles Peskine449bd832023-01-11 14:50:10 +0100699void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
700 int level, const char *file, int line,
701 int hs_msg_type, unsigned int extension_type,
702 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800703{
704 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800706 mbedtls_debug_print_msg(
707 ssl, level, file, line,
708 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 ssl_tls13_get_hs_msg_name(hs_msg_type),
710 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800711 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100712 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800713 return;
714 }
715
716 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800718 mbedtls_debug_print_msg(
719 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
721 mbedtls_ssl_get_extension_name(extension_type), extension_type,
722 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800723 return;
724 }
725
726 mbedtls_debug_print_msg(
727 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
729 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800730}
731
Gilles Peskine449bd832023-01-11 14:50:10 +0100732void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
733 int level, const char *file, int line,
734 int hs_msg_type, uint32_t extensions_mask,
735 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800736{
737
Gilles Peskine449bd832023-01-11 14:50:10 +0100738 for (unsigned i = 0;
739 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
740 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800741 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800742 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800744 }
745}
746
Pengyu Lvee455c02023-01-12 14:37:24 +0800747#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800748static const char *ticket_flag_name_table[] =
749{
750 [0] = "ALLOW_PSK_RESUMPTION",
751 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
752 [3] = "ALLOW_EARLY_DATA",
753};
754
Pengyu Lv4938a562023-01-16 11:28:49 +0800755void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
756 int level, const char *file, int line,
757 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800758{
759 size_t i;
760
761 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800762 "print ticket_flags (0x%02x)", flags);
763
764 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800765
766 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800768 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
769 ticket_flag_name_table[i]);
770 }
771 }
772}
773#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
774
Jerry Yud25cab02022-10-31 12:48:30 +0800775#endif /* MBEDTLS_DEBUG_C */
776
Gilles Peskine449bd832023-01-11 14:50:10 +0100777void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
778 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800779{
780 ((void) ciphersuite_info);
781
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100782#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800784 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800786#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100787#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800789 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
792 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 return;
795 }
796}
797
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100798int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100799 unsigned hs_type,
800 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100801{
802 unsigned char hs_hdr[4];
803
804 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100805 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
806 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
807 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
808 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100809
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100810 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100811}
812
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100813int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100814 unsigned hs_type,
815 unsigned char const *msg,
816 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100817{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818 int ret;
819 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100820 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100821 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100822 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100824}
825
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100826int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800827{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100828#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100829 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100830 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100831#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800832 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100833#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100834#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
836 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200837 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100838 }
839 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
840 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200841 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100842 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800843#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100844#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100845 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
846 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200847 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 }
849 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
850 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200851 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100852 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800853#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100854 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800855}
856
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100857static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100858 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800859{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100860#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100861 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100862 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100863#else /* SHA-256 or SHA-384 */
864 ((void) ssl);
865 (void) buf;
866 (void) len;
867#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100868#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100869 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
870 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200871 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100872 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800873#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100874#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100875 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
876 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200877 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100878 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800879#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800881}
882
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100883#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100884static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100885 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800886{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200887 return mbedtls_md_error_from_psa(psa_hash_update(
888 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800889}
890#endif
891
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100892#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100893static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100894 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800895{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200896 return mbedtls_md_error_from_psa(psa_hash_update(
897 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800898}
899#endif
900
Gilles Peskine449bd832023-01-11 14:50:10 +0100901static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200902{
Gilles Peskine449bd832023-01-11 14:50:10 +0100903 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200904
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100905#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500906 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500907#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100908#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500909 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500910#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200911
912 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100913
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200914#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100915 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200916#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200917#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200918 handshake->psa_pake_ctx = psa_pake_operation_init();
919 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200920#if defined(MBEDTLS_SSL_CLI_C)
921 handshake->ecjpake_cache = NULL;
922 handshake->ecjpake_cache_len = 0;
923#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200924#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200925
Gilles Peskineeccd8882020-03-10 12:19:08 +0100926#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200928#endif
929
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200930#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
931 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
932#endif
Hanno Becker75173122019-02-06 16:18:31 +0000933
934#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
935 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100936 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +0000937#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200938}
939
Gilles Peskine449bd832023-01-11 14:50:10 +0100940void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200941{
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +0200943
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100944 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
945 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100946
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000947#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100948 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
949 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100950#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200951}
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956}
957
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200958MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100959static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +0000960{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100961 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
962
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200963 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +0800964#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +0100965 if (ssl->transform_negotiate) {
966 mbedtls_ssl_transform_free(ssl->transform_negotiate);
967 }
Jerry Yu2e199812022-12-01 18:57:19 +0800968#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 if (ssl->session_negotiate) {
970 mbedtls_ssl_session_free(ssl->session_negotiate);
971 }
972 if (ssl->handshake) {
973 mbedtls_ssl_handshake_free(ssl);
974 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200975
Jerry Yu2e199812022-12-01 18:57:19 +0800976#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977 /*
978 * Either the pointers are now NULL or cleared properly and can be freed.
979 * Now allocate missing structures.
980 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 if (ssl->transform_negotiate == NULL) {
982 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200983 }
Jerry Yu2e199812022-12-01 18:57:19 +0800984#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000985
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 if (ssl->session_negotiate == NULL) {
987 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200988 }
Paul Bakker48916f92012-09-16 19:57:18 +0000989
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 if (ssl->handshake == NULL) {
991 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200992 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500993#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
994 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400995
Gilles Peskine449bd832023-01-11 14:50:10 +0100996 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
997 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500998#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000999
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001000 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001002#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001003 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001004#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001005 ssl->session_negotiate == NULL) {
1006 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001010
1011#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001012 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001013 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001014#endif
1015
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001017 ssl->session_negotiate = NULL;
1018
Gilles Peskine449bd832023-01-11 14:50:10 +01001019 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001020 }
1021
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001022#if defined(MBEDTLS_SSL_EARLY_DATA)
1023#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001024 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001025#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001026#if defined(MBEDTLS_SSL_SRV_C)
1027 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1028#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001029 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001030#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001031
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001032 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 mbedtls_ssl_session_init(ssl->session_negotiate);
1034 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001035
Jerry Yu2e199812022-12-01 18:57:19 +08001036#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001038#endif
1039
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001040 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001041 ret = mbedtls_ssl_reset_checksum(ssl);
1042 if (ret != 0) {
1043 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1044 return ret;
1045 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001046
Jerry Yud0766ec2022-09-22 10:46:57 +08001047#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1048 defined(MBEDTLS_SSL_SRV_C) && \
1049 defined(MBEDTLS_SSL_SESSION_TICKETS)
1050 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001051 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001052#endif
1053
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001056 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001057
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001059 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001061 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001065 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001066#endif
1067
Ronald Crone68ab4f2022-10-05 12:46:29 +02001068#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001069#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001070#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001071 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1072 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001073 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1074 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001075 const int *md;
1076 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001077 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001078 uint16_t *p;
1079
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001080 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1081 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1082 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001083
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1085 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001086 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001088#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001090#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001091
Jerry Yub476a442022-01-21 18:14:45 +08001092#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001094#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1096 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1097 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001098 }
1099
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1101 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1102 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001103
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1105 sizeof(uint16_t));
1106 if (ssl->handshake->sig_algs == NULL) {
1107 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1108 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001109
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 p = (uint16_t *) ssl->handshake->sig_algs;
1111 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1112 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1113 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001114 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001116#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001118 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001119#endif
1120#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001122 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001123#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001124 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001125 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001126 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001128#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001129 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001130 ssl->handshake->sig_algs_heap_allocated = 0;
1131 }
Jerry Yucc539102022-06-27 16:27:35 +08001132#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001133#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001135}
1136
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001137#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001138/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001139MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001140static int ssl_cookie_write_dummy(void *ctx,
1141 unsigned char **p, unsigned char *end,
1142 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001143{
1144 ((void) ctx);
1145 ((void) p);
1146 ((void) end);
1147 ((void) cli_id);
1148 ((void) cli_id_len);
1149
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001151}
1152
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001153MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001154static int ssl_cookie_check_dummy(void *ctx,
1155 const unsigned char *cookie, size_t cookie_len,
1156 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001157{
1158 ((void) ctx);
1159 ((void) cookie);
1160 ((void) cookie_len);
1161 ((void) cli_id);
1162 ((void) cli_id_len);
1163
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001165}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001166#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001167
Paul Bakker5121ce52009-01-03 21:22:43 +00001168/*
1169 * Initialize an SSL context
1170 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001171void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001172{
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001174}
1175
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001176MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001177static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001178{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001179 const mbedtls_ssl_config *conf = ssl->conf;
1180
Ronald Cron6f135e12021-12-08 16:57:54 +01001181#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1183 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1184 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1185 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001186 }
1187
Gilles Peskine449bd832023-01-11 14:50:10 +01001188 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1189 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001190 }
1191#endif
1192
1193#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1195 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1196 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001197 }
1198#endif
1199
Ronald Cron6f135e12021-12-08 16:57:54 +01001200#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1202 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1203 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1204 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001205 }
1206
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1208 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001209 }
1210#endif
1211
Gilles Peskine449bd832023-01-11 14:50:10 +01001212 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1213 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001214}
1215
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001216MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001217static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1218{
1219 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 ret = ssl_conf_version_check(ssl);
1221 if (ret != 0) {
1222 return ret;
1223 }
Jerry Yu60835a82021-08-04 10:13:52 +08001224
Yanray Wangb422cab2023-12-01 16:18:10 +08001225 if (ssl->conf->f_rng == NULL) {
1226 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1227 return MBEDTLS_ERR_SSL_NO_RNG;
1228 }
1229
Jerry Yu60835a82021-08-04 10:13:52 +08001230 /* Space for further checks */
1231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001233}
1234
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001235/*
1236 * Setup an SSL context
1237 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001238
Gilles Peskine449bd832023-01-11 14:50:10 +01001239int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1240 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001241{
Janos Follath865b3eb2019-12-16 11:46:15 +00001242 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001243 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1244 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001245
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001246 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001247
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 if ((ret = ssl_conf_check(ssl)) != 0) {
1249 return ret;
1250 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001251 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001252
Paul Bakker62f2dee2012-09-28 07:31:51 +00001253 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001254 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001255 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001256
1257 /* Set to NULL in case of an error condition */
1258 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001259
Darryl Greenb33cc762019-11-28 14:29:44 +00001260#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1261 ssl->in_buf_len = in_buf_len;
1262#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1264 if (ssl->in_buf == NULL) {
1265 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001266 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001267 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001268 }
1269
Darryl Greenb33cc762019-11-28 14:29:44 +00001270#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1271 ssl->out_buf_len = out_buf_len;
1272#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001273 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1274 if (ssl->out_buf == NULL) {
1275 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001276 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001277 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001278 }
1279
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001281
Johan Pascalb62bb512015-12-03 21:56:45 +01001282#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001284#endif
1285
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001287 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001289
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001291
1292error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 mbedtls_free(ssl->in_buf);
1294 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001295
1296 ssl->conf = NULL;
1297
Darryl Greenb33cc762019-11-28 14:29:44 +00001298#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1299 ssl->in_buf_len = 0;
1300 ssl->out_buf_len = 0;
1301#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001302 ssl->in_buf = NULL;
1303 ssl->out_buf = NULL;
1304
1305 ssl->in_hdr = NULL;
1306 ssl->in_ctr = NULL;
1307 ssl->in_len = NULL;
1308 ssl->in_iv = NULL;
1309 ssl->in_msg = NULL;
1310
1311 ssl->out_hdr = NULL;
1312 ssl->out_ctr = NULL;
1313 ssl->out_len = NULL;
1314 ssl->out_iv = NULL;
1315 ssl->out_msg = NULL;
1316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001318}
1319
1320/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001321 * Reset an initialized and used SSL context for re-use while retaining
1322 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001323 *
1324 * If partial is non-zero, keep data in the input buffer and client ID.
1325 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001326 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001327void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1328 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001329{
Darryl Greenb33cc762019-11-28 14:29:44 +00001330#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1331 size_t in_buf_len = ssl->in_buf_len;
1332 size_t out_buf_len = ssl->out_buf_len;
1333#else
1334 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1335 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1336#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001337
Hanno Beckerb0302c42021-08-03 09:39:42 +01001338#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1339 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001340#endif
1341
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001342 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001344
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001346
1347 /* Reset incoming message parsing */
1348 ssl->in_offt = NULL;
1349 ssl->nb_zero = 0;
1350 ssl->in_msgtype = 0;
1351 ssl->in_msglen = 0;
1352 ssl->in_hslen = 0;
1353 ssl->keep_current_message = 0;
1354 ssl->transform_in = NULL;
1355
1356#if defined(MBEDTLS_SSL_PROTO_DTLS)
1357 ssl->next_record_offset = 0;
1358 ssl->in_epoch = 0;
1359#endif
1360
1361 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001363 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001365 }
1366
Ronald Cronad8c17b2022-06-10 17:18:09 +02001367 ssl->send_alert = 0;
1368
Hanno Beckerb0302c42021-08-03 09:39:42 +01001369 /* Reset outgoing message writing */
1370 ssl->out_msgtype = 0;
1371 ssl->out_msglen = 0;
1372 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001373 memset(ssl->out_buf, 0, out_buf_len);
1374 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001375 ssl->transform_out = NULL;
1376
1377#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001379#endif
1380
XiaokangQian2b01dc32022-01-21 02:53:13 +00001381#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 if (ssl->transform) {
1383 mbedtls_ssl_transform_free(ssl->transform);
1384 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001385 ssl->transform = NULL;
1386 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001387#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1388
XiaokangQian2b01dc32022-01-21 02:53:13 +00001389#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 mbedtls_ssl_transform_free(ssl->transform_application);
1391 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001392 ssl->transform_application = NULL;
1393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001395#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1397 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001398 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001399#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001400
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1402 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001403 ssl->handshake->transform_handshake = NULL;
1404 }
1405
XiaokangQian2b01dc32022-01-21 02:53:13 +00001406#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001407}
1408
Gilles Peskine449bd832023-01-11 14:50:10 +01001409int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001410{
1411 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1412
1413 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Gilles Peskine95fe2a62025-02-20 18:12:29 +01001414 ssl->flags = 0;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001415 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001416
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001418
1419 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001420#if defined(MBEDTLS_SSL_RENEGOTIATION)
1421 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001422 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001423
1424 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1426 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001427#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001429
Hanno Beckerb0302c42021-08-03 09:39:42 +01001430 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001431 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 if (ssl->session) {
1433 mbedtls_ssl_session_free(ssl->session);
1434 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001435 ssl->session = NULL;
1436 }
1437
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001438#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001439 ssl->alpn_chosen = NULL;
1440#endif
1441
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001442#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001443 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001444#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001446#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 if (free_cli_id) {
1448 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001449 ssl->cli_id = NULL;
1450 ssl->cli_id_len = 0;
1451 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001452#endif
1453
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 if ((ret = ssl_handshake_init(ssl)) != 0) {
1455 return ret;
1456 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001459}
1460
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001461/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001462 * Reset an initialized and used SSL context for re-use while retaining
1463 * all application-set variables, function pointers and data.
1464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001465int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001466{
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001468}
1469
1470/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001471 * SSL set accessors
1472 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001473void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001474{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001475 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001476}
1477
Gilles Peskine449bd832023-01-11 14:50:10 +01001478void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001479{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001480 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001481}
1482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001484void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001485{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001486 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001487}
1488#endif
1489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001491{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001492 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001493}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001494
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001496
Gilles Peskine449bd832023-01-11 14:50:10 +01001497void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1498 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001499{
1500 ssl->disable_datagram_packing = !allow_packing;
1501}
1502
Gilles Peskine449bd832023-01-11 14:50:10 +01001503void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1504 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001505{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001506 conf->hs_timeout_min = min;
1507 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001508}
1509#endif
1510
Gilles Peskine449bd832023-01-11 14:50:10 +01001511void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001512{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001513 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001514}
1515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001516#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001517void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1518 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1519 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001520{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001521 conf->f_vrfy = f_vrfy;
1522 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001523}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001524#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1527 int (*f_rng)(void *, unsigned char *, size_t),
1528 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001529{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001530 conf->f_rng = f_rng;
1531 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001532}
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1535 void (*f_dbg)(void *, int, const char *, int, const char *),
1536 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001537{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001538 conf->f_dbg = f_dbg;
1539 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001540}
1541
Gilles Peskine449bd832023-01-11 14:50:10 +01001542void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1543 void *p_bio,
1544 mbedtls_ssl_send_t *f_send,
1545 mbedtls_ssl_recv_t *f_recv,
1546 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001547{
1548 ssl->p_bio = p_bio;
1549 ssl->f_send = f_send;
1550 ssl->f_recv = f_recv;
1551 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001552}
1553
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001554#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001555void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001556{
1557 ssl->mtu = mtu;
1558}
1559#endif
1560
Gilles Peskine449bd832023-01-11 14:50:10 +01001561void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001562{
1563 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001564}
1565
Gilles Peskine449bd832023-01-11 14:50:10 +01001566void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1567 void *p_timer,
1568 mbedtls_ssl_set_timer_t *f_set_timer,
1569 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001570{
1571 ssl->p_timer = p_timer;
1572 ssl->f_set_timer = f_set_timer;
1573 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001574
1575 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001577}
1578
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001579#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001580void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1581 void *p_cache,
1582 mbedtls_ssl_cache_get_t *f_get_cache,
1583 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001584{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001585 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001586 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001587 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001588}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001590
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001591#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001592int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001593{
Janos Follath865b3eb2019-12-16 11:46:15 +00001594 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001597 session == NULL ||
1598 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1600 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001601 }
1602
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 if (ssl->handshake->resume == 1) {
1604 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1605 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001606
Jerry Yu21092062022-10-10 21:21:31 +08001607#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001608 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001609#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001610 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001612
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001614 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1616 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1617 session->ciphersuite));
1618 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001619 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001620#else
1621 /*
1622 * If session tickets are not enabled, it is not possible to resume a
1623 * TLS 1.3 session, thus do not make any change to the SSL context in
1624 * the first place.
1625 */
1626 return 0;
1627#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001628 }
Jerry Yu21092062022-10-10 21:21:31 +08001629#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1632 session)) != 0) {
1633 return ret;
1634 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001635
Paul Bakker0a597072012-09-25 21:55:46 +00001636 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001637
Gilles Peskine449bd832023-01-11 14:50:10 +01001638 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001639}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001640#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001641
Gilles Peskine449bd832023-01-11 14:50:10 +01001642void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1643 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001644{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001645 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001646}
1647
Ronald Cron6f135e12021-12-08 16:57:54 +01001648#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001649void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1650 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001651{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001652 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001653}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001654
1655#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001656void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1657 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001658{
1659 conf->early_data_enabled = early_data_enabled;
1660}
Jerry Yucc4e0072022-11-22 17:22:22 +08001661
1662#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001663void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001665{
Jerry Yu39da9852022-12-06 16:58:36 +08001666 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001667}
1668#endif /* MBEDTLS_SSL_SRV_C */
1669
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001670#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001671#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001673#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001674void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1675 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001676{
1677 conf->cert_profile = profile;
1678}
1679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001681{
1682 mbedtls_ssl_key_cert *cur = key_cert, *next;
1683
Gilles Peskine449bd832023-01-11 14:50:10 +01001684 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001685 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001686 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001687 cur = next;
1688 }
1689}
1690
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001691/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001692MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001693static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1694 mbedtls_x509_crt *cert,
1695 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001696{
niisato8ee24222018-06-25 19:05:48 +09001697 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001698
Gilles Peskine449bd832023-01-11 14:50:10 +01001699 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001700 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001701 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001702 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001704 }
1705
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1707 if (new_cert == NULL) {
1708 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1709 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001710
niisato8ee24222018-06-25 19:05:48 +09001711 new_cert->cert = cert;
1712 new_cert->key = key;
1713 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001714
Glenn Strauss36872db2022-01-22 05:06:31 -05001715 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001717 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001719 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001721 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 }
niisato8ee24222018-06-25 19:05:48 +09001723 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001724 }
1725
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001727}
1728
Gilles Peskine449bd832023-01-11 14:50:10 +01001729int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001730 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001731 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001732{
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001734}
1735
Gilles Peskine449bd832023-01-11 14:50:10 +01001736void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001737 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001739{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001740 conf->ca_chain = ca_chain;
1741 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001742
1743#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1744 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1745 * cannot be used together. */
1746 conf->f_ca_cb = NULL;
1747 conf->p_ca_cb = NULL;
1748#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001749}
Hanno Becker5adaad92019-03-27 16:54:37 +00001750
1751#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001752void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1753 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1754 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001755{
1756 conf->f_ca_cb = f_ca_cb;
1757 conf->p_ca_cb = p_ca_cb;
1758
1759 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1760 * cannot be used together. */
1761 conf->ca_chain = NULL;
1762 conf->ca_crl = NULL;
1763}
1764#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001766
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001767#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001768const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1769 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001770{
1771 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001773}
1774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1776 mbedtls_x509_crt *own_cert,
1777 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001778{
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1780 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001781}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001782
Gilles Peskine449bd832023-01-11 14:50:10 +01001783void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1784 mbedtls_x509_crt *ca_chain,
1785 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001786{
1787 ssl->handshake->sni_ca_chain = ca_chain;
1788 ssl->handshake->sni_ca_crl = ca_crl;
1789}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001790
Glenn Strauss999ef702022-03-11 01:37:23 -05001791#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001792void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1793 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001794{
1795 ssl->handshake->dn_hints = crt;
1796}
1797#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1798
Gilles Peskine449bd832023-01-11 14:50:10 +01001799void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1800 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001801{
1802 ssl->handshake->sni_authmode = authmode;
1803}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001804#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1805
Hanno Becker8927c832019-04-03 12:52:50 +01001806#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001807void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1808 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1809 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001810{
1811 ssl->f_vrfy = f_vrfy;
1812 ssl->p_vrfy = p_vrfy;
1813}
1814#endif
1815
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001816#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001817
Przemek Stekielfde11282023-03-13 16:06:09 +01001818static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1819static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1820
Valerio Setti016f6822022-12-09 14:17:50 +01001821static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 mbedtls_ssl_context *ssl,
1823 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001824{
1825 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001826 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001827 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001828 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001829 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001830 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1832 psa_pake_cs_set_primitive(&cipher_suite,
1833 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1834 PSA_ECC_FAMILY_SECP_R1,
1835 256));
1836 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001837
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1839 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001840 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001844 user = jpake_server_id;
1845 user_len = sizeof(jpake_server_id);
1846 peer = jpake_client_id;
1847 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001849 user = jpake_client_id;
1850 user_len = sizeof(jpake_client_id);
1851 peer = jpake_server_id;
1852 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001854
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001855 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1856 if (status != PSA_SUCCESS) {
1857 return status;
1858 }
1859
1860 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001862 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 }
Valerio Setti016f6822022-12-09 14:17:50 +01001864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1866 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001867 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 }
Valerio Setti016f6822022-12-09 14:17:50 +01001869
1870 ssl->handshake->psa_pake_ctx_is_ok = 1;
1871
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001873}
1874
Gilles Peskine449bd832023-01-11 14:50:10 +01001875int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1876 const unsigned char *pw,
1877 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001878{
1879 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1880 psa_status_t status;
1881
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 if (ssl->handshake == NULL || ssl->conf == NULL) {
1883 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001884 }
1885
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 /* Empty password is not valid */
1887 if ((pw == NULL) || (pw_len == 0)) {
1888 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1889 }
1890
1891 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1892 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1893 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1894
1895 status = psa_import_key(&attributes, pw, pw_len,
1896 &ssl->handshake->psa_pake_password);
1897 if (status != PSA_SUCCESS) {
1898 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1899 }
1900
1901 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1902 ssl->handshake->psa_pake_password);
1903 if (status != PSA_SUCCESS) {
1904 psa_destroy_key(ssl->handshake->psa_pake_password);
1905 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1906 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1907 }
1908
1909 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001910}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1913 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001914{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001915 psa_status_t status;
1916
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 if (ssl->handshake == NULL || ssl->conf == NULL) {
1918 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001919 }
1920
Gilles Peskine449bd832023-01-11 14:50:10 +01001921 if (mbedtls_svc_key_id_is_null(pwd)) {
1922 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1923 }
1924
1925 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1926 if (status != PSA_SUCCESS) {
1927 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1928 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1929 }
1930
1931 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001932}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001933#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001934
Ronald Cron73fe8df2022-10-05 14:31:43 +02001935#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001936int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001937{
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 if (conf->psk_identity == NULL ||
1939 conf->psk_identity_len == 0) {
1940 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001941 }
1942
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1944 return 1;
1945 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001946
Gilles Peskine449bd832023-01-11 14:50:10 +01001947 if (conf->psk != NULL && conf->psk_len != 0) {
1948 return 1;
1949 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001950
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001952}
1953
Gilles Peskine449bd832023-01-11 14:50:10 +01001954static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001955{
1956 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001958 /* The maintenance of the PSK key slot is the
1959 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001960 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001961 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001963 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001964 conf->psk = NULL;
1965 conf->psk_len = 0;
1966 }
1967
1968 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 if (conf->psk_identity != NULL) {
1970 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001971 conf->psk_identity = NULL;
1972 conf->psk_identity_len = 0;
1973 }
1974}
1975
Hanno Becker7390c712018-11-15 13:33:04 +00001976/* This function assumes that PSK identity in the SSL config is unset.
1977 * It checks that the provided identity is well-formed and attempts
1978 * to make a copy of it in the SSL config.
1979 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001980MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001981static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1982 unsigned char const *psk_identity,
1983 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001984{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001985 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001987 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 (psk_identity_len >> 16) != 0 ||
1989 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1990 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001991 }
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1994 if (conf->psk_identity == NULL) {
1995 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1996 }
Paul Bakker6db455e2013-09-18 17:29:31 +02001997
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001998 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002000
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002002}
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2005 const unsigned char *psk, size_t psk_len,
2006 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002007{
Janos Follath865b3eb2019-12-16 11:46:15 +00002008 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002009
2010 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2012 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2013 }
Hanno Becker7390c712018-11-15 13:33:04 +00002014
2015 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 if (psk == NULL) {
2017 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2018 }
2019 if (psk_len == 0) {
2020 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2021 }
2022 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2023 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2024 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002025
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2027 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2028 }
Hanno Becker7390c712018-11-15 13:33:04 +00002029 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002031
2032 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2034 if (ret != 0) {
2035 ssl_conf_remove_psk(conf);
2036 }
Hanno Becker7390c712018-11-15 13:33:04 +00002037
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002039}
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002042{
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002044 /* The maintenance of the external PSK key slot is the
2045 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 if (ssl->handshake->psk_opaque_is_internal) {
2047 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002048 ssl->handshake->psk_opaque_is_internal = 0;
2049 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002050 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002051 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002052}
2053
Gilles Peskine449bd832023-01-11 14:50:10 +01002054int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2055 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002056{
Neil Armstrong501c9322022-05-03 09:35:09 +02002057 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002058 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002059 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002060 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002061
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 if (psk == NULL || ssl->handshake == NULL) {
2063 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2064 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002065
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2067 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2068 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002071
Jerry Yuccc68a42022-07-26 16:39:20 +08002072#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2074 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2075 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2076 } else {
2077 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2078 }
2079 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002080 }
2081#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002082
Jerry Yu568ec252022-07-22 21:27:34 +08002083#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2085 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2086 psa_set_key_usage_flags(&key_attributes,
2087 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002088 }
2089#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2090
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 psa_set_key_algorithm(&key_attributes, alg);
2092 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002093
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2095 if (status != PSA_SUCCESS) {
2096 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2097 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002098
2099 /* Allow calling psa_destroy_key() on psk remove */
2100 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002102}
2103
Gilles Peskine449bd832023-01-11 14:50:10 +01002104int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2105 mbedtls_svc_key_id_t psk,
2106 const unsigned char *psk_identity,
2107 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002108{
Janos Follath865b3eb2019-12-16 11:46:15 +00002109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002110
2111 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2113 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2114 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002115
Hanno Becker7390c712018-11-15 13:33:04 +00002116 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 if (mbedtls_svc_key_id_is_null(psk)) {
2118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2119 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002120 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002121
2122 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2124 psk_identity_len);
2125 if (ret != 0) {
2126 ssl_conf_remove_psk(conf);
2127 }
Hanno Becker7390c712018-11-15 13:33:04 +00002128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002130}
2131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2133 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002134{
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 if ((mbedtls_svc_key_id_is_null(psk)) ||
2136 (ssl->handshake == NULL)) {
2137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2138 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002141 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002143}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002144
Jerry Yu8897c072022-08-12 13:56:53 +08002145#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002146void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2147 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2148 size_t),
2149 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002150{
2151 conf->f_psk = f_psk;
2152 conf->p_psk = p_psk;
2153}
Jerry Yu8897c072022-08-12 13:56:53 +08002154#endif /* MBEDTLS_SSL_SRV_C */
2155
Ronald Cron73fe8df2022-10-05 14:31:43 +02002156#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002157
Gilles Peskine301711e2022-04-26 16:57:05 +02002158static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002160{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002161#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (alg == PSA_ALG_CBC_NO_PADDING) {
2163 return MBEDTLS_SSL_MODE_CBC;
2164 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002165#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 if (PSA_ALG_IS_AEAD(alg)) {
2167 return MBEDTLS_SSL_MODE_AEAD;
2168 }
2169 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002170}
2171
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002172
Gilles Peskinee108d982022-04-26 16:50:40 +02002173static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2174 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002176{
2177#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2179 base_mode == MBEDTLS_SSL_MODE_CBC) {
2180 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002181 }
2182#else
2183 (void) encrypt_then_mac;
2184#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002186}
2187
Neil Armstrongab555e02022-04-04 11:07:59 +02002188mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002190{
Gilles Peskinee108d982022-04-26 16:50:40 +02002191 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002193 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002194
Gilles Peskinee108d982022-04-26 16:50:40 +02002195 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002196#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002197 encrypt_then_mac = transform->encrypt_then_mac;
2198#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002200}
2201
Neil Armstrongab555e02022-04-04 11:07:59 +02002202mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002203#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002205#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002207{
Gilles Peskinee108d982022-04-26 16:50:40 +02002208 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2209
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002210 psa_status_t status;
2211 psa_algorithm_t alg;
2212 psa_key_type_t type;
2213 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002214 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2215 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 if (status == PSA_SUCCESS) {
2217 base_mode = mbedtls_ssl_get_base_mode(alg);
2218 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002219
Gilles Peskinee108d982022-04-26 16:50:40 +02002220#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2221 int encrypt_then_mac = 0;
2222#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002224}
2225
Jerry Yu251a12e2022-07-13 15:15:48 +08002226
Ronald Cron8b592d22024-11-12 18:08:25 +01002227const mbedtls_error_pair_t psa_to_ssl_errors[] =
2228{
2229 { PSA_SUCCESS, 0 },
2230 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2231 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2232 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2233 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2234 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2235 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2236};
2237
Gilles Peskine449bd832023-01-11 14:50:10 +01002238psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2239 size_t taglen,
2240 psa_algorithm_t *alg,
2241 psa_key_type_t *key_type,
2242 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002243{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002244#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002245 (void) taglen;
2246#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002248#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002249 case MBEDTLS_CIPHER_AES_128_CBC:
2250 *alg = PSA_ALG_CBC_NO_PADDING;
2251 *key_type = PSA_KEY_TYPE_AES;
2252 *key_size = 128;
2253 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002254#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002255#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002256 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002258 *key_type = PSA_KEY_TYPE_AES;
2259 *key_size = 128;
2260 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002261#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002262#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002263 case MBEDTLS_CIPHER_AES_128_GCM:
2264 *alg = PSA_ALG_GCM;
2265 *key_type = PSA_KEY_TYPE_AES;
2266 *key_size = 128;
2267 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002268#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002269#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002270 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002272 *key_type = PSA_KEY_TYPE_AES;
2273 *key_size = 192;
2274 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002275#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002276#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002277 case MBEDTLS_CIPHER_AES_192_GCM:
2278 *alg = PSA_ALG_GCM;
2279 *key_type = PSA_KEY_TYPE_AES;
2280 *key_size = 192;
2281 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002282#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002283#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002284 case MBEDTLS_CIPHER_AES_256_CBC:
2285 *alg = PSA_ALG_CBC_NO_PADDING;
2286 *key_type = PSA_KEY_TYPE_AES;
2287 *key_size = 256;
2288 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002289#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002290#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002291 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002293 *key_type = PSA_KEY_TYPE_AES;
2294 *key_size = 256;
2295 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002296#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002297#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002298 case MBEDTLS_CIPHER_AES_256_GCM:
2299 *alg = PSA_ALG_GCM;
2300 *key_type = PSA_KEY_TYPE_AES;
2301 *key_size = 256;
2302 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002303#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002304#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002305 case MBEDTLS_CIPHER_ARIA_128_CBC:
2306 *alg = PSA_ALG_CBC_NO_PADDING;
2307 *key_type = PSA_KEY_TYPE_ARIA;
2308 *key_size = 128;
2309 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002310#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002311#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002312 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002314 *key_type = PSA_KEY_TYPE_ARIA;
2315 *key_size = 128;
2316 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002317#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002318#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002319 case MBEDTLS_CIPHER_ARIA_128_GCM:
2320 *alg = PSA_ALG_GCM;
2321 *key_type = PSA_KEY_TYPE_ARIA;
2322 *key_size = 128;
2323 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002324#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002325#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002326 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002328 *key_type = PSA_KEY_TYPE_ARIA;
2329 *key_size = 192;
2330 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002331#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002332#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002333 case MBEDTLS_CIPHER_ARIA_192_GCM:
2334 *alg = PSA_ALG_GCM;
2335 *key_type = PSA_KEY_TYPE_ARIA;
2336 *key_size = 192;
2337 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002338#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002339#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002340 case MBEDTLS_CIPHER_ARIA_256_CBC:
2341 *alg = PSA_ALG_CBC_NO_PADDING;
2342 *key_type = PSA_KEY_TYPE_ARIA;
2343 *key_size = 256;
2344 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002345#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002346#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002347 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002349 *key_type = PSA_KEY_TYPE_ARIA;
2350 *key_size = 256;
2351 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002352#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002353#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002354 case MBEDTLS_CIPHER_ARIA_256_GCM:
2355 *alg = PSA_ALG_GCM;
2356 *key_type = PSA_KEY_TYPE_ARIA;
2357 *key_size = 256;
2358 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002359#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002360#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002361 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2362 *alg = PSA_ALG_CBC_NO_PADDING;
2363 *key_type = PSA_KEY_TYPE_CAMELLIA;
2364 *key_size = 128;
2365 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002366#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002367#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002368 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002370 *key_type = PSA_KEY_TYPE_CAMELLIA;
2371 *key_size = 128;
2372 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002373#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002374#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002375 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2376 *alg = PSA_ALG_GCM;
2377 *key_type = PSA_KEY_TYPE_CAMELLIA;
2378 *key_size = 128;
2379 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002380#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002381#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002382 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002384 *key_type = PSA_KEY_TYPE_CAMELLIA;
2385 *key_size = 192;
2386 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002387#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002388#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002389 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2390 *alg = PSA_ALG_GCM;
2391 *key_type = PSA_KEY_TYPE_CAMELLIA;
2392 *key_size = 192;
2393 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002394#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002395#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002396 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2397 *alg = PSA_ALG_CBC_NO_PADDING;
2398 *key_type = PSA_KEY_TYPE_CAMELLIA;
2399 *key_size = 256;
2400 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002401#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002402#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002403 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002405 *key_type = PSA_KEY_TYPE_CAMELLIA;
2406 *key_size = 256;
2407 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002408#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002409#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002410 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2411 *alg = PSA_ALG_GCM;
2412 *key_type = PSA_KEY_TYPE_CAMELLIA;
2413 *key_size = 256;
2414 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002415#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002416#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002417 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2418 *alg = PSA_ALG_CHACHA20_POLY1305;
2419 *key_type = PSA_KEY_TYPE_CHACHA20;
2420 *key_size = 256;
2421 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002422#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002423 case MBEDTLS_CIPHER_NULL:
2424 *alg = MBEDTLS_SSL_NULL_CIPHER;
2425 *key_type = 0;
2426 *key_size = 0;
2427 break;
2428 default:
2429 return PSA_ERROR_NOT_SUPPORTED;
2430 }
2431
2432 return PSA_SUCCESS;
2433}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002434
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002435#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002436int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2437 const unsigned char *dhm_P, size_t P_len,
2438 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002439{
Janos Follath865b3eb2019-12-16 11:46:15 +00002440 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002441
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 mbedtls_mpi_free(&conf->dhm_P);
2443 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002444
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2446 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2447 mbedtls_mpi_free(&conf->dhm_P);
2448 mbedtls_mpi_free(&conf->dhm_G);
2449 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002450 }
2451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002453}
Paul Bakker5121ce52009-01-03 21:22:43 +00002454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002456{
Janos Follath865b3eb2019-12-16 11:46:15 +00002457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002458
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 mbedtls_mpi_free(&conf->dhm_P);
2460 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002461
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2463 &conf->dhm_P)) != 0 ||
2464 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2465 &conf->dhm_G)) != 0) {
2466 mbedtls_mpi_free(&conf->dhm_P);
2467 mbedtls_mpi_free(&conf->dhm_G);
2468 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002469 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002470
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002472}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002473#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002474
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002475#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2476/*
2477 * Set the minimum length for Diffie-Hellman parameters
2478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002479void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2480 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002481{
2482 conf->dhm_min_bitlen = bitlen;
2483}
2484#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2485
Ronald Crone68ab4f2022-10-05 12:46:29 +02002486#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002487#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002488/*
2489 * Set allowed/preferred hashes for handshake signatures
2490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002491void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2492 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002493{
2494 conf->sig_hashes = hashes;
2495}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002496#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002497
Jerry Yuf017ee42022-01-12 15:49:48 +08002498/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002499void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2500 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002501{
Jerry Yuf017ee42022-01-12 15:49:48 +08002502#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2503 conf->sig_hashes = NULL;
2504#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2505 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002506}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002507#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002508
Brett Warrene0edc842021-08-17 09:53:13 +01002509/*
2510 * Set the allowed groups
2511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002512void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2513 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002514{
Brett Warrene0edc842021-08-17 09:53:13 +01002515 conf->group_list = group_list;
2516}
2517
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002518#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01002519
2520#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2521/** Whether mbedtls_ssl_set_hostname() has been called.
2522 *
2523 * \param[in] ssl SSL context
2524 *
2525 * \return \c 1 if mbedtls_ssl_set_hostname() has been called on \p ssl
2526 * (including `mbedtls_ssl_set_hostname(ssl, NULL)`),
2527 * otherwise \c 0.
2528 */
2529static int mbedtls_ssl_has_set_hostname_been_called(
2530 const mbedtls_ssl_context *ssl)
2531{
2532 /* We can't tell the difference between the case where
2533 * mbedtls_ssl_set_hostname() has not been called at all, and
2534 * the case where it was last called with NULL. For the time
2535 * being, we assume the latter, i.e. we behave as if there had
2536 * been an implicit call to mbedtls_ssl_set_hostname(ssl, NULL). */
2537 return ssl->hostname != NULL;
2538}
2539#endif
2540
2541static void mbedtls_ssl_free_hostname(mbedtls_ssl_context *ssl)
2542{
2543 if (ssl->hostname != NULL) {
2544 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
2545 }
2546 ssl->hostname = NULL;
2547}
2548
Gilles Peskine449bd832023-01-11 14:50:10 +01002549int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002550{
Hanno Becker947194e2017-04-07 13:25:49 +01002551 /* Initialize to suppress unnecessary compiler warning */
2552 size_t hostname_len = 0;
2553
2554 /* Check if new hostname is valid before
2555 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 if (hostname != NULL) {
2557 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002558
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2560 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2561 }
Hanno Becker947194e2017-04-07 13:25:49 +01002562 }
2563
2564 /* Now it's clear that we will overwrite the old hostname,
2565 * so we can free it safely */
Gilles Peskine4ac40082025-02-20 18:13:58 +01002566 mbedtls_ssl_free_hostname(ssl);
Hanno Becker947194e2017-04-07 13:25:49 +01002567
2568 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002571 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 } else {
2573 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2574 if (ssl->hostname == NULL) {
2575 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2576 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002577
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002579
Hanno Becker947194e2017-04-07 13:25:49 +01002580 ssl->hostname[hostname_len] = '\0';
2581 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002582
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002584}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002585#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002586
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002587#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002588void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2589 int (*f_sni)(void *, mbedtls_ssl_context *,
2590 const unsigned char *, size_t),
2591 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002592{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002593 conf->f_sni = f_sni;
2594 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002595}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002599int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002600{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002601 size_t cur_len, tot_len;
2602 const char **p;
2603
2604 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002605 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2606 * MUST NOT be truncated."
2607 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002608 */
2609 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 for (p = protos; *p != NULL; p++) {
2611 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002612 tot_len += cur_len;
2613
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 if ((cur_len == 0) ||
2615 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2616 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2618 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002619 }
2620
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002621 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002622
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002624}
2625
Gilles Peskine449bd832023-01-11 14:50:10 +01002626const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002627{
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002629}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002630#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002631
Johan Pascalb62bb512015-12-03 21:56:45 +01002632#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002633void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2634 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002635{
2636 conf->dtls_srtp_mki_support = support_mki_value;
2637}
2638
Gilles Peskine449bd832023-01-11 14:50:10 +01002639int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2640 unsigned char *mki_value,
2641 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002642{
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2644 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002645 }
Ron Eldor591f1622018-01-22 12:30:04 +02002646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2648 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002649 }
Ron Eldor591f1622018-01-22 12:30:04 +02002650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002652 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002654}
2655
Gilles Peskine449bd832023-01-11 14:50:10 +01002656int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2657 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002658{
Johan Pascal253d0262020-09-22 13:04:45 +02002659 const mbedtls_ssl_srtp_profile *p;
2660 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002661
Johan Pascal253d0262020-09-22 13:04:45 +02002662 /* check the profiles list: all entry must be valid,
2663 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2665 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2666 p++) {
2667 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002668 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002670 /* unsupported value, stop parsing and set the size to an error value */
2671 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002672 }
2673 }
2674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2676 conf->dtls_srtp_profile_list = NULL;
2677 conf->dtls_srtp_profile_list_len = 0;
2678 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002679 }
2680
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002681 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002682 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002685}
2686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2688 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002689{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002690 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2691 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002693 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002695 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2697 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002698 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002699}
Johan Pascalb62bb512015-12-03 21:56:45 +01002700#endif /* MBEDTLS_SSL_DTLS_SRTP */
2701
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302702#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002703void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002704{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002705 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002706}
2707
Gilles Peskine449bd832023-01-11 14:50:10 +01002708void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002709{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002710 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002711}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302712#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002713
Janos Follath088ce432017-04-10 12:42:31 +01002714#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002715void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2716 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002717{
2718 conf->cert_req_ca_list = cert_req_ca_list;
2719}
2720#endif
2721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002722#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002723void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002724{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002725 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002726}
2727#endif
2728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002730void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002731{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002732 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002733}
2734#endif
2735
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002736#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002737int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002738{
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2740 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2741 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002742 }
2743
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002744 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002745
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002747}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002748#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002749
Gilles Peskine449bd832023-01-11 14:50:10 +01002750void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002751{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002752 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002753}
2754
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002755#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002756void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002757{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002758 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002759}
2760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002762{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002763 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002764}
2765
Gilles Peskine449bd832023-01-11 14:50:10 +01002766void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2767 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002768{
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002770}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002771#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002772
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002774#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002775void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002776{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002777 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002778}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002779#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002780
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002781#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002782
Jerry Yud0766ec2022-09-22 10:46:57 +08002783#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002784void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2785 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002786{
Jerry Yud0766ec2022-09-22 10:46:57 +08002787 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002788}
2789#endif
2790
Gilles Peskine449bd832023-01-11 14:50:10 +01002791void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2792 mbedtls_ssl_ticket_write_t *f_ticket_write,
2793 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2794 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002795{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002796 conf->f_ticket_write = f_ticket_write;
2797 conf->f_ticket_parse = f_ticket_parse;
2798 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002799}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002800#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002802
Gilles Peskine449bd832023-01-11 14:50:10 +01002803void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2804 mbedtls_ssl_export_keys_t *f_export_keys,
2805 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002806{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002807 ssl->f_export_keys = f_export_keys;
2808 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002809}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002810
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002811#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002812void mbedtls_ssl_conf_async_private_cb(
2813 mbedtls_ssl_config *conf,
2814 mbedtls_ssl_async_sign_t *f_async_sign,
2815 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2816 mbedtls_ssl_async_resume_t *f_async_resume,
2817 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002819{
2820 conf->f_async_sign_start = f_async_sign;
2821 conf->f_async_decrypt_start = f_async_decrypt;
2822 conf->f_async_resume = f_async_resume;
2823 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002824 conf->p_async_config_data = async_config_data;
2825}
2826
Gilles Peskine449bd832023-01-11 14:50:10 +01002827void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002828{
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002830}
2831
Gilles Peskine449bd832023-01-11 14:50:10 +01002832void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002833{
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 if (ssl->handshake == NULL) {
2835 return NULL;
2836 } else {
2837 return ssl->handshake->user_async_ctx;
2838 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002839}
2840
Gilles Peskine449bd832023-01-11 14:50:10 +01002841void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2842 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002843{
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002845 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002847}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002848#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002849
Paul Bakker5121ce52009-01-03 21:22:43 +00002850/*
2851 * SSL get accessors
2852 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002853uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002854{
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 if (ssl->session != NULL) {
2856 return ssl->session->verify_result;
2857 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002858
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 if (ssl->session_negotiate != NULL) {
2860 return ssl->session_negotiate->verify_result;
2861 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002864}
2865
Gilles Peskine449bd832023-01-11 14:50:10 +01002866int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002867{
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 if (ssl == NULL || ssl->session == NULL) {
2869 return 0;
2870 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002873}
2874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002876{
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 if (ssl == NULL || ssl->session == NULL) {
2878 return NULL;
2879 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002882}
2883
Gilles Peskine449bd832023-01-11 14:50:10 +01002884const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002885{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2888 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002889 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002891 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002893 }
2894 }
2895#endif
2896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002898 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002900 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002902 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002904 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002905}
2906
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002907#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2908
2909size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2910{
2911 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2912 size_t record_size_limit = max_len;
2913
2914 if (ssl->session != NULL &&
2915 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2916 ssl->session->record_size_limit < max_len) {
2917 record_size_limit = ssl->session->record_size_limit;
2918 }
2919
2920 // TODO: this is currently untested
2921 /* During a handshake, use the value being negotiated */
2922 if (ssl->session_negotiate != NULL &&
2923 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2924 ssl->session_negotiate->record_size_limit < max_len) {
2925 record_size_limit = ssl->session_negotiate->record_size_limit;
2926 }
2927
2928 return record_size_limit;
2929}
2930#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2931
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002932#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002933size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002934{
David Horstmann95d516f2021-05-04 18:36:56 +01002935 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002936 size_t read_mfl;
2937
Jerry Yuddda0502022-12-01 19:43:12 +08002938#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002939 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2941 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2942 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002943 }
Jerry Yuddda0502022-12-01 19:43:12 +08002944#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002945
2946 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 if (ssl->session_out != NULL) {
2948 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2949 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002950 max_len = read_mfl;
2951 }
2952 }
2953
Jerry Yuddda0502022-12-01 19:43:12 +08002954 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002955 if (ssl->session_negotiate != NULL) {
2956 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2957 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002958 max_len = read_mfl;
2959 }
2960 }
2961
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002963}
2964
Gilles Peskine449bd832023-01-11 14:50:10 +01002965size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002966{
2967 size_t max_len;
2968
2969 /*
2970 * Assume mfl_code is correct since it was checked when set
2971 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002973
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002974 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 if (ssl->session_out != NULL &&
2976 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2977 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002978 }
2979
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002980 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 if (ssl->session_negotiate != NULL &&
2982 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2983 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002984 }
2985
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002987}
2988#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2989
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002990#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002991size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002992{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002993 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2995 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2996 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2997 return 0;
2998 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002999
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3001 return ssl->mtu;
3002 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003003
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 if (ssl->mtu == 0) {
3005 return ssl->handshake->mtu;
3006 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 return ssl->mtu < ssl->handshake->mtu ?
3009 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003010}
3011#endif /* MBEDTLS_SSL_PROTO_DTLS */
3012
Gilles Peskine449bd832023-01-11 14:50:10 +01003013int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003014{
3015 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3016
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003017#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003018 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003019 !defined(MBEDTLS_SSL_PROTO_DTLS)
3020 (void) ssl;
3021#endif
3022
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003023#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003025
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003027 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003029#endif
3030
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003031#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3032 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3033
3034 if (max_len > record_size_limit) {
3035 max_len = record_size_limit;
3036 }
3037#endif
3038
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003039 if (ssl->transform_out != NULL &&
3040 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003041 /*
3042 * In TLS 1.3 case, when records are protected, `max_len` as computed
3043 * above is the maximum length of the TLSInnerPlaintext structure that
3044 * along the plaintext payload contains the inner content type (one byte)
3045 * and some zero padding. Given the algorithm used for padding
3046 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3047 * the plaintext payload. Round down to a multiple of
3048 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3049 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003050 */
3051 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3052 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3053 }
3054
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003055#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3057 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3058 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003059 const size_t overhead = (size_t) ret;
3060
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 if (ret < 0) {
3062 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003063 }
3064
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 if (mtu <= overhead) {
3066 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3067 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3068 }
3069
3070 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003071 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003073 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003074#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003075
Hanno Becker0defedb2018-08-10 12:35:02 +01003076#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003077 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3078 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003079 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003080#endif
3081
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003083}
3084
Gilles Peskine449bd832023-01-11 14:50:10 +01003085int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003086{
3087 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3088
3089#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3090 (void) ssl;
3091#endif
3092
3093#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003097 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003099#endif
3100
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003102}
3103
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003105const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003106{
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 if (ssl == NULL || ssl->session == NULL) {
3108 return NULL;
3109 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003110
Hanno Beckere6824572019-02-07 13:18:46 +00003111#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003113#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003115#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003116}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003117#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003118
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003119#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003120int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3121 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003122{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003123 int ret;
3124
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003126 dst == NULL ||
3127 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3129 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003130 }
3131
Hanno Beckere810bbc2021-05-14 16:01:05 +01003132 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3133 * idempotent: Each session can only be exported once.
3134 *
3135 * (This is in preparation for TLS 1.3 support where we will
3136 * need the ability to export multiple sessions (aka tickets),
3137 * which will be achieved by calling mbedtls_ssl_get_session()
3138 * multiple times until it fails.)
3139 *
3140 * Check whether we have already exported the current session,
3141 * and fail if so.
3142 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003143 if (ssl->session->exported == 1) {
3144 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3145 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003146
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3148 if (ret != 0) {
3149 return ret;
3150 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003151
3152 /* Remember that we've exported the session. */
3153 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003155}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003156#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003157
David Horstmanncb01b362024-02-29 17:31:46 +00003158#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3159
3160/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003161 *
David Horstmanncb01b362024-02-29 17:31:46 +00003162 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003163 */
3164static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3165 unsigned char *buf,
3166 size_t buf_len)
3167{
3168 unsigned char *p = buf;
3169 size_t used = 0;
3170
3171#if defined(MBEDTLS_HAVE_TIME)
3172 uint64_t start;
3173#endif
3174#if defined(MBEDTLS_X509_CRT_PARSE_C)
3175#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3176 size_t cert_len;
3177#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3178#endif /* MBEDTLS_X509_CRT_PARSE_C */
3179
3180 /*
3181 * Time
3182 */
3183#if defined(MBEDTLS_HAVE_TIME)
3184 used += 8;
3185
3186 if (used <= buf_len) {
3187 start = (uint64_t) session->start;
3188
3189 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3190 p += 8;
3191 }
3192#endif /* MBEDTLS_HAVE_TIME */
3193
3194 /*
3195 * Basic mandatory fields
3196 */
3197 used += 1 /* id_len */
3198 + sizeof(session->id)
3199 + sizeof(session->master)
3200 + 4; /* verify_result */
3201
3202 if (used <= buf_len) {
3203 *p++ = MBEDTLS_BYTE_0(session->id_len);
3204 memcpy(p, session->id, 32);
3205 p += 32;
3206
3207 memcpy(p, session->master, 48);
3208 p += 48;
3209
3210 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3211 p += 4;
3212 }
3213
3214 /*
3215 * Peer's end-entity certificate
3216 */
3217#if defined(MBEDTLS_X509_CRT_PARSE_C)
3218#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3219 if (session->peer_cert == NULL) {
3220 cert_len = 0;
3221 } else {
3222 cert_len = session->peer_cert->raw.len;
3223 }
3224
3225 used += 3 + cert_len;
3226
3227 if (used <= buf_len) {
3228 *p++ = MBEDTLS_BYTE_2(cert_len);
3229 *p++ = MBEDTLS_BYTE_1(cert_len);
3230 *p++ = MBEDTLS_BYTE_0(cert_len);
3231
3232 if (session->peer_cert != NULL) {
3233 memcpy(p, session->peer_cert->raw.p, cert_len);
3234 p += cert_len;
3235 }
3236 }
3237#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3238 if (session->peer_cert_digest != NULL) {
3239 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3240 if (used <= buf_len) {
3241 *p++ = (unsigned char) session->peer_cert_digest_type;
3242 *p++ = (unsigned char) session->peer_cert_digest_len;
3243 memcpy(p, session->peer_cert_digest,
3244 session->peer_cert_digest_len);
3245 p += session->peer_cert_digest_len;
3246 }
3247 } else {
3248 used += 2;
3249 if (used <= buf_len) {
3250 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3251 *p++ = 0;
3252 }
3253 }
3254#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3255#endif /* MBEDTLS_X509_CRT_PARSE_C */
3256
3257 /*
3258 * Session ticket if any, plus associated data
3259 */
3260#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3261#if defined(MBEDTLS_SSL_CLI_C)
3262 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3263 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3264
3265 if (used <= buf_len) {
3266 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3267 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3268 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3269
3270 if (session->ticket != NULL) {
3271 memcpy(p, session->ticket, session->ticket_len);
3272 p += session->ticket_len;
3273 }
3274
3275 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3276 p += 4;
3277 }
3278 }
3279#endif /* MBEDTLS_SSL_CLI_C */
3280#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3281 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3282 used += 8;
3283
3284 if (used <= buf_len) {
3285 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3286 p += 8;
3287 }
3288 }
3289#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3290#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3291
3292 /*
3293 * Misc extension-related info
3294 */
3295#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3296 used += 1;
3297
3298 if (used <= buf_len) {
3299 *p++ = session->mfl_code;
3300 }
3301#endif
3302
3303#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3304 used += 1;
3305
3306 if (used <= buf_len) {
3307 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3308 }
3309#endif
3310
3311 return used;
3312}
3313
3314MBEDTLS_CHECK_RETURN_CRITICAL
3315static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3316 const unsigned char *buf,
3317 size_t len)
3318{
3319#if defined(MBEDTLS_HAVE_TIME)
3320 uint64_t start;
3321#endif
3322#if defined(MBEDTLS_X509_CRT_PARSE_C)
3323#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3324 size_t cert_len;
3325#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3326#endif /* MBEDTLS_X509_CRT_PARSE_C */
3327
3328 const unsigned char *p = buf;
3329 const unsigned char * const end = buf + len;
3330
3331 /*
3332 * Time
3333 */
3334#if defined(MBEDTLS_HAVE_TIME)
3335 if (8 > (size_t) (end - p)) {
3336 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3337 }
3338
3339 start = MBEDTLS_GET_UINT64_BE(p, 0);
3340 p += 8;
3341
3342 session->start = (time_t) start;
3343#endif /* MBEDTLS_HAVE_TIME */
3344
3345 /*
3346 * Basic mandatory fields
3347 */
3348 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3349 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3350 }
3351
3352 session->id_len = *p++;
3353 memcpy(session->id, p, 32);
3354 p += 32;
3355
3356 memcpy(session->master, p, 48);
3357 p += 48;
3358
3359 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3360 p += 4;
3361
3362 /* Immediately clear invalid pointer values that have been read, in case
3363 * we exit early before we replaced them with valid ones. */
3364#if defined(MBEDTLS_X509_CRT_PARSE_C)
3365#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3366 session->peer_cert = NULL;
3367#else
3368 session->peer_cert_digest = NULL;
3369#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3370#endif /* MBEDTLS_X509_CRT_PARSE_C */
3371#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3372 session->ticket = NULL;
3373#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3374
3375 /*
3376 * Peer certificate
3377 */
3378#if defined(MBEDTLS_X509_CRT_PARSE_C)
3379#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3380 /* Deserialize CRT from the end of the ticket. */
3381 if (3 > (size_t) (end - p)) {
3382 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3383 }
3384
3385 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3386 p += 3;
3387
3388 if (cert_len != 0) {
3389 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3390
3391 if (cert_len > (size_t) (end - p)) {
3392 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3393 }
3394
3395 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3396
3397 if (session->peer_cert == NULL) {
3398 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3399 }
3400
3401 mbedtls_x509_crt_init(session->peer_cert);
3402
3403 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3404 p, cert_len)) != 0) {
3405 mbedtls_x509_crt_free(session->peer_cert);
3406 mbedtls_free(session->peer_cert);
3407 session->peer_cert = NULL;
3408 return ret;
3409 }
3410
3411 p += cert_len;
3412 }
3413#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3414 /* Deserialize CRT digest from the end of the ticket. */
3415 if (2 > (size_t) (end - p)) {
3416 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3417 }
3418
3419 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3420 session->peer_cert_digest_len = (size_t) *p++;
3421
3422 if (session->peer_cert_digest_len != 0) {
3423 const mbedtls_md_info_t *md_info =
3424 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3425 if (md_info == NULL) {
3426 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3427 }
3428 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3429 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3430 }
3431
3432 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3433 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3434 }
3435
3436 session->peer_cert_digest =
3437 mbedtls_calloc(1, session->peer_cert_digest_len);
3438 if (session->peer_cert_digest == NULL) {
3439 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3440 }
3441
3442 memcpy(session->peer_cert_digest, p,
3443 session->peer_cert_digest_len);
3444 p += session->peer_cert_digest_len;
3445 }
3446#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3447#endif /* MBEDTLS_X509_CRT_PARSE_C */
3448
3449 /*
3450 * Session ticket and associated data
3451 */
3452#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3453#if defined(MBEDTLS_SSL_CLI_C)
3454 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3455 if (3 > (size_t) (end - p)) {
3456 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3457 }
3458
3459 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3460 p += 3;
3461
3462 if (session->ticket_len != 0) {
3463 if (session->ticket_len > (size_t) (end - p)) {
3464 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3465 }
3466
3467 session->ticket = mbedtls_calloc(1, session->ticket_len);
3468 if (session->ticket == NULL) {
3469 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3470 }
3471
3472 memcpy(session->ticket, p, session->ticket_len);
3473 p += session->ticket_len;
3474 }
3475
3476 if (4 > (size_t) (end - p)) {
3477 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3478 }
3479
3480 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3481 p += 4;
3482 }
3483#endif /* MBEDTLS_SSL_CLI_C */
3484#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3485 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3486 if (8 > (size_t) (end - p)) {
3487 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3488 }
3489 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3490 p += 8;
3491 }
3492#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3493#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3494
3495 /*
3496 * Misc extension-related info
3497 */
3498#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3499 if (1 > (size_t) (end - p)) {
3500 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3501 }
3502
3503 session->mfl_code = *p++;
3504#endif
3505
3506#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3507 if (1 > (size_t) (end - p)) {
3508 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3509 }
3510
3511 session->encrypt_then_mac = *p++;
3512#endif
3513
3514 /* Done, should have consumed entire buffer */
3515 if (p != end) {
3516 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3517 }
3518
3519 return 0;
3520}
3521
3522#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3523
3524#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3525/* Serialization of TLS 1.3 sessions:
3526 *
David Horstmanncb01b362024-02-29 17:31:46 +00003527 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003528 */
3529#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3530MBEDTLS_CHECK_RETURN_CRITICAL
3531static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3532 unsigned char *buf,
3533 size_t buf_len,
3534 size_t *olen)
3535{
3536 unsigned char *p = buf;
3537#if defined(MBEDTLS_SSL_CLI_C) && \
3538 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3539 size_t hostname_len = (session->hostname == NULL) ?
3540 0 : strlen(session->hostname) + 1;
3541#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003542
3543#if defined(MBEDTLS_SSL_SRV_C) && \
3544 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003545 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003546 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003547#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003548 size_t needed = 4 /* ticket_age_add */
3549 + 1 /* ticket_flags */
3550 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003551
David Horstmanne59f9702024-02-29 16:08:57 +00003552 *olen = 0;
3553
3554 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3555 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3556 }
3557 needed += session->resumption_key_len; /* resumption_key */
3558
3559#if defined(MBEDTLS_SSL_EARLY_DATA)
3560 needed += 4; /* max_early_data_size */
3561#endif
3562#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3563 needed += 2; /* record_size_limit */
3564#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3565
3566#if defined(MBEDTLS_HAVE_TIME)
3567 needed += 8; /* ticket_creation_time or ticket_reception_time */
3568#endif
3569
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003570#if defined(MBEDTLS_SSL_SRV_C)
3571 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3572#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003573 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003574 + alpn_len; /* alpn */
3575#endif
3576 }
3577#endif /* MBEDTLS_SSL_SRV_C */
3578
David Horstmanne59f9702024-02-29 16:08:57 +00003579#if defined(MBEDTLS_SSL_CLI_C)
3580 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3581#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3582 needed += 2 /* hostname_len */
3583 + hostname_len; /* hostname */
3584#endif
3585
3586 needed += 4 /* ticket_lifetime */
3587 + 2; /* ticket_len */
3588
3589 /* Check size_t overflow */
3590 if (session->ticket_len > SIZE_MAX - needed) {
3591 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3592 }
3593
3594 needed += session->ticket_len; /* ticket */
3595 }
3596#endif /* MBEDTLS_SSL_CLI_C */
3597
3598 *olen = needed;
3599 if (needed > buf_len) {
3600 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3601 }
3602
3603 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3604 p[4] = session->ticket_flags;
3605
3606 /* save resumption_key */
3607 p[5] = session->resumption_key_len;
3608 p += 6;
3609 memcpy(p, session->resumption_key, session->resumption_key_len);
3610 p += session->resumption_key_len;
3611
3612#if defined(MBEDTLS_SSL_EARLY_DATA)
3613 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3614 p += 4;
3615#endif
3616#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3617 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3618 p += 2;
3619#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3620
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003621#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003622 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003623#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003624 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3625 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003626#endif /* MBEDTLS_HAVE_TIME */
3627
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003628#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003629 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3630 p += 2;
3631
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003632 if (alpn_len > 0) {
3633 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003634 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003635 p += alpn_len;
3636 }
3637#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3638 }
3639#endif /* MBEDTLS_SSL_SRV_C */
3640
David Horstmanne59f9702024-02-29 16:08:57 +00003641#if defined(MBEDTLS_SSL_CLI_C)
3642 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3643#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3644 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3645 p += 2;
3646 if (hostname_len > 0) {
3647 /* save host name */
3648 memcpy(p, session->hostname, hostname_len);
3649 p += hostname_len;
3650 }
3651#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3652
3653#if defined(MBEDTLS_HAVE_TIME)
3654 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3655 p += 8;
3656#endif
3657 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3658 p += 4;
3659
3660 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3661 p += 2;
3662
3663 if (session->ticket != NULL && session->ticket_len > 0) {
3664 memcpy(p, session->ticket, session->ticket_len);
3665 p += session->ticket_len;
3666 }
3667 }
3668#endif /* MBEDTLS_SSL_CLI_C */
3669 return 0;
3670}
3671
3672MBEDTLS_CHECK_RETURN_CRITICAL
3673static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3674 const unsigned char *buf,
3675 size_t len)
3676{
3677 const unsigned char *p = buf;
3678 const unsigned char *end = buf + len;
3679
3680 if (end - p < 6) {
3681 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3682 }
3683 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3684 session->ticket_flags = p[4];
3685
3686 /* load resumption_key */
3687 session->resumption_key_len = p[5];
3688 p += 6;
3689
3690 if (end - p < session->resumption_key_len) {
3691 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3692 }
3693
3694 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3695 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3696 }
3697 memcpy(session->resumption_key, p, session->resumption_key_len);
3698 p += session->resumption_key_len;
3699
3700#if defined(MBEDTLS_SSL_EARLY_DATA)
3701 if (end - p < 4) {
3702 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3703 }
3704 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3705 p += 4;
3706#endif
3707#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3708 if (end - p < 2) {
3709 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3710 }
3711 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3712 p += 2;
3713#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3714
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003715#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003716 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003717#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003718 if (end - p < 8) {
3719 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3720 }
3721 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3722 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003723#endif /* MBEDTLS_HAVE_TIME */
3724
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003725#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003726 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003727
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003728 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003729 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3730 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003731
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003732 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3733 p += 2;
3734
3735 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003736 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3737 }
3738
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003739 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003740 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3741 if (ret != 0) {
3742 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003743 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003744 p += alpn_len;
3745 }
3746#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3747 }
3748#endif /* MBEDTLS_SSL_SRV_C */
3749
David Horstmanne59f9702024-02-29 16:08:57 +00003750#if defined(MBEDTLS_SSL_CLI_C)
3751 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3752#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3753 size_t hostname_len;
3754 /* load host name */
3755 if (end - p < 2) {
3756 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3757 }
3758 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3759 p += 2;
3760
3761 if (end - p < (long int) hostname_len) {
3762 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3763 }
3764 if (hostname_len > 0) {
3765 session->hostname = mbedtls_calloc(1, hostname_len);
3766 if (session->hostname == NULL) {
3767 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3768 }
3769 memcpy(session->hostname, p, hostname_len);
3770 p += hostname_len;
3771 }
3772#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3773
3774#if defined(MBEDTLS_HAVE_TIME)
3775 if (end - p < 8) {
3776 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3777 }
3778 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3779 p += 8;
3780#endif
3781 if (end - p < 4) {
3782 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3783 }
3784 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3785 p += 4;
3786
3787 if (end - p < 2) {
3788 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3789 }
3790 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3791 p += 2;
3792
3793 if (end - p < (long int) session->ticket_len) {
3794 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3795 }
3796 if (session->ticket_len > 0) {
3797 session->ticket = mbedtls_calloc(1, session->ticket_len);
3798 if (session->ticket == NULL) {
3799 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3800 }
3801 memcpy(session->ticket, p, session->ticket_len);
3802 p += session->ticket_len;
3803 }
3804 }
3805#endif /* MBEDTLS_SSL_CLI_C */
3806
3807 return 0;
3808
3809}
3810#else /* MBEDTLS_SSL_SESSION_TICKETS */
3811MBEDTLS_CHECK_RETURN_CRITICAL
3812static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3813 unsigned char *buf,
3814 size_t buf_len,
3815 size_t *olen)
3816{
3817 ((void) session);
3818 ((void) buf);
3819 ((void) buf_len);
3820 *olen = 0;
3821 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3822}
3823
3824static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003825 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003826 size_t buf_len)
3827{
3828 ((void) session);
3829 ((void) buf);
3830 ((void) buf_len);
3831 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3832}
3833#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3834#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3835
Paul Bakker5121ce52009-01-03 21:22:43 +00003836/*
Hanno Beckera835da52019-05-16 12:39:07 +01003837 * Define ticket header determining Mbed TLS version
3838 * and structure of the ticket.
3839 */
3840
Hanno Becker94ef3b32019-05-16 12:50:45 +01003841/*
Hanno Becker50b59662019-05-28 14:30:45 +01003842 * Define bitflag determining compile-time settings influencing
3843 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003844 */
3845
Hanno Becker50b59662019-05-28 14:30:45 +01003846#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003847#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003848#else
Hanno Becker3e088662019-05-29 11:10:18 +01003849#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003850#endif /* MBEDTLS_HAVE_TIME */
3851
3852#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003853#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003854#else
Hanno Becker3e088662019-05-29 11:10:18 +01003855#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003856#endif /* MBEDTLS_X509_CRT_PARSE_C */
3857
David Horstmann5c5a32f2024-02-13 17:53:35 +00003858#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003859#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003860#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003861#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003862#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3863
Hanno Becker94ef3b32019-05-16 12:50:45 +01003864#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003865#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003866#else
Hanno Becker3e088662019-05-29 11:10:18 +01003867#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003868#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3869
3870#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003871#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003872#else
Hanno Becker3e088662019-05-29 11:10:18 +01003873#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003874#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3875
Hanno Becker94ef3b32019-05-16 12:50:45 +01003876#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003877#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003878#else
Hanno Becker3e088662019-05-29 11:10:18 +01003879#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003880#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3881
Hanno Becker94ef3b32019-05-16 12:50:45 +01003882#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3883#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3884#else
3885#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3886#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3887
David Horstmann92b258b2024-02-13 17:23:34 +00003888#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3889#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3890#else
3891#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3892#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3893
3894#if defined(MBEDTLS_SSL_EARLY_DATA)
3895#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3896#else
3897#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3898#endif /* MBEDTLS_SSL_EARLY_DATA */
3899
3900#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3901#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3902#else
3903#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3904#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3905
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003906#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3907 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003908#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3909#else
3910#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3911#endif /* MBEDTLS_SSL_ALPN */
3912
Hanno Becker3e088662019-05-29 11:10:18 +01003913#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3914#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3915#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3916#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003917#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3918#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003919#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003920#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3921#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3922#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003923#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003924
Hanno Becker50b59662019-05-28 14:30:45 +01003925#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003926 ((uint16_t) ( \
3927 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3928 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3929 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3930 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3931 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3932 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003933 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003934 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3935 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003936 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3937 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3938 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3939 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003940 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003941 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003942 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003943
Chien Wong4e9683e2023-12-28 17:07:43 +08003944static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003945 MBEDTLS_VERSION_MAJOR,
3946 MBEDTLS_VERSION_MINOR,
3947 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003948 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3949 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003950};
Hanno Beckera835da52019-05-16 12:39:07 +01003951
3952/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003953 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003954 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003955 *
David Horstmanncb01b362024-02-29 17:31:46 +00003956 * TLS 1.2 session:
3957 *
3958 * struct {
3959 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3960 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3961 * uint32 ticket_lifetime;
3962 * #endif
3963 * } ClientOnlyData;
3964 *
3965 * struct {
3966 * #if defined(MBEDTLS_HAVE_TIME)
3967 * uint64 start_time;
3968 * #endif
3969 * uint8 session_id_len; // at most 32
3970 * opaque session_id[32];
3971 * opaque master[48]; // fixed length in the standard
3972 * uint32 verify_result;
3973 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3974 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3975 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003976 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003977 * opaque peer_cert_digest<0..2^8-1>
3978 * #endif
3979 * select (endpoint) {
3980 * case client: ClientOnlyData;
3981 * case server: uint64 ticket_creation_time;
3982 * };
3983 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3984 * uint8 mfl_code; // up to 255 according to standard
3985 * #endif
3986 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3987 * uint8 encrypt_then_mac; // 0 or 1
3988 * #endif
3989 * } serialized_session_tls12;
3990 *
3991 *
3992 * TLS 1.3 Session:
3993 *
3994 * struct {
3995 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3996 * opaque hostname<0..2^16-1>;
3997 * #endif
3998 * #if defined(MBEDTLS_HAVE_TIME)
3999 * uint64 ticket_reception_time;
4000 * #endif
4001 * uint32 ticket_lifetime;
4002 * opaque ticket<1..2^16-1>;
4003 * } ClientOnlyData;
4004 *
4005 * struct {
4006 * uint32 ticket_age_add;
4007 * uint8 ticket_flags;
4008 * opaque resumption_key<0..255>;
4009 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4010 * uint32 max_early_data_size;
4011 * #endif
4012 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4013 * uint16 record_size_limit;
4014 * #endif
4015 * select ( endpoint ) {
4016 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004017 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004018 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004019 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004020 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004021 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004022 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004023 * #endif
4024 * };
4025 * } serialized_session_tls13;
4026 *
4027 *
4028 * SSL session:
4029 *
4030 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004031 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004032 * opaque mbedtls_version[3]; // library version: major, minor, patch
4033 * opaque session_format[2]; // library-version specific 16-bit field
4034 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004035 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004036 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004037 * Note: When updating the format, remember to keep
4038 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004039 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004040 * // In this version, `session_format` determines
4041 * // the setting of those compile-time
4042 * // configuration options which influence
4043 * // the structure of mbedtls_ssl_session.
4044 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004045 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004046 * // - TLS 1.2 (0x0303)
4047 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004048 * uint8_t endpoint;
4049 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004050 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004051 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004052 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004053 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004054 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004055 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004056 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004057 *
4058 * };
4059 *
4060 * } serialized_session;
4061 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004062 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004063
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004064MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004065static int ssl_session_save(const mbedtls_ssl_session *session,
4066 unsigned char omit_header,
4067 unsigned char *buf,
4068 size_t buf_len,
4069 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004070{
4071 unsigned char *p = buf;
4072 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004073 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004074#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4075 size_t out_len;
4076 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4077#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004078 if (session == NULL) {
4079 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4080 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004081
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004083 /*
4084 * Add Mbed TLS version identifier
4085 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004087
Gilles Peskine449bd832023-01-11 14:50:10 +01004088 if (used <= buf_len) {
4089 memcpy(p, ssl_serialized_session_header,
4090 sizeof(ssl_serialized_session_header));
4091 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004092 }
4093 }
4094
4095 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004096 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004097 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004098 used += 1 /* TLS version */
4099 + 1 /* endpoint */
4100 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 if (used <= buf_len) {
4102 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004103 *p++ = session->endpoint;
4104 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4105 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004106 }
4107
4108 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004109 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004110 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004111#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 case MBEDTLS_SSL_VERSION_TLS1_2:
4113 used += ssl_tls12_session_save(session, p, remaining_len);
4114 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004115#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4116
Jerry Yu251a12e2022-07-13 15:15:48 +08004117#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004118 case MBEDTLS_SSL_VERSION_TLS1_3:
4119 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4120 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4121 return ret;
4122 }
4123 used += out_len;
4124 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004125#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4126
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 default:
4128 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004129 }
4130
4131 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004132 if (used > buf_len) {
4133 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4134 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004135
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004137}
4138
4139/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004140 * Public wrapper for ssl_session_save()
4141 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004142int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4143 unsigned char *buf,
4144 size_t buf_len,
4145 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004146{
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004148}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004149
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004150/*
4151 * Deserialize session, see mbedtls_ssl_session_save() for format.
4152 *
4153 * This internal version is wrapped by a public function that cleans up in
4154 * case of error, and has an extra option omit_header.
4155 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004156MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004157static int ssl_session_load(mbedtls_ssl_session *session,
4158 unsigned char omit_header,
4159 const unsigned char *buf,
4160 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004161{
4162 const unsigned char *p = buf;
4163 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004164 size_t remaining_len;
4165
4166
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 if (session == NULL) {
4168 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4169 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004170
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004172 /*
4173 * Check Mbed TLS version identifier
4174 */
4175
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4177 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004178 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004179
4180 if (memcmp(p, ssl_serialized_session_header,
4181 sizeof(ssl_serialized_session_header)) != 0) {
4182 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4183 }
4184 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004185 }
4186
4187 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004188 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004189 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004190 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4192 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004193 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004194 session->endpoint = *p++;
4195 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4196 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004197
4198 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004199 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004201#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004202 case MBEDTLS_SSL_VERSION_TLS1_2:
4203 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004204#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4205
Jerry Yu438ddd82022-07-07 06:55:50 +00004206#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 case MBEDTLS_SSL_VERSION_TLS1_3:
4208 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004209#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4210
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 default:
4212 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004213 }
4214}
4215
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004216/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004217 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004218 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004219int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4220 const unsigned char *buf,
4221 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004222{
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004224
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 if (ret != 0) {
4226 mbedtls_ssl_session_free(session);
4227 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004228
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004230}
4231
4232/*
Paul Bakker1961b702013-01-25 14:49:24 +01004233 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004234 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004235MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004236static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004237{
4238 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4239
Ronald Cron66dbf912022-02-02 15:33:46 +01004240 /*
4241 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004242 * that were written into the output buffer by the previous handshake step,
4243 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004244 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4245 * We proceed to the next handshake step only when all data from the
4246 * previous one have been sent to the peer, thus we make sure that this is
4247 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4248 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4249 * we have to wait before to go ahead.
4250 * In the case of TLS 1.3, handshake step handlers do not send data to the
4251 * peer. Data are only sent here and through
4252 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004253 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004254 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4256 return ret;
4257 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004258
4259#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4261 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4262 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4263 return ret;
4264 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004265 }
4266#endif /* MBEDTLS_SSL_PROTO_DTLS */
4267
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004269}
4270
Gilles Peskine449bd832023-01-11 14:50:10 +01004271int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004272{
Hanno Becker41934dd2021-08-07 19:13:43 +01004273 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004274
Gilles Peskine449bd832023-01-11 14:50:10 +01004275 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004276 ssl->conf == NULL ||
4277 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4279 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004280 }
4281
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 ret = ssl_prepare_handshake_step(ssl);
4283 if (ret != 0) {
4284 return ret;
4285 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004286
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 ret = mbedtls_ssl_handle_pending_alert(ssl);
4288 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004289 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 }
Jerry Yue7047812021-09-13 19:26:39 +08004291
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004292 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4293 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4294 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4295
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004296#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4298 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004299 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004300
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004302 case MBEDTLS_SSL_HELLO_REQUEST:
4303 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004304 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004305 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004306
Ronald Cron9f0fba32022-02-10 16:45:15 +01004307 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004309 break;
4310
4311 default:
4312#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4314 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4315 } else {
4316 ret = mbedtls_ssl_handshake_client_step(ssl);
4317 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004318#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004320#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004322#endif
4323 }
Jerry Yub9930e72021-08-06 17:11:51 +08004324 }
Ronald Cron6291b232023-03-08 15:51:25 +01004325#endif /* MBEDTLS_SSL_CLI_C */
4326
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004327#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004329#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4330 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004332 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 ret = mbedtls_ssl_handshake_server_step(ssl);
4334 }
Ronald Cron6291b232023-03-08 15:51:25 +01004335#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4336 ret = mbedtls_ssl_handshake_server_step(ssl);
4337#else
4338 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004339#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004340 }
4341#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004342
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004344 /* handshake_step return error. And it is same
4345 * with alert_reason.
4346 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 if (ssl->send_alert) {
4348 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004349 goto cleanup;
4350 }
4351 }
4352
4353cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004355}
4356
4357/*
4358 * Perform the SSL handshake
4359 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004360int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004361{
4362 int ret = 0;
4363
Hanno Beckera817ea42020-10-20 15:20:23 +01004364 /* Sanity checks */
4365
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 if (ssl == NULL || ssl->conf == NULL) {
4367 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4368 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004369
Hanno Beckera817ea42020-10-20 15:20:23 +01004370#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4372 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4373 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4374 "mbedtls_ssl_set_timer_cb() for DTLS"));
4375 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004376 }
4377#endif /* MBEDTLS_SSL_PROTO_DTLS */
4378
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004380
Hanno Beckera817ea42020-10-20 15:20:23 +01004381 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4383 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004384
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004386 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 }
Paul Bakker1961b702013-01-25 14:49:24 +01004388 }
4389
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004391
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004393}
4394
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004395#if defined(MBEDTLS_SSL_RENEGOTIATION)
4396#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004397/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004398 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004399 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004400MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004401static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004402{
Janos Follath865b3eb2019-12-16 11:46:15 +00004403 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004404
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004406
4407 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004408 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4409 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4412 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4413 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004414 }
4415
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004417
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004419}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004420#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004421
4422/*
4423 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004424 * - any side: calling mbedtls_ssl_renegotiate(),
4425 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4426 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004427 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004428 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004429 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004430 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004431int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004432{
Janos Follath865b3eb2019-12-16 11:46:15 +00004433 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004434
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004436
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 if ((ret = ssl_handshake_init(ssl)) != 0) {
4438 return ret;
4439 }
Paul Bakker48916f92012-09-16 19:57:18 +00004440
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004441 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4442 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004443#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4445 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4446 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004447 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004449 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004451 }
4452#endif
4453
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004454 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4455 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004456
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4458 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4459 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004460 }
4461
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004463
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004465}
4466
4467/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004468 * Renegotiate current connection on client,
4469 * or request renegotiation on server
4470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004471int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004472{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004473 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004474
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 if (ssl == NULL || ssl->conf == NULL) {
4476 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4477 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004479#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004480 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4482 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4483 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4484 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004485
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004486 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004487
4488 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 if (ssl->out_left != 0) {
4490 return mbedtls_ssl_flush_output(ssl);
4491 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004492
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004494 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004495#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004496
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004497#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004498 /*
4499 * On client, either start the renegotiation process or,
4500 * if already in progress, continue the handshake
4501 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4503 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4504 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004505 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004506
4507 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4508 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4509 return ret;
4510 }
4511 } else {
4512 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4513 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4514 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004515 }
4516 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004517#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004518
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004520}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004521#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004522
Gilles Peskine449bd832023-01-11 14:50:10 +01004523void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004524{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004525 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4526
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004528 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004530
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004531#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004532#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 if (ssl->handshake->group_list_heap_allocated) {
4534 mbedtls_free((void *) handshake->group_list);
4535 }
Brett Warrene0edc842021-08-17 09:53:13 +01004536 handshake->group_list = NULL;
4537#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004538#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004539
Ronald Crone68ab4f2022-10-05 12:46:29 +02004540#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004541#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 if (ssl->handshake->sig_algs_heap_allocated) {
4543 mbedtls_free((void *) handshake->sig_algs);
4544 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004545 handshake->sig_algs = NULL;
4546#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004547#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 if (ssl->handshake->certificate_request_context) {
4549 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004550 }
4551#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004552#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004553
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004554#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4556 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004557 handshake->async_in_progress = 0;
4558 }
4559#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4560
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004561#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004563#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004564#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004566#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004567
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004568#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004570#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004571
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004572#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004574 /*
4575 * Opaque keys are not stored in the handshake's data and it's the user
4576 * responsibility to destroy them. Clear ones, instead, are created by
4577 * the TLS library and should be destroyed at the same level
4578 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4580 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004581 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004582 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004583#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004585 handshake->ecjpake_cache = NULL;
4586 handshake->ecjpake_cache_len = 0;
4587#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004588#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004589
Valerio Setti7aeec542023-07-05 18:57:21 +02004590#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004591 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004592 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004593 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004595#endif
4596
Ronald Cron73fe8df2022-10-05 14:31:43 +02004597#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004599 /* The maintenance of the external PSK key slot is the
4600 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 if (ssl->handshake->psk_opaque_is_internal) {
4602 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004603 ssl->handshake->psk_opaque_is_internal = 0;
4604 }
4605 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4606 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004607#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004609#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4610 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004611 /*
4612 * Free only the linked list wrapper, not the keys themselves
4613 * since the belong to the SNI callback
4614 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004616#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004617
Gilles Peskineeccd8882020-03-10 12:19:08 +01004618#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4620 if (handshake->ecrs_peer_cert != NULL) {
4621 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4622 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004623 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004624#endif
4625
Hanno Becker75173122019-02-06 16:18:31 +00004626#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4627 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004629#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4630
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004631#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4633 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004634#endif /* MBEDTLS_SSL_CLI_C &&
4635 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004636
4637#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 mbedtls_ssl_flight_free(handshake->flight);
4639 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004640#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004641
Valerio Settiea59c432023-07-25 11:14:03 +02004642#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004643 if (handshake->xxdh_psa_privkey_is_external == 0) {
4644 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 }
Valerio Settiea59c432023-07-25 11:14:03 +02004646#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004647
Ronald Cron6f135e12021-12-08 16:57:54 +01004648#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 mbedtls_ssl_transform_free(handshake->transform_handshake);
4650 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004651#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4653 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004654#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004655#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004656
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004657
4658#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4659 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4660 * processes datagrams and the fact that a datagram is allowed to have
4661 * several records in it, it is possible that the I/O buffers are not
4662 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4664 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004665#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004666
Jerry Yuba9c7272021-10-30 11:54:10 +08004667 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 mbedtls_platform_zeroize(handshake,
4669 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004670}
4671
Gilles Peskine449bd832023-01-11 14:50:10 +01004672void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004673{
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004675 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004677
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004678#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004680#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004681
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004682#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004683#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4684 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004686#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004688#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004689
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004690#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4691 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004692 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004693#endif
4694
Gilles Peskine449bd832023-01-11 14:50:10 +01004695 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004696}
4697
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004698#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004699
4700#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4701#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4702#else
4703#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4704#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4705
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004706#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004707
4708#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4709#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4710#else
4711#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4712#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4713
4714#if defined(MBEDTLS_SSL_ALPN)
4715#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4716#else
4717#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4718#endif /* MBEDTLS_SSL_ALPN */
4719
4720#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4721#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4722#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4723#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4724
4725#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 ((uint32_t) ( \
4727 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4728 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4729 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4730 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4731 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4732 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4733 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4734 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004735
Chien Wong4e9683e2023-12-28 17:07:43 +08004736static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004737 MBEDTLS_VERSION_MAJOR,
4738 MBEDTLS_VERSION_MINOR,
4739 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4741 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4742 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4743 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4744 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004745};
4746
Paul Bakker5121ce52009-01-03 21:22:43 +00004747/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004748 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004749 *
4750 * The format of the serialized data is:
4751 * (in the presentation language of TLS, RFC 8446 section 3)
4752 *
4753 * // header
4754 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004755 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004756 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004757 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004758 * Note: When updating the format, remember to keep these
4759 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004760 *
4761 * // session sub-structure
4762 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4763 * // transform sub-structure
4764 * uint8 random[64]; // ServerHello.random+ClientHello.random
4765 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4766 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4767 * // fields from ssl_context
4768 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4769 * uint64 in_window_top; // DTLS: last validated record seq_num
4770 * uint64 in_window; // DTLS: bitmask for replay protection
4771 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4772 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4773 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4774 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4775 *
4776 * Note that many fields of the ssl_context or sub-structures are not
4777 * serialized, as they fall in one of the following categories:
4778 *
4779 * 1. forced value (eg in_left must be 0)
4780 * 2. pointer to dynamically-allocated memory (eg session, transform)
4781 * 3. value can be re-derived from other data (eg session keys from MS)
4782 * 4. value was temporary (eg content of input buffer)
4783 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004784 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004785int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4786 unsigned char *buf,
4787 size_t buf_len,
4788 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004789{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004790 unsigned char *p = buf;
4791 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004792 size_t session_len;
4793 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004794
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004795 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004796 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4797 * this function's documentation.
4798 *
4799 * These are due to assumptions/limitations in the implementation. Some of
4800 * them are likely to stay (no handshake in progress) some might go away
4801 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004802 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004803 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4805 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4806 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004807 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 if (ssl->handshake != NULL) {
4809 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4810 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004811 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004812 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 if (ssl->transform == NULL || ssl->session == NULL) {
4814 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4815 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004816 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004817 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 if (mbedtls_ssl_check_pending(ssl) != 0) {
4819 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4820 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004821 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 if (ssl->out_left != 0) {
4823 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4824 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004825 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004826 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4828 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4829 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004830 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004831 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4833 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4834 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004835 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004836 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4838 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4839 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004840 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004841 /* Renegotiation must not be enabled */
4842#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4844 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4845 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004846 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004847#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004848
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004849 /*
4850 * Version and format identifier
4851 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004853
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 if (used <= buf_len) {
4855 memcpy(p, ssl_serialized_context_header,
4856 sizeof(ssl_serialized_context_header));
4857 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004858 }
4859
4860 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004861 * Session (length + data)
4862 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4864 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4865 return ret;
4866 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004867
4868 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004869 if (used <= buf_len) {
4870 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004871 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004872
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 ret = ssl_session_save(ssl->session, 1,
4874 p, session_len, &session_len);
4875 if (ret != 0) {
4876 return ret;
4877 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004878
4879 p += session_len;
4880 }
4881
4882 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004883 * Transform
4884 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 used += sizeof(ssl->transform->randbytes);
4886 if (used <= buf_len) {
4887 memcpy(p, ssl->transform->randbytes,
4888 sizeof(ssl->transform->randbytes));
4889 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004890 }
4891
4892#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004893 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004895 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004897 p += ssl->transform->in_cid_len;
4898
4899 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004901 p += ssl->transform->out_cid_len;
4902 }
4903#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4904
4905 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004906 * Saved fields from top-level ssl_context structure
4907 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004908 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 if (used <= buf_len) {
4910 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004911 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004912 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004913
4914#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4915 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004916 if (used <= buf_len) {
4917 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004918 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004919
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004921 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004922 }
4923#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4924
4925#if defined(MBEDTLS_SSL_PROTO_DTLS)
4926 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004928 *p++ = ssl->disable_datagram_packing;
4929 }
4930#endif /* MBEDTLS_SSL_PROTO_DTLS */
4931
Jerry Yuae0b2e22021-10-08 15:21:19 +08004932 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (used <= buf_len) {
4934 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004935 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004936 }
4937
4938#if defined(MBEDTLS_SSL_PROTO_DTLS)
4939 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 if (used <= buf_len) {
4941 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004942 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004943 }
4944#endif /* MBEDTLS_SSL_PROTO_DTLS */
4945
4946#if defined(MBEDTLS_SSL_ALPN)
4947 {
4948 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004950 : 0;
4951
4952 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004954 *p++ = alpn_len;
4955
Gilles Peskine449bd832023-01-11 14:50:10 +01004956 if (ssl->alpn_chosen != NULL) {
4957 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004958 p += alpn_len;
4959 }
4960 }
4961 }
4962#endif /* MBEDTLS_SSL_ALPN */
4963
4964 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004965 * Done
4966 */
4967 *olen = used;
4968
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 if (used > buf_len) {
4970 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4971 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004972
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004974
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004976}
4977
4978/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004979 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004980 *
4981 * This internal version is wrapped by a public function that cleans up in
4982 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004983 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004984MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004985static int ssl_context_load(mbedtls_ssl_context *ssl,
4986 const unsigned char *buf,
4987 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004988{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004989 const unsigned char *p = buf;
4990 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004991 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004992 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004993#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004994 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004995#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004996
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004997 /*
4998 * The context should have been freshly setup or reset.
4999 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005000 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005001 * renegotiating, or if the user mistakenly loaded a session first.)
5002 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5004 ssl->session != NULL) {
5005 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005006 }
5007
5008 /*
5009 * We can't check that the config matches the initial one, but we can at
5010 * least check it matches the requirements for serializing.
5011 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005012 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005013#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005014 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005015#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005016 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5017 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5018 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5019 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005021 }
5022
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005024
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005025 /*
5026 * Check version identifier
5027 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5029 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005030 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005031
5032 if (memcmp(p, ssl_serialized_context_header,
5033 sizeof(ssl_serialized_context_header)) != 0) {
5034 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5035 }
5036 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005037
5038 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005039 * Session
5040 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005041 if ((size_t) (end - p) < 4) {
5042 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5043 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005044
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005045 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005046 p += 4;
5047
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005048 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005049 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005050 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005051 ssl->session_in = ssl->session;
5052 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005053 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005054
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 if ((size_t) (end - p) < session_len) {
5056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5057 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005058
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 ret = ssl_session_load(ssl->session, 1, p, session_len);
5060 if (ret != 0) {
5061 mbedtls_ssl_session_free(ssl->session);
5062 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005063 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005064
5065 p += session_len;
5066
5067 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005068 * Transform
5069 */
5070
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005071 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005072 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005073#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005074 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005075 ssl->transform_in = ssl->transform;
5076 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005077 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005078#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005079
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005080#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5082 if (prf_func == NULL) {
5083 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5084 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005085
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005086 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5088 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5089 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005090
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 ret = ssl_tls12_populate_transform(ssl->transform,
5092 ssl->session->ciphersuite,
5093 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005094#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005096#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 prf_func,
5098 p, /* currently pointing to randbytes */
5099 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5100 ssl->conf->endpoint,
5101 ssl);
5102 if (ret != 0) {
5103 return ret;
5104 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005105#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005106 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005107
5108#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5109 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 if ((size_t) (end - p) < 1) {
5111 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5112 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005113
5114 ssl->transform->in_cid_len = *p++;
5115
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5118 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005119
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005121 p += ssl->transform->in_cid_len;
5122
5123 ssl->transform->out_cid_len = *p++;
5124
Gilles Peskine449bd832023-01-11 14:50:10 +01005125 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5126 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5127 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005128
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005130 p += ssl->transform->out_cid_len;
5131#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5132
5133 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005134 * Saved fields from top-level ssl_context structure
5135 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 if ((size_t) (end - p) < 4) {
5137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5138 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005139
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005140 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005141 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005142
5143#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 if ((size_t) (end - p) < 16) {
5145 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5146 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005147
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005148 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005149 p += 8;
5150
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005151 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005152 p += 8;
5153#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5154
5155#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 if ((size_t) (end - p) < 1) {
5157 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5158 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005159
5160 ssl->disable_datagram_packing = *p++;
5161#endif /* MBEDTLS_SSL_PROTO_DTLS */
5162
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5164 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5165 }
5166 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5167 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005168
5169#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 if ((size_t) (end - p) < 2) {
5171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5172 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005173
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005174 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005175 p += 2;
5176#endif /* MBEDTLS_SSL_PROTO_DTLS */
5177
5178#if defined(MBEDTLS_SSL_ALPN)
5179 {
5180 uint8_t alpn_len;
5181 const char **cur;
5182
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 if ((size_t) (end - p) < 1) {
5184 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5185 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005186
5187 alpn_len = *p++;
5188
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005190 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5192 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005193 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005194 ssl->alpn_chosen = *cur;
5195 break;
5196 }
5197 }
5198 }
5199
5200 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5202 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5203 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005204
5205 p += alpn_len;
5206 }
5207#endif /* MBEDTLS_SSL_ALPN */
5208
5209 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005210 * Forced fields from top-level ssl_context structure
5211 *
5212 * Most of them already set to the correct value by mbedtls_ssl_init() and
5213 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5214 */
5215 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005216 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005217
Hanno Becker361b10d2019-08-30 10:42:49 +01005218 /* Adjust pointers for header fields of outgoing records to
5219 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005221
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005222#if defined(MBEDTLS_SSL_PROTO_DTLS)
5223 ssl->in_epoch = 1;
5224#endif
5225
5226 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5227 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005228 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5229 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 if (ssl->handshake != NULL) {
5231 mbedtls_ssl_handshake_free(ssl);
5232 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005233 ssl->handshake = NULL;
5234 }
5235
5236 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005237 * Done - should have consumed entire buffer
5238 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 if (p != end) {
5240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5241 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005242
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005244}
5245
5246/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005247 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005248 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005249int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5250 const unsigned char *buf,
5251 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005252{
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005254
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 if (ret != 0) {
5256 mbedtls_ssl_free(context);
5257 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005258
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005260}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005261#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005262
5263/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005264 * Free an SSL context
5265 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005266void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005267{
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005269 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005271
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005273
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005275#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5276 size_t out_buf_len = ssl->out_buf_len;
5277#else
5278 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5279#endif
5280
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005281 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005282 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005283 }
5284
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005286#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5287 size_t in_buf_len = ssl->in_buf_len;
5288#else
5289 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5290#endif
5291
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005292 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005293 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005294 }
5295
Gilles Peskine449bd832023-01-11 14:50:10 +01005296 if (ssl->transform) {
5297 mbedtls_ssl_transform_free(ssl->transform);
5298 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005299 }
5300
Gilles Peskine449bd832023-01-11 14:50:10 +01005301 if (ssl->handshake) {
5302 mbedtls_ssl_handshake_free(ssl);
5303 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005304
5305#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5307 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005308#endif
5309
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 mbedtls_ssl_session_free(ssl->session_negotiate);
5311 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005312 }
5313
Ronald Cron6f135e12021-12-08 16:57:54 +01005314#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 mbedtls_ssl_transform_free(ssl->transform_application);
5316 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005317#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005318
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 if (ssl->session) {
5320 mbedtls_ssl_session_free(ssl->session);
5321 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005322 }
5323
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005324#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01005325 mbedtls_ssl_free_hostname(ssl);
Paul Bakker0be444a2013-08-27 21:55:01 +02005326#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005327
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005328#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005330#endif
5331
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005333
Paul Bakker86f04f42013-02-14 11:20:09 +01005334 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005336}
5337
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005338/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005339 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005340 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005341void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005342{
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005344}
5345
Gilles Peskineae270bf2021-06-02 00:05:29 +02005346/* The selection should be the same as mbedtls_x509_crt_profile_default in
5347 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005348 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005349 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005350 * about this list.
5351 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005352static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005353#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005354 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005355#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005356#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005357 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005358#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005359#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005360 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005361#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005362#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005363 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005364#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005365#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005366 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005367#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005368#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005369 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005370#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005371#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005372 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005373#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005374#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005375 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005376#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005377#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005378 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5379 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5380 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5381 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5382 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5383#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005384 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005385};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005386
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005387static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005388 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5389 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5390 0
5391};
5392
Ronald Crone68ab4f2022-10-05 12:46:29 +02005393#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005394
Jerry Yu909df7b2022-01-22 11:56:27 +08005395/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005396 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005397 * rules SHOULD be upheld.
5398 * - No duplicate entries.
5399 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005400 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005401 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005402 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005403static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005404
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005405#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005406 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005407 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005408 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005409 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5410#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005411
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005412#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005413 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005414 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005415 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005416 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5417#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005418
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005419#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005420 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005421 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005422 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005423 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5424#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005425
Gabor Mezeic15ef932024-06-13 12:53:54 +02005426#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005427 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005428#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005429
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005430#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005431 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005432#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005433
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005434#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005435 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005436#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005437
Gabor Mezeic15ef932024-06-13 12:53:54 +02005438#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005439 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005440#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005441
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005442#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005443 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005444#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005445
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005446#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005447 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005448#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005449
Gabor Mezei15b95a62022-05-09 16:37:58 +02005450 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005451};
5452
5453/* NOTICE: see above */
5454#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5455static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005456
Gabor Mezeic15ef932024-06-13 12:53:54 +02005457#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005458#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005460#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005461#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5462 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005463#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005464#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005466#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005467#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005468
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005469#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005470#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005472#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005473#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5474 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005475#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005476#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005478#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005479#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005480
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005481#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005482#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005483 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005484#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005485#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5486 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005487#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005488#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005490#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005491#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005492
Gabor Mezei15b95a62022-05-09 16:37:58 +02005493 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005494};
5495#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005496
Jerry Yu909df7b2022-01-22 11:56:27 +08005497/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005498static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005499
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005500#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005501 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005502 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005503 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005504 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5505#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005506
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005507#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005508 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005509 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005510 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005511 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5512#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005513
Gabor Mezei15b95a62022-05-09 16:37:58 +02005514 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005515};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005516
Jerry Yu909df7b2022-01-22 11:56:27 +08005517/* NOTICE: see above */
5518#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5519static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005520
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005521#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005522#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005524#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005525#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005526
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005527#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005528#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005530#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005531#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005532
Gabor Mezei15b95a62022-05-09 16:37:58 +02005533 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005534};
Jerry Yu909df7b2022-01-22 11:56:27 +08005535#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5536
Ronald Crone68ab4f2022-10-05 12:46:29 +02005537#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005538
Chien Wong4e9683e2023-12-28 17:07:43 +08005539static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005540#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005541 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005542#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005543#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005544 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005545#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005546 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005547};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005548
Ronald Crone68ab4f2022-10-05 12:46:29 +02005549#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005550/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005551 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005552MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005553static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005554{
5555 size_t i, j;
5556 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005557
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5559 for (j = 0; j < i; j++) {
5560 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005561 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005562 }
5563 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5564 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5565 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005566 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005567 }
5568 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005570}
5571
Ronald Crone68ab4f2022-10-05 12:46:29 +02005572#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005573
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005574/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005575 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005576 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005577int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5578 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005579{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005580#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005581 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005582#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005583
Ronald Crone68ab4f2022-10-05 12:46:29 +02005584#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5586 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5587 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005588 }
5589
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5591 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5592 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005593 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005594
5595#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5597 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5598 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005599 }
5600
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5602 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5603 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005604 }
5605#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005606#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005607
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005608 /* Use the functions here so that they are covered in tests,
5609 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 mbedtls_ssl_conf_endpoint(conf, endpoint);
5611 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005612
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005613 /*
5614 * Things that are common to all presets
5615 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005616#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005617 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005618 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5619#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5620 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5621#endif
5622 }
5623#endif
5624
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005625#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5626 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5627#endif
5628
5629#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5630 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5631#endif
5632
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005633#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005634 conf->f_cookie_write = ssl_cookie_write_dummy;
5635 conf->f_cookie_check = ssl_cookie_check_dummy;
5636#endif
5637
5638#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5639 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5640#endif
5641
Janos Follath088ce432017-04-10 12:42:31 +01005642#if defined(MBEDTLS_SSL_SRV_C)
5643 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005644 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005645#endif
5646
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005647#if defined(MBEDTLS_SSL_PROTO_DTLS)
5648 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5649 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5650#endif
5651
5652#if defined(MBEDTLS_SSL_RENEGOTIATION)
5653 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005654 memset(conf->renego_period, 0x00, 2);
5655 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005656#endif
5657
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005658#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005660 const unsigned char dhm_p[] =
5661 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5662 const unsigned char dhm_g[] =
5663 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005664
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5666 dhm_p, sizeof(dhm_p),
5667 dhm_g, sizeof(dhm_g))) != 0) {
5668 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005669 }
5670 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005671#endif
5672
Ronald Cron6f135e12021-12-08 16:57:54 +01005673#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005674
5675#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005676 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005677#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005678 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005679#endif
5680#endif /* MBEDTLS_SSL_EARLY_DATA */
5681
Jerry Yud0766ec2022-09-22 10:46:57 +08005682#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005683 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005685#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005686 /*
5687 * Allow all TLS 1.3 key exchange modes by default.
5688 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005689 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005690#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005691
Gilles Peskine449bd832023-01-11 14:50:10 +01005692 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005693#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005694 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005695 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005696#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005698#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005700#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005701 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5702 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005703#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5704 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5705 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5706#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5707 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5708 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5709#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005711#endif
5712 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005713
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005714 /*
5715 * Preset-specific defaults
5716 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005718 /*
5719 * NSA Suite B
5720 */
5721 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005722
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005723 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005724
5725#if defined(MBEDTLS_X509_CRT_PARSE_C)
5726 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005727#endif
5728
Ronald Crone68ab4f2022-10-05 12:46:29 +02005729#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005730#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005732 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005734#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005736#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005737
Brett Warrene0edc842021-08-17 09:53:13 +01005738 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005739 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005740
5741 /*
5742 * Default
5743 */
5744 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005745
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005746 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005747
5748#if defined(MBEDTLS_X509_CRT_PARSE_C)
5749 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5750#endif
5751
Ronald Crone68ab4f2022-10-05 12:46:29 +02005752#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005753#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005755 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005757#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005758 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005759#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005760
Brett Warrene0edc842021-08-17 09:53:13 +01005761 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005762
5763#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5764 conf->dhm_min_bitlen = 1024;
5765#endif
5766 }
5767
Gilles Peskine449bd832023-01-11 14:50:10 +01005768 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005769}
5770
5771/*
5772 * Free mbedtls_ssl_config
5773 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005774void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005775{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005776 if (conf == NULL) {
5777 return;
5778 }
5779
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005780#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 mbedtls_mpi_free(&conf->dhm_P);
5782 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005783#endif
5784
Ronald Cron73fe8df2022-10-05 14:31:43 +02005785#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005787 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5788 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005789 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005790 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005791 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005792 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005793 }
5794
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005796 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005797 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005798 conf->psk_identity_len = 0;
5799 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005800#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005801
5802#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005804#endif
5805
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005807}
5808
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005809#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005810 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005811/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005812 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005813 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005814unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005815{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005816#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005817 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5818 return MBEDTLS_SSL_SIG_RSA;
5819 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005820#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005821#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5823 return MBEDTLS_SSL_SIG_ECDSA;
5824 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005825#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005827}
5828
Gilles Peskine449bd832023-01-11 14:50:10 +01005829unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005830{
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005832 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005834 case MBEDTLS_PK_ECDSA:
5835 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005837 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005839 }
5840}
5841
Gilles Peskine449bd832023-01-11 14:50:10 +01005842mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005843{
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005845#if defined(MBEDTLS_RSA_C)
5846 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005848#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005849#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005850 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005852#endif
5853 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005855 }
5856}
Valerio Settie9646ec2023-08-02 20:02:28 +02005857#endif /* MBEDTLS_PK_C &&
5858 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005859
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005860/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005861 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005862 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005863mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005864{
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005866#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005867 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005868 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005869#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005870#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005871 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005873#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005874#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005875 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005877#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005878#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005879 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005881#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005882#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005883 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005885#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005886#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005887 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005889#endif
5890 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005892 }
5893}
5894
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005895/*
5896 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5897 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005898unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005899{
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005901#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005902 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005904#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005905#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005906 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005907 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005908#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005909#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005910 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005911 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005912#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005913#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005914 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005915 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005916#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005917#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005918 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005920#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005921#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005922 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005924#endif
5925 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005927 }
5928}
5929
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005930/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005931 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005932 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005933 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005934int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005935{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005936 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005937
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 if (group_list == NULL) {
5939 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005940 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005941
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 for (; *group_list != 0; group_list++) {
5943 if (*group_list == tls_id) {
5944 return 0;
5945 }
5946 }
5947
5948 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005949}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005950
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005951#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005952/*
5953 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5954 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005955int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005956{
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005958
Gilles Peskine449bd832023-01-11 14:50:10 +01005959 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005960 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005961 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005962
Gilles Peskine449bd832023-01-11 14:50:10 +01005963 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005964}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005965#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005966
Valerio Setti18c9fed2022-12-30 17:44:24 +01005967static const struct {
5968 uint16_t tls_id;
5969 mbedtls_ecp_group_id ecp_group_id;
5970 psa_ecc_family_t psa_family;
5971 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005972} tls_id_match_table[] =
5973{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005974#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005975 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005976#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005977#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005978 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005979#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005980#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005981 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005982#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005983#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005984 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005985#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005986#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005987 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005988#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005989#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005990 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005991#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005992#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005993 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005994#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005995#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005996 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005997#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005998#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005999 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006000#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01006001#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02006002 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006003#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01006004#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02006005 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006006#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01006007#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006008 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006009#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006010 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006011};
6012
Gilles Peskine449bd832023-01-11 14:50:10 +01006013int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006014 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006016{
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6018 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006019 if (type != NULL) {
6020 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 }
6022 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006023 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006025 return PSA_SUCCESS;
6026 }
6027 }
6028
6029 return PSA_ERROR_NOT_SUPPORTED;
6030}
6031
Gilles Peskine449bd832023-01-11 14:50:10 +01006032mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006033{
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6035 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006036 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006037 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006038 }
6039
6040 return MBEDTLS_ECP_DP_NONE;
6041}
6042
Gilles Peskine449bd832023-01-11 14:50:10 +01006043uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006044{
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6046 i++) {
6047 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006048 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006050 }
6051
6052 return 0;
6053}
6054
Valerio Setti67419f02023-01-04 16:12:42 +01006055#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006056static const struct {
6057 uint16_t tls_id;
6058 const char *name;
6059} tls_id_curve_name_table[] =
6060{
Valerio Setti54e23792023-07-07 10:49:27 +02006061 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6062 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6063 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6064 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6065 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6066 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6067 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6068 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6069 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6070 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6071 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6072 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6073 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006074 { 0, NULL },
6075};
6076
Gilles Peskine449bd832023-01-11 14:50:10 +01006077const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006078{
Valerio Settiacd32c02023-06-29 18:06:29 +02006079 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6080 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6081 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006083 }
6084
6085 return NULL;
6086}
Valerio Setti67419f02023-01-04 16:12:42 +01006087#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006088
Gilles Peskine449bd832023-01-11 14:50:10 +01006089int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6090 const mbedtls_md_type_t md,
6091 unsigned char *dst,
6092 size_t dst_len,
6093 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006094{
Ronald Cronf6893e12022-01-07 22:09:01 +01006095 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6096 psa_hash_operation_t *hash_operation_to_clone;
6097 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6098
Jerry Yu148165c2021-09-24 23:20:59 +08006099 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006100
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006102#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 case MBEDTLS_MD_SHA384:
6104 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6105 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006106#endif
6107
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006108#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 case MBEDTLS_MD_SHA256:
6110 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6111 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006112#endif
6113
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 default:
6115 goto exit;
6116 }
6117
6118 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6119 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006120 goto exit;
6121 }
6122
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6124 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006125 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006127
6128exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006129#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006130 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006131 (void) ssl;
6132#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006133 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006134}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006135
Ronald Crone68ab4f2022-10-05 12:46:29 +02006136#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006137/* mbedtls_ssl_parse_sig_alg_ext()
6138 *
6139 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6140 * value (TLS 1.3 RFC8446):
6141 * enum {
6142 * ....
6143 * ecdsa_secp256r1_sha256( 0x0403 ),
6144 * ecdsa_secp384r1_sha384( 0x0503 ),
6145 * ecdsa_secp521r1_sha512( 0x0603 ),
6146 * ....
6147 * } SignatureScheme;
6148 *
6149 * struct {
6150 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6151 * } SignatureSchemeList;
6152 *
6153 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6154 * value (TLS 1.2 RFC5246):
6155 * enum {
6156 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6157 * sha512(6), (255)
6158 * } HashAlgorithm;
6159 *
6160 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6161 * SignatureAlgorithm;
6162 *
6163 * struct {
6164 * HashAlgorithm hash;
6165 * SignatureAlgorithm signature;
6166 * } SignatureAndHashAlgorithm;
6167 *
6168 * SignatureAndHashAlgorithm
6169 * supported_signature_algorithms<2..2^16-2>;
6170 *
6171 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6172 * generalization of the TLS 1.2 signature algorithm extension.
6173 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6174 * `SignatureScheme` field of TLS 1.3
6175 *
6176 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006177int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6178 const unsigned char *buf,
6179 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006180{
6181 const unsigned char *p = buf;
6182 size_t supported_sig_algs_len = 0;
6183 const unsigned char *supported_sig_algs_end;
6184 uint16_t sig_alg;
6185 uint32_t common_idx = 0;
6186
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6188 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006189 p += 2;
6190
Gilles Peskine449bd832023-01-11 14:50:10 +01006191 memset(ssl->handshake->received_sig_algs, 0,
6192 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006193
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006195 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 while (p < supported_sig_algs_end) {
6197 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6198 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006199 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006200 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6201 sig_alg,
6202 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006203#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6205 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6206 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006207 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006208 }
6209#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006210
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6212 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006213
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006215 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6216 common_idx += 1;
6217 }
6218 }
6219 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 if (p != end) {
6221 MBEDTLS_SSL_DEBUG_MSG(1,
6222 ("Signature algorithms extension length misaligned"));
6223 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6224 MBEDTLS_ERR_SSL_DECODE_ERROR);
6225 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006226 }
6227
Gilles Peskine449bd832023-01-11 14:50:10 +01006228 if (common_idx == 0) {
6229 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6230 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6231 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6232 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006233 }
6234
Gabor Mezei15b95a62022-05-09 16:37:58 +02006235 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006237}
6238
Ronald Crone68ab4f2022-10-05 12:46:29 +02006239#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006240
Jerry Yudc7bd172022-02-17 13:44:15 +08006241#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6242
Jerry Yudc7bd172022-02-17 13:44:15 +08006243
Gilles Peskine449bd832023-01-11 14:50:10 +01006244static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6245 mbedtls_svc_key_id_t key,
6246 psa_algorithm_t alg,
6247 const unsigned char *raw_psk, size_t raw_psk_length,
6248 const unsigned char *seed, size_t seed_length,
6249 const unsigned char *label, size_t label_length,
6250 const unsigned char *other_secret,
6251 size_t other_secret_length,
6252 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006253{
6254 psa_status_t status;
6255
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 status = psa_key_derivation_setup(derivation, alg);
6257 if (status != PSA_SUCCESS) {
6258 return status;
6259 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006260
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6262 status = psa_key_derivation_input_bytes(derivation,
6263 PSA_KEY_DERIVATION_INPUT_SEED,
6264 seed, seed_length);
6265 if (status != PSA_SUCCESS) {
6266 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006267 }
6268
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 if (other_secret != NULL) {
6270 status = psa_key_derivation_input_bytes(derivation,
6271 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6272 other_secret, other_secret_length);
6273 if (status != PSA_SUCCESS) {
6274 return status;
6275 }
6276 }
6277
6278 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006279 status = psa_key_derivation_input_bytes(
6280 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 raw_psk, raw_psk_length);
6282 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006283 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006285 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 if (status != PSA_SUCCESS) {
6287 return status;
6288 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006289
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 status = psa_key_derivation_input_bytes(derivation,
6291 PSA_KEY_DERIVATION_INPUT_LABEL,
6292 label, label_length);
6293 if (status != PSA_SUCCESS) {
6294 return status;
6295 }
6296 } else {
6297 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006298 }
6299
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 status = psa_key_derivation_set_capacity(derivation, capacity);
6301 if (status != PSA_SUCCESS) {
6302 return status;
6303 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006304
Gilles Peskine449bd832023-01-11 14:50:10 +01006305 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006306}
6307
Andrzej Kurek57d10632022-10-24 10:32:01 -04006308#if defined(PSA_WANT_ALG_SHA_384) || \
6309 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006310MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006311static int tls_prf_generic(mbedtls_md_type_t md_type,
6312 const unsigned char *secret, size_t slen,
6313 const char *label,
6314 const unsigned char *random, size_t rlen,
6315 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006316{
6317 psa_status_t status;
6318 psa_algorithm_t alg;
6319 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6320 psa_key_derivation_operation_t derivation =
6321 PSA_KEY_DERIVATION_OPERATION_INIT;
6322
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006324 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006326 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006328
6329 /* Normally a "secret" should be long enough to be impossible to
6330 * find by brute force, and in particular should not be empty. But
6331 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6332 * and for this use case it makes sense to have a 0-length "secret".
6333 * Since the key API doesn't allow importing a key of length 0,
6334 * keep master_key=0, which setup_psa_key_derivation() understands
6335 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006337 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6339 psa_set_key_algorithm(&key_attributes, alg);
6340 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006341
Gilles Peskine449bd832023-01-11 14:50:10 +01006342 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6343 if (status != PSA_SUCCESS) {
6344 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6345 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006346 }
6347
Gilles Peskine449bd832023-01-11 14:50:10 +01006348 status = setup_psa_key_derivation(&derivation,
6349 master_key, alg,
6350 NULL, 0,
6351 random, rlen,
6352 (unsigned char const *) label,
6353 (size_t) strlen(label),
6354 NULL, 0,
6355 dlen);
6356 if (status != PSA_SUCCESS) {
6357 psa_key_derivation_abort(&derivation);
6358 psa_destroy_key(master_key);
6359 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006360 }
6361
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6363 if (status != PSA_SUCCESS) {
6364 psa_key_derivation_abort(&derivation);
6365 psa_destroy_key(master_key);
6366 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006367 }
6368
Gilles Peskine449bd832023-01-11 14:50:10 +01006369 status = psa_key_derivation_abort(&derivation);
6370 if (status != PSA_SUCCESS) {
6371 psa_destroy_key(master_key);
6372 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006373 }
6374
Gilles Peskine449bd832023-01-11 14:50:10 +01006375 if (!mbedtls_svc_key_id_is_null(master_key)) {
6376 status = psa_destroy_key(master_key);
6377 }
6378 if (status != PSA_SUCCESS) {
6379 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6380 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006381
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006383}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006384#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006385
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006386#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006387MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006388static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6389 const char *label,
6390 const unsigned char *random, size_t rlen,
6391 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006392{
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6394 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006395}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006396#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006397
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006398#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006400static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6401 const char *label,
6402 const unsigned char *random, size_t rlen,
6403 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006404{
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6406 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006407}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006408#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006409
Jerry Yuf009d862022-02-17 14:01:37 +08006410/*
6411 * Set appropriate PRF function and other SSL / TLS1.2 functions
6412 *
6413 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006414 * - hash associated with the ciphersuite (only used by TLS 1.2)
6415 *
6416 * Outputs:
6417 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6418 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006419MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006420static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6421 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006422{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006423#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006425 handshake->tls_prf = tls_prf_sha384;
6426 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6427 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006429#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006430#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006431 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006432 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006433 handshake->tls_prf = tls_prf_sha256;
6434 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6435 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6436 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006437#else
Jerry Yuf009d862022-02-17 14:01:37 +08006438 {
Jerry Yuf009d862022-02-17 14:01:37 +08006439 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006440 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006442 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006443#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006444
Gilles Peskine449bd832023-01-11 14:50:10 +01006445 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006446}
Jerry Yud6ab2352022-02-17 14:03:43 +08006447
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006448/*
6449 * Compute master secret if needed
6450 *
6451 * Parameters:
6452 * [in/out] handshake
6453 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6454 * (PSA-PSK) ciphersuite_info, psk_opaque
6455 * [out] premaster (cleared)
6456 * [out] master
6457 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6458 * debug: conf->f_dbg, conf->p_dbg
6459 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006460 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006461 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006462MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006463static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6464 unsigned char *master,
6465 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006466{
6467 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6468
6469 /* cf. RFC 5246, Section 8.1:
6470 * "The master secret is always exactly 48 bytes in length." */
6471 size_t const master_secret_len = 48;
6472
6473#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6474 unsigned char session_hash[48];
6475#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6476
6477 /* The label for the KDF used for key expansion.
6478 * This is either "master secret" or "extended master secret"
6479 * depending on whether the Extended Master Secret extension
6480 * is used. */
6481 char const *lbl = "master secret";
6482
Przemek Stekielae4ed302022-04-05 17:15:55 +02006483 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006484 * - If the Extended Master Secret extension is not used,
6485 * this is ClientHello.Random + ServerHello.Random
6486 * (see Sect. 8.1 in RFC 5246).
6487 * - If the Extended Master Secret extension is used,
6488 * this is the transcript of the handshake so far.
6489 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006490 unsigned char const *seed = handshake->randbytes;
6491 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006492
6493#if !defined(MBEDTLS_DEBUG_C) && \
6494 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006495 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006496 ssl = NULL; /* make sure we don't use it except for those cases */
6497 (void) ssl;
6498#endif
6499
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 if (handshake->resume != 0) {
6501 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6502 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006503 }
6504
6505#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006507 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006508 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006509 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6510 if (ret != 0) {
6511 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6512 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006513
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6515 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006516 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006517#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006518
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006519#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006521 /* Perform PSK-to-MS expansion in a single step. */
6522 psa_status_t status;
6523 psa_algorithm_t alg;
6524 mbedtls_svc_key_id_t psk;
6525 psa_key_derivation_operation_t derivation =
6526 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006527 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006528
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006530
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006532
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006534 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006536 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006538
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006539 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006540 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006541
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006543 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006544 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006545 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006546 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006547 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6548 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6549 other_secret = handshake->premaster + 2;
6550 break;
6551 default:
6552 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006553 }
6554
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 status = setup_psa_key_derivation(&derivation, psk, alg,
6556 ssl->conf->psk, ssl->conf->psk_len,
6557 seed, seed_len,
6558 (unsigned char const *) lbl,
6559 (size_t) strlen(lbl),
6560 other_secret, other_secret_len,
6561 master_secret_len);
6562 if (status != PSA_SUCCESS) {
6563 psa_key_derivation_abort(&derivation);
6564 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006565 }
6566
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 status = psa_key_derivation_output_bytes(&derivation,
6568 master,
6569 master_secret_len);
6570 if (status != PSA_SUCCESS) {
6571 psa_key_derivation_abort(&derivation);
6572 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006573 }
6574
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 status = psa_key_derivation_abort(&derivation);
6576 if (status != PSA_SUCCESS) {
6577 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6578 }
6579 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006580#endif
6581 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006582#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006583 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006584 psa_status_t status;
6585 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6586 psa_key_derivation_operation_t derivation =
6587 PSA_KEY_DERIVATION_OPERATION_INIT;
6588
Gilles Peskine449bd832023-01-11 14:50:10 +01006589 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006590
6591 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6592
Gilles Peskine449bd832023-01-11 14:50:10 +01006593 status = psa_key_derivation_setup(&derivation, alg);
6594 if (status != PSA_SUCCESS) {
6595 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006596 }
6597
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 status = psa_key_derivation_set_capacity(&derivation,
6599 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6600 if (status != PSA_SUCCESS) {
6601 psa_key_derivation_abort(&derivation);
6602 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006603 }
6604
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6606 &derivation);
6607 if (status != PSA_SUCCESS) {
6608 psa_key_derivation_abort(&derivation);
6609 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006610 }
6611
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 status = psa_key_derivation_output_bytes(&derivation,
6613 handshake->premaster,
6614 handshake->pmslen);
6615 if (status != PSA_SUCCESS) {
6616 psa_key_derivation_abort(&derivation);
6617 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6618 }
6619
6620 status = psa_key_derivation_abort(&derivation);
6621 if (status != PSA_SUCCESS) {
6622 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006623 }
6624 }
6625#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6627 lbl, seed, seed_len,
6628 master,
6629 master_secret_len);
6630 if (ret != 0) {
6631 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6632 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006633 }
6634
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6636 handshake->premaster,
6637 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006638
Gilles Peskine449bd832023-01-11 14:50:10 +01006639 mbedtls_platform_zeroize(handshake->premaster,
6640 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006641 }
6642
Gilles Peskine449bd832023-01-11 14:50:10 +01006643 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006644}
6645
Gilles Peskine449bd832023-01-11 14:50:10 +01006646int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006647{
6648 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6649 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6650 ssl->handshake->ciphersuite_info;
6651
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006653
6654 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006655 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006656 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006657 if (ret != 0) {
6658 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6659 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006660 }
6661
6662 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 ret = ssl_compute_master(ssl->handshake,
6664 ssl->session_negotiate->master,
6665 ssl);
6666 if (ret != 0) {
6667 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6668 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006669 }
6670
6671 /* Swap the client and server random values:
6672 * - MS derivation wanted client+server (RFC 5246 8.1)
6673 * - key derivation wants server+client (RFC 5246 6.3) */
6674 {
6675 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006676 memcpy(tmp, ssl->handshake->randbytes, 64);
6677 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6678 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6679 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006680 }
6681
6682 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6684 ssl->session_negotiate->ciphersuite,
6685 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006686#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006688#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006689 ssl->handshake->tls_prf,
6690 ssl->handshake->randbytes,
6691 ssl->tls_version,
6692 ssl->conf->endpoint,
6693 ssl);
6694 if (ret != 0) {
6695 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6696 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006697 }
6698
6699 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6701 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006702
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006704
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006706}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006707
Gilles Peskine449bd832023-01-11 14:50:10 +01006708int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006709{
Gilles Peskine449bd832023-01-11 14:50:10 +01006710 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006711#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006712 case MBEDTLS_SSL_HASH_SHA384:
6713 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6714 break;
6715#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006716#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006717 case MBEDTLS_SSL_HASH_SHA256:
6718 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6719 break;
6720#endif
6721 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006722 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006723 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006724#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006725 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006726 (void) ssl;
6727#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006729}
6730
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006731static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6732 const psa_hash_operation_t *hs_op,
6733 size_t buffer_size,
6734 unsigned char *hash,
6735 size_t *hlen)
6736{
6737 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006738 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006739
6740#if !defined(MBEDTLS_DEBUG_C)
6741 (void) ssl;
6742#endif
6743 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006744 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006745 if (status != PSA_SUCCESS) {
6746 goto exit;
6747 }
6748
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006749 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006750 if (status != PSA_SUCCESS) {
6751 goto exit;
6752 }
6753
6754 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6755 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6756
6757exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006758 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006759 return mbedtls_md_error_from_psa(status);
6760}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006761
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006762#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006763int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6764 unsigned char *hash,
6765 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006766{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006767 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6768 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006769}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006770#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006771
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006772#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006773int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6774 unsigned char *hash,
6775 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006776{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006777 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6778 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006779}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006780#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006781
Jerry Yuc2c673d2022-02-17 14:20:39 +08006782#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006783MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006784static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006785
6786#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006787int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006788{
6789 /* If renegotiation is not enforced, retransmit until we would reach max
6790 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006792 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6793 unsigned char doublings = 1;
6794
Gilles Peskine449bd832023-01-11 14:50:10 +01006795 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006796 ++doublings;
6797 ratio >>= 1;
6798 }
6799
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 if (++ssl->renego_records_seen > doublings) {
6801 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6802 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006803 }
6804 }
6805
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006807}
6808#endif
6809#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006810
Jerry Yud9526692022-02-17 14:23:47 +08006811/*
6812 * Handshake functions
6813 */
6814#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6815/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006816int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006817{
6818 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6819 ssl->handshake->ciphersuite_info;
6820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006822
Gilles Peskine449bd832023-01-11 14:50:10 +01006823 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6824 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006825 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006827 }
6828
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6830 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006831}
6832
Gilles Peskine449bd832023-01-11 14:50:10 +01006833int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006834{
6835 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6836 ssl->handshake->ciphersuite_info;
6837
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006839
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6841 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006842 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006844 }
6845
Gilles Peskine449bd832023-01-11 14:50:10 +01006846 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6847 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006848}
6849
6850#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6851/* Some certificate support -> implement write and parse */
6852
Gilles Peskine449bd832023-01-11 14:50:10 +01006853int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006854{
6855 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6856 size_t i, n;
6857 const mbedtls_x509_crt *crt;
6858 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6859 ssl->handshake->ciphersuite_info;
6860
Gilles Peskine449bd832023-01-11 14:50:10 +01006861 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006862
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6864 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006865 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006866 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006867 }
6868
6869#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6871 if (ssl->handshake->client_auth == 0) {
6872 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006873 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006875 }
6876 }
6877#endif /* MBEDTLS_SSL_CLI_C */
6878#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6880 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006881 /* Should never happen because we shouldn't have picked the
6882 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006884 }
6885 }
6886#endif
6887
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006889
6890 /*
6891 * 0 . 0 handshake type
6892 * 1 . 3 handshake length
6893 * 4 . 6 length of all certs
6894 * 7 . 9 length of cert. 1
6895 * 10 . n-1 peer certificate
6896 * n . n+2 length of cert. 2
6897 * n+3 . ... upper level cert, etc.
6898 */
6899 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006900 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006901
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006903 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6905 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6906 " > %" MBEDTLS_PRINTF_SIZET,
6907 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6908 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006909 }
6910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6912 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6913 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006914
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006916 i += n; crt = crt->next;
6917 }
6918
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6920 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6921 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006922
6923 ssl->out_msglen = i;
6924 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6925 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6926
6927 ssl->state++;
6928
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6930 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6931 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006932 }
6933
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006935
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006937}
6938
6939#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6940
6941#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006942MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006943static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6944 unsigned char *crt_buf,
6945 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006946{
6947 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6948
Gilles Peskine449bd832023-01-11 14:50:10 +01006949 if (peer_crt == NULL) {
6950 return -1;
6951 }
Jerry Yud9526692022-02-17 14:23:47 +08006952
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 if (peer_crt->raw.len != crt_buf_len) {
6954 return -1;
6955 }
Jerry Yud9526692022-02-17 14:23:47 +08006956
Gilles Peskine449bd832023-01-11 14:50:10 +01006957 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006958}
6959#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006960MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006961static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6962 unsigned char *crt_buf,
6963 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006964{
6965 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6966 unsigned char const * const peer_cert_digest =
6967 ssl->session->peer_cert_digest;
6968 mbedtls_md_type_t const peer_cert_digest_type =
6969 ssl->session->peer_cert_digest_type;
6970 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006972 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6973 size_t digest_len;
6974
Gilles Peskine449bd832023-01-11 14:50:10 +01006975 if (peer_cert_digest == NULL || digest_info == NULL) {
6976 return -1;
6977 }
Jerry Yud9526692022-02-17 14:23:47 +08006978
Gilles Peskine449bd832023-01-11 14:50:10 +01006979 digest_len = mbedtls_md_get_size(digest_info);
6980 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6981 return -1;
6982 }
Jerry Yud9526692022-02-17 14:23:47 +08006983
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6985 if (ret != 0) {
6986 return -1;
6987 }
Jerry Yud9526692022-02-17 14:23:47 +08006988
Gilles Peskine449bd832023-01-11 14:50:10 +01006989 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006990}
6991#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6992#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6993
6994/*
6995 * Once the certificate message is read, parse it into a cert chain and
6996 * perform basic checks, but leave actual verification to the caller
6997 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006998MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006999static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7000 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007001{
7002 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7003#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007004 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007005#endif
7006 size_t i, n;
7007 uint8_t alert;
7008
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7010 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7011 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7012 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7013 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007014 }
7015
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7017 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7018 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7019 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007020 }
7021
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7023 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7024 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7025 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7026 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007027 }
7028
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007030
7031 /*
7032 * Same message structure as in mbedtls_ssl_write_certificate()
7033 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007034 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007035
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 if (ssl->in_msg[i] != 0 ||
7037 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7038 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7039 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7040 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7041 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007042 }
7043
7044 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7045 i += 3;
7046
7047 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007049 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007050 if (i + 3 > ssl->in_hslen) {
7051 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7052 mbedtls_ssl_send_alert_message(ssl,
7053 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7054 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7055 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007056 }
7057 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7058 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 if (ssl->in_msg[i] != 0) {
7060 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7061 mbedtls_ssl_send_alert_message(ssl,
7062 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7063 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7064 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007065 }
7066
7067 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007068 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007069 i += 3;
7070
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 if (n < 128 || i + n > ssl->in_hslen) {
7072 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7073 mbedtls_ssl_send_alert_message(ssl,
7074 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7075 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7076 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007077 }
7078
7079 /* Check if we're handling the first CRT in the chain. */
7080#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007082 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007084 /* During client-side renegotiation, check that the server's
7085 * end-CRTs hasn't changed compared to the initial handshake,
7086 * mitigating the triple handshake attack. On success, reuse
7087 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7089 if (ssl_check_peer_crt_unchanged(ssl,
7090 &ssl->in_msg[i],
7091 n) != 0) {
7092 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7093 mbedtls_ssl_send_alert_message(ssl,
7094 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7095 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7096 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007097 }
7098
7099 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007101 }
7102#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7103
7104 /* Parse the next certificate in the chain. */
7105#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007107#else
7108 /* If we don't need to store the CRT chain permanently, parse
7109 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007111#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007113 case 0: /*ok*/
7114 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7115 /* Ignore certificate with an unknown algorithm: maybe a
7116 prior certificate was already trusted. */
7117 break;
7118
7119 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7120 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7121 goto crt_parse_der_failed;
7122
7123 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7124 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7125 goto crt_parse_der_failed;
7126
7127 default:
7128 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007129crt_parse_der_failed:
7130 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7131 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7132 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007133 }
7134
7135 i += n;
7136 }
7137
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7139 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007140}
7141
7142#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007143MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007144static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007145{
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7147 return -1;
7148 }
Jerry Yud9526692022-02-17 14:23:47 +08007149
Gilles Peskine449bd832023-01-11 14:50:10 +01007150 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007151 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7152 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007153 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7154 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7155 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007156 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007158}
7159#endif /* MBEDTLS_SSL_SRV_C */
7160
7161/* Check if a certificate message is expected.
7162 * Return either
7163 * - SSL_CERTIFICATE_EXPECTED, or
7164 * - SSL_CERTIFICATE_SKIP
7165 * indicating whether a Certificate message is expected or not.
7166 */
7167#define SSL_CERTIFICATE_EXPECTED 0
7168#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007169MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007170static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7171 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007172{
7173 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7174 ssl->handshake->ciphersuite_info;
7175
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7177 return SSL_CERTIFICATE_SKIP;
7178 }
Jerry Yud9526692022-02-17 14:23:47 +08007179
7180#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007181 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007183 ssl->session_negotiate->verify_result =
7184 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007186 }
7187 }
7188#else
7189 ((void) authmode);
7190#endif /* MBEDTLS_SSL_SRV_C */
7191
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007193}
7194
Jerry Yud9526692022-02-17 14:23:47 +08007195#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007196MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007197static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7198 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007199{
7200 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7201 /* Remember digest of the peer's end-CRT. */
7202 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7204 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7205 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7206 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7207 mbedtls_ssl_send_alert_message(ssl,
7208 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7209 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007210
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007212 }
7213
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 ret = mbedtls_md(mbedtls_md_info_from_type(
7215 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7216 start, len,
7217 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007218
7219 ssl->session_negotiate->peer_cert_digest_type =
7220 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7221 ssl->session_negotiate->peer_cert_digest_len =
7222 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7223
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007225}
7226
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007227MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007228static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7229 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007230{
7231 unsigned char *end = start + len;
7232 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7233
7234 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007235 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7236 ret = mbedtls_pk_parse_subpubkey(&start, end,
7237 &ssl->handshake->peer_pubkey);
7238 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007239 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007240 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007241 }
7242
Gilles Peskine449bd832023-01-11 14:50:10 +01007243 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007244}
7245#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7246
Gilles Peskine449bd832023-01-11 14:50:10 +01007247int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007248{
7249 int ret = 0;
7250 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007251 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007252#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7253 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7254 ? ssl->handshake->sni_authmode
7255 : ssl->conf->authmode;
7256#else
7257 const int authmode = ssl->conf->authmode;
7258#endif
7259 void *rs_ctx = NULL;
7260 mbedtls_x509_crt *chain = NULL;
7261
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007263
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7265 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7266 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007267 goto exit;
7268 }
7269
7270#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 if (ssl->handshake->ecrs_enabled &&
7272 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007273 chain = ssl->handshake->ecrs_peer_cert;
7274 ssl->handshake->ecrs_peer_cert = NULL;
7275 goto crt_verify;
7276 }
7277#endif
7278
Gilles Peskine449bd832023-01-11 14:50:10 +01007279 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007280 /* mbedtls_ssl_read_record may have sent an alert already. We
7281 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007282 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007283 goto exit;
7284 }
7285
7286#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007288 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7289
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007291 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007292 }
Jerry Yud9526692022-02-17 14:23:47 +08007293
7294 goto exit;
7295 }
7296#endif /* MBEDTLS_SSL_SRV_C */
7297
7298 /* Clear existing peer CRT structure in case we tried to
7299 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007300 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007301
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7303 if (chain == NULL) {
7304 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7305 sizeof(mbedtls_x509_crt)));
7306 mbedtls_ssl_send_alert_message(ssl,
7307 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7308 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007309
7310 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7311 goto exit;
7312 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007313 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007314
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 ret = ssl_parse_certificate_chain(ssl, chain);
7316 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007317 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007318 }
Jerry Yud9526692022-02-17 14:23:47 +08007319
7320#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007321 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007322 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 }
Jerry Yud9526692022-02-17 14:23:47 +08007324
7325crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007326 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007327 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 }
Jerry Yud9526692022-02-17 14:23:47 +08007329#endif
7330
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007331 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7332 ssl->handshake->ciphersuite_info,
7333 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007335 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 }
Jerry Yud9526692022-02-17 14:23:47 +08007337
7338#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7339 {
7340 unsigned char *crt_start, *pk_start;
7341 size_t crt_len, pk_len;
7342
7343 /* We parse the CRT chain without copying, so
7344 * these pointers point into the input buffer,
7345 * and are hence still valid after freeing the
7346 * CRT chain. */
7347
7348 crt_start = chain->raw.p;
7349 crt_len = chain->raw.len;
7350
7351 pk_start = chain->pk_raw.p;
7352 pk_len = chain->pk_raw.len;
7353
7354 /* Free the CRT structures before computing
7355 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 mbedtls_x509_crt_free(chain);
7357 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007358 chain = NULL;
7359
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7361 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007362 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007363 }
Jerry Yud9526692022-02-17 14:23:47 +08007364
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7366 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007367 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007368 }
Jerry Yud9526692022-02-17 14:23:47 +08007369 }
7370#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7371 /* Pass ownership to session structure. */
7372 ssl->session_negotiate->peer_cert = chain;
7373 chain = NULL;
7374#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7375
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007377
7378exit:
7379
Gilles Peskine449bd832023-01-11 14:50:10 +01007380 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007381 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 }
Jerry Yud9526692022-02-17 14:23:47 +08007383
7384#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007385 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007386 ssl->handshake->ecrs_peer_cert = chain;
7387 chain = NULL;
7388 }
7389#endif
7390
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 if (chain != NULL) {
7392 mbedtls_x509_crt_free(chain);
7393 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007394 }
7395
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007397}
7398#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7399
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007400static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7401 unsigned char *padbuf, size_t hlen,
7402 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007403{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007404 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007405 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007406 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007407 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007408 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007409 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007410
7411 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007413 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007415
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007417 ? "client finished"
7418 : "server finished";
7419
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007420 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007421
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007422 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007424 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007425 }
7426
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007427 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007429 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007430 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007431 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007432
7433 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7434
Jerry Yu615bd6f2022-02-17 14:25:15 +08007435 /*
7436 * TLSv1.2:
7437 * hash = PRF( master, finished_label,
7438 * Hash( handshake ) )[0.11]
7439 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007441 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007442
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007444
Paul Elliottecb95be2023-08-11 16:41:04 +01007445 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007446
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007447 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007448
7449exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007450 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007451 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007452}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007453
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007454#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007455static int ssl_calc_finished_tls_sha256(
7456 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7457{
7458 unsigned char padbuf[32];
7459 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007460 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007461 padbuf, sizeof(padbuf),
7462 buf, from);
7463}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007464#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007465
Jerry Yub7ba49e2022-02-17 14:25:53 +08007466
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007467#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007468static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007470{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007471 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007472 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007473 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007474 padbuf, sizeof(padbuf),
7475 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007476}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007477#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007478
Gilles Peskine449bd832023-01-11 14:50:10 +01007479void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007480{
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 /*
7484 * Free our handshake params
7485 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 mbedtls_ssl_handshake_free(ssl);
7487 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007488 ssl->handshake = NULL;
7489
7490 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007491 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007492 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 if (ssl->transform) {
7494 mbedtls_ssl_transform_free(ssl->transform);
7495 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007496 }
7497 ssl->transform = ssl->transform_negotiate;
7498 ssl->transform_negotiate = NULL;
7499
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007501}
7502
Gilles Peskine449bd832023-01-11 14:50:10 +01007503void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007504{
7505 int resume = ssl->handshake->resume;
7506
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007508
7509#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007511 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7512 ssl->renego_records_seen = 0;
7513 }
7514#endif
7515
7516 /*
7517 * Free the previous session and switch in the current one
7518 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007519 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007520#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7521 /* RFC 7366 3.1: keep the EtM state */
7522 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007524#endif
7525
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 mbedtls_ssl_session_free(ssl->session);
7527 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007528 }
7529 ssl->session = ssl->session_negotiate;
7530 ssl->session_negotiate = NULL;
7531
7532 /*
7533 * Add cache entry
7534 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007536 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 resume == 0) {
7538 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7539 ssl->session->id,
7540 ssl->session->id_len,
7541 ssl->session) != 0) {
7542 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7543 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007544 }
7545
7546#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7548 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007549 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007551
7552 /* Keep last flight around in case we need to resend it:
7553 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7555 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007556#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007558
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007559 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007560
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007562}
7563
Gilles Peskine449bd832023-01-11 14:50:10 +01007564int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007565{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007566 int ret;
7567 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007568
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007570
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007572
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007573 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7574 if (ret != 0) {
7575 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7576 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007577
7578 /*
7579 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7580 * may define some other value. Currently (early 2016), no defined
7581 * ciphersuite does this (and this is unlikely to change as activity has
7582 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7583 */
7584 hash_len = 12;
7585
7586#if defined(MBEDTLS_SSL_RENEGOTIATION)
7587 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007589#endif
7590
7591 ssl->out_msglen = 4 + hash_len;
7592 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7593 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7594
7595 /*
7596 * In case of session resuming, invert the client and server
7597 * ChangeCipherSpec messages order.
7598 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007600#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007602 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007604#endif
7605#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007607 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007609#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007611 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007613
7614 /*
7615 * Switch to our negotiated transform and session parameters for outbound
7616 * data.
7617 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007619
7620#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007622 unsigned char i;
7623
7624 /* Remember current epoch settings for resending */
7625 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7627 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007628
7629 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007631
7632
7633 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 for (i = 2; i > 0; i--) {
7635 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007636 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 }
7638 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007639
7640 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 if (i == 0) {
7642 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7643 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007644 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007646#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007648
7649 ssl->transform_out = ssl->transform_negotiate;
7650 ssl->session_out = ssl->session_negotiate;
7651
7652#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7654 mbedtls_ssl_send_flight_completed(ssl);
7655 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007656#endif
7657
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7659 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7660 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007661 }
7662
7663#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7665 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7666 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7667 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007668 }
7669#endif
7670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007672
Gilles Peskine449bd832023-01-11 14:50:10 +01007673 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007674}
7675
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007676#define SSL_MAX_HASH_LEN 12
7677
Gilles Peskine449bd832023-01-11 14:50:10 +01007678int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007679{
7680 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7681 unsigned int hash_len = 12;
7682 unsigned char buf[SSL_MAX_HASH_LEN];
7683
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007685
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007686 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7687 if (ret != 0) {
7688 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7689 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007690
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7692 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007693 goto exit;
7694 }
7695
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7697 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7698 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7699 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007700 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7701 goto exit;
7702 }
7703
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7705 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7706 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007707 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7708 goto exit;
7709 }
7710
Gilles Peskine449bd832023-01-11 14:50:10 +01007711 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7712 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7713 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7714 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007715 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7716 goto exit;
7717 }
7718
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7720 buf, hash_len) != 0) {
7721 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7722 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7723 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007724 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7725 goto exit;
7726 }
7727
7728#if defined(MBEDTLS_SSL_RENEGOTIATION)
7729 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007731#endif
7732
Gilles Peskine449bd832023-01-11 14:50:10 +01007733 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007734#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007735 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007736 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007738#endif
7739#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007740 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007741 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007742 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007743#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007744 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007745 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007746 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007747
7748#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007749 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7750 mbedtls_ssl_recv_flight_completed(ssl);
7751 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007752#endif
7753
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007755
7756exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007757 mbedtls_platform_zeroize(buf, hash_len);
7758 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007759}
7760
Jerry Yu392112c2022-02-17 14:34:10 +08007761#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7762/*
7763 * Helper to get TLS 1.2 PRF from ciphersuite
7764 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7765 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007766static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007767{
Jerry Yu392112c2022-02-17 14:34:10 +08007768 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007769 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007770#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7772 return tls_prf_sha384;
7773 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007774#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007775#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007776 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007777 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7778 return tls_prf_sha256;
7779 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007780 }
7781#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007782#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007783 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007784 (void) ciphersuite_info;
7785#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007786
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007788}
7789#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007790
Gilles Peskine449bd832023-01-11 14:50:10 +01007791static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007792{
7793 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007794#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007795 if (tls_prf == tls_prf_sha384) {
7796 return MBEDTLS_SSL_TLS_PRF_SHA384;
7797 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007798#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007799#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 if (tls_prf == tls_prf_sha256) {
7801 return MBEDTLS_SSL_TLS_PRF_SHA256;
7802 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007803#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007805}
7806
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007807/*
7808 * Populate a transform structure with session keys and all the other
7809 * necessary information.
7810 *
7811 * Parameters:
7812 * - [in/out]: transform: structure to populate
7813 * [in] must be just initialised with mbedtls_ssl_transform_init()
7814 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7815 * - [in] ciphersuite
7816 * - [in] master
7817 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007818 * - [in] tls_prf: pointer to PRF to use for key derivation
7819 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007820 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007821 * - [in] endpoint: client or server
7822 * - [in] ssl: used for:
7823 * - ssl->conf->{f,p}_export_keys
7824 * [in] optionally used for:
7825 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7826 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007827MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007828static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7829 int ciphersuite,
7830 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007831#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007833#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007834 ssl_tls_prf_t tls_prf,
7835 const unsigned char randbytes[64],
7836 mbedtls_ssl_protocol_version tls_version,
7837 unsigned endpoint,
7838 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007839{
7840 int ret = 0;
7841 unsigned char keyblk[256];
7842 unsigned char *key1;
7843 unsigned char *key2;
7844 unsigned char *mac_enc;
7845 unsigned char *mac_dec;
7846 size_t mac_key_len = 0;
7847 size_t iv_copy_len;
7848 size_t keylen;
7849 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007850 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007851
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007852 psa_key_type_t key_type;
7853 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7854 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007855 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007856 size_t key_bits;
7857 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007858
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007859 /*
7860 * Some data just needs copying into the structure
7861 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007862#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007863 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007864#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007865 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007866
7867#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007868 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007869#endif
7870
7871#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007873 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7874 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007875 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007876 }
7877#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7878
7879 /*
7880 * Get various info structures
7881 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007882 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7883 if (ciphersuite_info == NULL) {
7884 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7885 ciphersuite));
7886 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007887 }
7888
Neil Armstrongab555e02022-04-04 11:07:59 +02007889 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007890#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007891 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007892#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007894
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007896 transform->taglen =
7897 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007899
Dave Rodgman2eab4622023-10-05 13:30:37 +01007900 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 transform->taglen,
7902 &alg,
7903 &key_type,
7904 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007905 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007907 goto end;
7908 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007909
Dave Rodgman2eab4622023-10-05 13:30:37 +01007910 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007911 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007912 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 (unsigned) ciphersuite_info->mac));
7914 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007915 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007916
7917#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7918 /* Copy own and peer's CID if the use of the CID
7919 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7921 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007922
7923 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7925 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7926 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007927
7928 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7930 ssl->handshake->peer_cid_len);
7931 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7932 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007933 }
7934#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7935
7936 /*
7937 * Compute key block using the PRF
7938 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007939 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7940 if (ret != 0) {
7941 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7942 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007943 }
7944
Gilles Peskine449bd832023-01-11 14:50:10 +01007945 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7946 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7947 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7948 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7949 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007950
7951 /*
7952 * Determine the appropriate key, IV and MAC length.
7953 */
7954
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007955 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007956
Valerio Settie5707042023-10-11 11:54:42 +02007957#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007959 size_t explicit_ivlen;
7960
7961 transform->maclen = 0;
7962 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007963
7964 /* All modes haves 96-bit IVs, but the length of the static parts vary
7965 * with mode and version:
7966 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7967 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7968 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7969 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7970 * sequence number).
7971 */
7972 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007973
7974 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007976
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007978 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007979 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007980 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007982
7983 /* Minimum length of encrypted record */
7984 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7985 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 } else
Valerio Settie5707042023-10-11 11:54:42 +02007987#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007988#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007990 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007992 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007993
Neil Armstronge4512952022-03-08 09:08:22 +01007994 /* Get MAC length */
7995 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007996 transform->maclen = mac_key_len;
7997
7998 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008000
8001 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008002 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008003 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008004 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008005 /*
8006 * GenericBlockCipher:
8007 * 1. if EtM is in use: one block plus MAC
8008 * otherwise: * first multiple of blocklen greater than maclen
8009 * 2. IV
8010 */
8011#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008013 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 + block_size;
8015 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008016#endif
8017 {
8018 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 + block_size
8020 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008021 }
8022
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008024 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 } else {
8026 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008027 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8028 goto end;
8029 }
8030 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008032#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8033 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8035 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008036 }
8037
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8039 (unsigned) keylen,
8040 (unsigned) transform->minlen,
8041 (unsigned) transform->ivlen,
8042 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008043
8044 /*
8045 * Finally setup the cipher contexts, IVs and MAC secrets.
8046 */
8047#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008049 key1 = keyblk + mac_key_len * 2;
8050 key2 = keyblk + mac_key_len * 2 + keylen;
8051
8052 mac_enc = keyblk;
8053 mac_dec = keyblk + mac_key_len;
8054
Gilles Peskine449bd832023-01-11 14:50:10 +01008055 iv_copy_len = (transform->fixed_ivlen) ?
8056 transform->fixed_ivlen : transform->ivlen;
8057 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8058 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8059 iv_copy_len);
8060 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008061#endif /* MBEDTLS_SSL_CLI_C */
8062#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008064 key1 = keyblk + mac_key_len * 2 + keylen;
8065 key2 = keyblk + mac_key_len * 2;
8066
8067 mac_enc = keyblk + mac_key_len;
8068 mac_dec = keyblk;
8069
Gilles Peskine449bd832023-01-11 14:50:10 +01008070 iv_copy_len = (transform->fixed_ivlen) ?
8071 transform->fixed_ivlen : transform->ivlen;
8072 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8073 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8074 iv_copy_len);
8075 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008076#endif /* MBEDTLS_SSL_SRV_C */
8077 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008079 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8080 goto end;
8081 }
8082
Paul Elliott4fb19552023-10-18 12:15:30 +01008083 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 ssl->f_export_keys(ssl->p_export_keys,
8085 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8086 master, 48,
8087 randbytes + 32,
8088 randbytes,
8089 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008090 }
8091
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008092 transform->psa_alg = alg;
8093
Gilles Peskine449bd832023-01-11 14:50:10 +01008094 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8095 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8096 psa_set_key_algorithm(&attributes, alg);
8097 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008098
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 if ((status = psa_import_key(&attributes,
8100 key1,
8101 PSA_BITS_TO_BYTES(key_bits),
8102 &transform->psa_key_enc)) != PSA_SUCCESS) {
8103 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008104 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008105 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008106 goto end;
8107 }
8108
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008110
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 if ((status = psa_import_key(&attributes,
8112 key2,
8113 PSA_BITS_TO_BYTES(key_bits),
8114 &transform->psa_key_dec)) != 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_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008117 goto end;
8118 }
8119 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008120
Neil Armstrong29c0c042022-03-17 17:47:28 +01008121#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8122 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8123 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008124 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008126
Gilles Peskine449bd832023-01-11 14:50:10 +01008127 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8128 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8129 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008130
Gilles Peskine449bd832023-01-11 14:50:10 +01008131 if ((status = psa_import_key(&attributes,
8132 mac_enc, mac_key_len,
8133 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008134 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008135 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008136 goto end;
8137 }
8138
Gilles Peskine449bd832023-01-11 14:50:10 +01008139 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8140 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008141#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008143#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008144 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008145 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8147 PSA_KEY_USAGE_VERIFY_HASH);
8148 } else {
8149 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8150 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008151
Gilles Peskine449bd832023-01-11 14:50:10 +01008152 if ((status = psa_import_key(&attributes,
8153 mac_dec, mac_key_len,
8154 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008155 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008156 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008157 goto end;
8158 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008159 }
8160#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8161
8162 ((void) mac_dec);
8163 ((void) mac_enc);
8164
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008165end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008166 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8167 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008168}
8169
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008170#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008171int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008172 psa_pake_operation_t *pake_ctx,
8173 const unsigned char *buf,
8174 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008175{
8176 psa_status_t status;
8177 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008178 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008179 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8180 * At round two perform a single cycle
8181 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008182 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008183
Gilles Peskine449bd832023-01-11 14:50:10 +01008184 for (; remaining_steps > 0; remaining_steps--) {
8185 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008186 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008187 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008188 /* Length is stored at the first byte */
8189 size_t length = buf[input_offset];
8190 input_offset += 1;
8191
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008193 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8194 }
8195
Gilles Peskine449bd832023-01-11 14:50:10 +01008196 status = psa_pake_input(pake_ctx, step,
8197 buf + input_offset, length);
8198 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008199 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008200 }
8201
8202 input_offset += length;
8203 }
8204 }
8205
Gilles Peskine449bd832023-01-11 14:50:10 +01008206 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008207 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008208 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008209
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008211}
8212
Valerio Setti6b3dab02022-11-17 17:14:54 +01008213int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008214 psa_pake_operation_t *pake_ctx,
8215 unsigned char *buf,
8216 size_t len, size_t *olen,
8217 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008218{
8219 psa_status_t status;
8220 size_t output_offset = 0;
8221 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008222 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008223 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8224 * At round two perform a single cycle
8225 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008226 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008227
Gilles Peskine449bd832023-01-11 14:50:10 +01008228 for (; remaining_steps > 0; remaining_steps--) {
8229 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8230 step <= PSA_PAKE_STEP_ZK_PROOF;
8231 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008232 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008233 * For each step, prepend 1 byte with the length of the data as
8234 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008235 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008236 status = psa_pake_output(pake_ctx, step,
8237 buf + output_offset + 1,
8238 len - output_offset - 1,
8239 &output_len);
8240 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008241 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008242 }
8243
Valerio Setti99d88c12022-11-22 16:03:43 +01008244 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008245
8246 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008247 }
8248 }
8249
8250 *olen = output_offset;
8251
Gilles Peskine449bd832023-01-11 14:50:10 +01008252 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008253}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008254#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008255
Gilles Peskine449bd832023-01-11 14:50:10 +01008256int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8257 unsigned char *hash, size_t *hashlen,
8258 unsigned char *data, size_t data_len,
8259 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008260{
8261 psa_status_t status;
8262 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008263 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008264
Gilles Peskine449bd832023-01-11 14:50:10 +01008265 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008266
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 if ((status = psa_hash_setup(&hash_operation,
8268 hash_alg)) != PSA_SUCCESS) {
8269 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008270 goto exit;
8271 }
8272
Gilles Peskine449bd832023-01-11 14:50:10 +01008273 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8274 64)) != PSA_SUCCESS) {
8275 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008276 goto exit;
8277 }
8278
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 if ((status = psa_hash_update(&hash_operation,
8280 data, data_len)) != PSA_SUCCESS) {
8281 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008282 goto exit;
8283 }
8284
Gilles Peskine449bd832023-01-11 14:50:10 +01008285 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8286 hashlen)) != PSA_SUCCESS) {
8287 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8288 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008289 }
8290
8291exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 if (status != PSA_SUCCESS) {
8293 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8294 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8295 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008296 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008298 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8299 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008300 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008301 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008302 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008303 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008304 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008305 }
8306 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008308}
8309
Jerry Yuee40f9d2022-02-17 14:55:16 +08008310
Jerry Yud9d91da2022-02-17 14:57:06 +08008311#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8312
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008313/* Find the preferred hash for a given signature algorithm. */
8314unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008315 mbedtls_ssl_context *ssl,
8316 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008317{
Gabor Mezei078e8032022-04-27 21:17:56 +02008318 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008319 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008320
Gilles Peskine449bd832023-01-11 14:50:10 +01008321 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8322 return MBEDTLS_SSL_HASH_NONE;
8323 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008324
Gilles Peskine449bd832023-01-11 14:50:10 +01008325 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008326 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8328 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008329 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008330 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8331 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008332
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008333 mbedtls_md_type_t md_alg =
8334 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8335 if (md_alg == MBEDTLS_MD_NONE) {
8336 continue;
8337 }
8338
Gilles Peskine449bd832023-01-11 14:50:10 +01008339 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008340 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008341 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008342 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008343
Gilles Peskine449bd832023-01-11 14:50:10 +01008344 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8345 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8346 PSA_ALG_ECDSA(psa_hash_alg),
8347 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008348 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008349 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008350
Gilles Peskine449bd832023-01-11 14:50:10 +01008351 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8352 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8353 PSA_ALG_RSA_PKCS1V15_SIGN(
8354 psa_hash_alg),
8355 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008356 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008357 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008358 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008359
Gilles Peskine449bd832023-01-11 14:50:10 +01008360 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008361 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008362 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008363
Gilles Peskine449bd832023-01-11 14:50:10 +01008364 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008365}
8366
8367#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8368
Jerry Yudc7bd172022-02-17 13:44:15 +08008369#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8370
XiaokangQian75d40ef2022-04-20 11:05:24 +00008371int mbedtls_ssl_validate_ciphersuite(
8372 const mbedtls_ssl_context *ssl,
8373 const mbedtls_ssl_ciphersuite_t *suite_info,
8374 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008375 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008376{
8377 (void) ssl;
8378
Gilles Peskine449bd832023-01-11 14:50:10 +01008379 if (suite_info == NULL) {
8380 return -1;
8381 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008382
Gilles Peskine449bd832023-01-11 14:50:10 +01008383 if ((suite_info->min_tls_version > max_tls_version) ||
8384 (suite_info->max_tls_version < min_tls_version)) {
8385 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008386 }
8387
XiaokangQian060d8672022-04-21 09:24:56 +00008388#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008389#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008390 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008391 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008392 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008393 }
8394#endif
8395
8396 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8397#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008398 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8399 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8400 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008401 }
8402#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8403#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8404
Gilles Peskine449bd832023-01-11 14:50:10 +01008405 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008406}
8407
Ronald Crone68ab4f2022-10-05 12:46:29 +02008408#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008409/*
8410 * Function for writing a signature algorithm extension.
8411 *
8412 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8413 * value (TLS 1.3 RFC8446):
8414 * enum {
8415 * ....
8416 * ecdsa_secp256r1_sha256( 0x0403 ),
8417 * ecdsa_secp384r1_sha384( 0x0503 ),
8418 * ecdsa_secp521r1_sha512( 0x0603 ),
8419 * ....
8420 * } SignatureScheme;
8421 *
8422 * struct {
8423 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8424 * } SignatureSchemeList;
8425 *
8426 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8427 * value (TLS 1.2 RFC5246):
8428 * enum {
8429 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8430 * sha512(6), (255)
8431 * } HashAlgorithm;
8432 *
8433 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8434 * SignatureAlgorithm;
8435 *
8436 * struct {
8437 * HashAlgorithm hash;
8438 * SignatureAlgorithm signature;
8439 * } SignatureAndHashAlgorithm;
8440 *
8441 * SignatureAndHashAlgorithm
8442 * supported_signature_algorithms<2..2^16-2>;
8443 *
8444 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8445 * generalization of the TLS 1.2 signature algorithm extension.
8446 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8447 * `SignatureScheme` field of TLS 1.3
8448 *
8449 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008450int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8451 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008452{
8453 unsigned char *p = buf;
8454 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8455 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8456
8457 *out_len = 0;
8458
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008460
8461 /* Check if we have space for header and length field:
8462 * - extension_type (2 bytes)
8463 * - extension_data_length (2 bytes)
8464 * - supported_signature_algorithms_length (2 bytes)
8465 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008466 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008467 p += 6;
8468
8469 /*
8470 * Write supported_signature_algorithms
8471 */
8472 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008473 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8474 if (sig_alg == NULL) {
8475 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8476 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008477
Gilles Peskine449bd832023-01-11 14:50:10 +01008478 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8479 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8480 *sig_alg,
8481 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8482 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008483 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008484 }
8485 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8486 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008487 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008488 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8489 *sig_alg,
8490 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008491 }
8492
8493 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008494 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 if (supported_sig_alg_len == 0) {
8496 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8497 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008498 }
8499
Gilles Peskine449bd832023-01-11 14:50:10 +01008500 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8501 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8502 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008503
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008504 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008505
8506#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008508#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008509
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008511}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008512#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008513
XiaokangQian40a35232022-05-07 09:02:40 +00008514#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008515/*
8516 * mbedtls_ssl_parse_server_name_ext
8517 *
8518 * Structure of server_name extension:
8519 *
8520 * enum {
8521 * host_name(0), (255)
8522 * } NameType;
8523 * opaque HostName<1..2^16-1>;
8524 *
8525 * struct {
8526 * NameType name_type;
8527 * select (name_type) {
8528 * case host_name: HostName;
8529 * } name;
8530 * } ServerName;
8531 * struct {
8532 * ServerName server_name_list<1..2^16-1>
8533 * } ServerNameList;
8534 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008535MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008536int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8537 const unsigned char *buf,
8538 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008539{
8540 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8541 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008542 size_t server_name_list_len, hostname_len;
8543 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008544
Gilles Peskine449bd832023-01-11 14:50:10 +01008545 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008546
Gilles Peskine449bd832023-01-11 14:50:10 +01008547 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8548 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008549 p += 2;
8550
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008552 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008553 while (p < server_name_list_end) {
8554 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8555 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8556 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8557 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008558
Gilles Peskine449bd832023-01-11 14:50:10 +01008559 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008560 /* sni_name is intended to be used only during the parsing of the
8561 * ClientHello message (it is reset to NULL before the end of
8562 * the message parsing). Thus it is ok to just point to the
8563 * reception buffer and not make a copy of it.
8564 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008565 ssl->handshake->sni_name = p + 3;
8566 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008567 if (ssl->conf->f_sni == NULL) {
8568 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008569 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8571 ssl, p + 3, hostname_len);
8572 if (ret != 0) {
8573 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8574 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8575 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8576 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8577 }
8578 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008579 }
8580
8581 p += hostname_len + 3;
8582 }
8583
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008585}
8586#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8587
XiaokangQianacb39922022-06-17 10:18:48 +00008588#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008589MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008590int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8591 const unsigned char *buf,
8592 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008593{
8594 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008595 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008596 const unsigned char *protocol_name_list;
8597 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008598 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008599
8600 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 if (ssl->conf->alpn_list == NULL) {
8602 return 0;
8603 }
XiaokangQianacb39922022-06-17 10:18:48 +00008604
8605 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008606 * RFC7301, section 3.1
8607 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008608 *
XiaokangQianc7403452022-06-23 03:24:12 +00008609 * struct {
8610 * ProtocolName protocol_name_list<2..2^16-1>
8611 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008612 */
8613
XiaokangQianc7403452022-06-23 03:24:12 +00008614 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008615 * protocol_name_list_len 2 bytes
8616 * protocol_name_len 1 bytes
8617 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008618 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008619 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008620
Gilles Peskine449bd832023-01-11 14:50:10 +01008621 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008622 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008623 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008624 protocol_name_list = p;
8625 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008626
8627 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008629 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008630 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8631 protocol_name_len);
8632 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008633 MBEDTLS_SSL_PEND_FATAL_ALERT(
8634 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008635 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8636 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008637 }
8638
8639 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008640 }
8641
8642 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01008643 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
8644 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008645 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008647 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008648 if (protocol_name_len == alpn_len &&
8649 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008650 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008651 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008652 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008653
8654 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008655 }
8656 }
8657
XiaokangQian95d5f542022-06-24 02:29:26 +00008658 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008659 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008660 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8661 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8662 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008663}
8664
Gilles Peskine449bd832023-01-11 14:50:10 +01008665int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8666 unsigned char *buf,
8667 unsigned char *end,
8668 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008669{
8670 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008671 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008672 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008673
Gilles Peskine449bd832023-01-11 14:50:10 +01008674 if (ssl->alpn_chosen == NULL) {
8675 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008676 }
8677
Gilles Peskine449bd832023-01-11 14:50:10 +01008678 protocol_name_len = strlen(ssl->alpn_chosen);
8679 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008680
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008682 /*
8683 * 0 . 1 ext identifier
8684 * 2 . 3 ext length
8685 * 4 . 5 protocol list length
8686 * 6 . 6 protocol name length
8687 * 7 . 7+n protocol name
8688 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008689 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008690
XiaokangQian95d5f542022-06-24 02:29:26 +00008691 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008692
Gilles Peskine449bd832023-01-11 14:50:10 +01008693 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8694 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008695 /* Note: the length of the chosen protocol has been checked to be less
8696 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8697 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008698 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008699
Gilles Peskine449bd832023-01-11 14:50:10 +01008700 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008701
8702#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008703 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008704#endif
8705
Gilles Peskine449bd832023-01-11 14:50:10 +01008706 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008707}
8708#endif /* MBEDTLS_SSL_ALPN */
8709
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008710#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008711 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008712 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008713 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008714int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8715 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008716{
8717 /* Initialize to suppress unnecessary compiler warning */
8718 size_t hostname_len = 0;
8719
8720 /* Check if new hostname is valid before
8721 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008722 if (hostname != NULL) {
8723 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008724
Gilles Peskine449bd832023-01-11 14:50:10 +01008725 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8726 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8727 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008728 }
8729
8730 /* Now it's clear that we will overwrite the old hostname,
8731 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008732 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008733 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008734 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008735 }
8736
8737 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008738 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008739 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008740 } else {
8741 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8742 if (session->hostname == NULL) {
8743 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8744 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008745
Gilles Peskine449bd832023-01-11 14:50:10 +01008746 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008747 }
8748
Gilles Peskine449bd832023-01-11 14:50:10 +01008749 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008750}
Xiaokang Qian03409292022-10-12 02:49:52 +00008751#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8752 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008753 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008754 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008755
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008756#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8757 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008758int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8759 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008760{
8761 size_t alpn_len = 0;
8762
8763 if (alpn != NULL) {
8764 alpn_len = strlen(alpn);
8765
8766 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8767 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8768 }
8769 }
8770
8771 if (session->ticket_alpn != NULL) {
8772 mbedtls_zeroize_and_free(session->ticket_alpn,
8773 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008774 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008775 }
8776
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008777 if (alpn != NULL) {
8778 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008779 if (session->ticket_alpn == NULL) {
8780 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8781 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008782 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008783 }
8784
8785 return 0;
8786}
8787#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008788
8789/*
8790 * The following functions are used by 1.2 and 1.3, client and server.
8791 */
8792#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8793int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8794 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8795 int recv_endpoint,
8796 mbedtls_ssl_protocol_version tls_version,
8797 uint32_t *flags)
8798{
8799 int ret = 0;
8800 unsigned int usage = 0;
8801 const char *ext_oid;
8802 size_t ext_len;
8803
8804 /*
8805 * keyUsage
8806 */
8807
8808 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8809 * to check what a compliant client will think while choosing which cert
8810 * to send to the client. */
8811#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8812 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8813 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8814 /* TLS 1.2 server part of the key exchange */
8815 switch (ciphersuite->key_exchange) {
8816 case MBEDTLS_KEY_EXCHANGE_RSA:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008817 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
8818 break;
8819
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008820 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8821 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8822 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8823 break;
8824
8825 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8826 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8827 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8828 break;
8829
8830 /* Don't use default: we want warnings when adding new values */
8831 case MBEDTLS_KEY_EXCHANGE_NONE:
8832 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008833 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8834 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8835 usage = 0;
8836 }
8837 } else
8838#endif
8839 {
8840 /* This is either TLS 1.3 authentication, which always uses signatures,
8841 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8842 * options we implement, both using signatures. */
8843 (void) tls_version;
8844 (void) ciphersuite;
8845 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8846 }
8847
8848 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8849 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8850 ret = -1;
8851 }
8852
8853 /*
8854 * extKeyUsage
8855 */
8856
8857 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8858 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8859 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8860 } else {
8861 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8862 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8863 }
8864
8865 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8866 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8867 ret = -1;
8868 }
8869
8870 return ret;
8871}
8872
Gilles Peskine4ac40082025-02-20 18:13:58 +01008873static int get_hostname_for_verification(mbedtls_ssl_context *ssl,
8874 const char **hostname)
8875{
8876 if (!mbedtls_ssl_has_set_hostname_been_called(ssl)) {
8877 MBEDTLS_SSL_DEBUG_MSG(1, ("Certificate verification without having set hostname"));
8878 }
8879
8880 *hostname = ssl->hostname;
8881 if (*hostname == NULL) {
8882 MBEDTLS_SSL_DEBUG_MSG(2, ("Certificate verification without CN verification"));
8883 }
8884
8885 return 0;
8886}
8887
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008888int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8889 int authmode,
8890 mbedtls_x509_crt *chain,
8891 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8892 void *rs_ctx)
8893{
8894 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8895 return 0;
8896 }
8897
8898 /*
8899 * Primary check: use the appropriate X.509 verification function
8900 */
8901 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8902 void *p_vrfy;
8903 if (ssl->f_vrfy != NULL) {
8904 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8905 f_vrfy = ssl->f_vrfy;
8906 p_vrfy = ssl->p_vrfy;
8907 } else {
8908 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8909 f_vrfy = ssl->conf->f_vrfy;
8910 p_vrfy = ssl->conf->p_vrfy;
8911 }
8912
Gilles Peskine4ac40082025-02-20 18:13:58 +01008913 const char *hostname = "";
8914 int ret = get_hostname_for_verification(ssl, &hostname);
8915 if (ret != 0) {
8916 MBEDTLS_SSL_DEBUG_RET(1, "get_hostname_for_verification", ret);
8917 return ret;
8918 }
8919
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008920 int have_ca_chain_or_callback = 0;
8921#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8922 if (ssl->conf->f_ca_cb != NULL) {
8923 ((void) rs_ctx);
8924 have_ca_chain_or_callback = 1;
8925
8926 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8927 ret = mbedtls_x509_crt_verify_with_ca_cb(
8928 chain,
8929 ssl->conf->f_ca_cb,
8930 ssl->conf->p_ca_cb,
8931 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008932 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008933 &ssl->session_negotiate->verify_result,
8934 f_vrfy, p_vrfy);
8935 } else
8936#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8937 {
8938 mbedtls_x509_crt *ca_chain;
8939 mbedtls_x509_crl *ca_crl;
8940#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8941 if (ssl->handshake->sni_ca_chain != NULL) {
8942 ca_chain = ssl->handshake->sni_ca_chain;
8943 ca_crl = ssl->handshake->sni_ca_crl;
8944 } else
8945#endif
8946 {
8947 ca_chain = ssl->conf->ca_chain;
8948 ca_crl = ssl->conf->ca_crl;
8949 }
8950
8951 if (ca_chain != NULL) {
8952 have_ca_chain_or_callback = 1;
8953 }
8954
8955 ret = mbedtls_x509_crt_verify_restartable(
8956 chain,
8957 ca_chain, ca_crl,
8958 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008959 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008960 &ssl->session_negotiate->verify_result,
8961 f_vrfy, p_vrfy, rs_ctx);
8962 }
8963
8964 if (ret != 0) {
8965 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8966 }
8967
8968#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8969 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8970 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8971 }
8972#endif
8973
8974 /*
8975 * Secondary checks: always done, but change 'ret' only if it was 0
8976 */
8977
8978 /* With TLS 1.2 and ECC certs, check that the curve used by the
8979 * certificate is on our list of acceptable curves.
8980 *
8981 * With TLS 1.3 this is not needed because the curve is part of the
8982 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8983 * we validate the signature made with the key associated to this cert.
8984 */
8985#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8986 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8987 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8988 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8989 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8990 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8991 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8992 if (ret == 0) {
8993 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8994 }
8995 }
8996 }
8997#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8998
8999 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
9000 if (mbedtls_ssl_check_cert_usage(chain,
9001 ciphersuite_info,
9002 ssl->conf->endpoint,
9003 ssl->tls_version,
9004 &ssl->session_negotiate->verify_result) != 0) {
9005 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
9006 if (ret == 0) {
9007 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
9008 }
9009 }
9010
9011 /* With authmode optional, we want to keep going if the certificate was
9012 * unacceptable, but still fail on other errors (out of memory etc),
9013 * including fatal errors from the f_vrfy callback.
9014 *
9015 * The only acceptable errors are:
9016 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
9017 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
9018 * Anything else is a fatal error. */
9019 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
9020 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
9021 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
9022 ret = 0;
9023 }
9024
9025 /* Return a specific error as this is a user error: inconsistent
9026 * configuration - can't verify without trust anchors. */
9027 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
9028 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
9029 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
9030 }
9031
9032 if (ret != 0) {
9033 uint8_t alert;
9034
9035 /* The certificate may have been rejected for several reasons.
9036 Pick one and send the corresponding alert. Which alert to send
9037 may be a subject of debate in some cases. */
9038 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
9039 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
9040 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
9041 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
9042 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
9043 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9044 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
9045 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9046 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
9047 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9048 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
9049 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9050 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
9051 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
9052 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
9053 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
9054 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
9055 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
9056 } else {
9057 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
9058 }
9059 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9060 alert);
9061 }
9062
9063#if defined(MBEDTLS_DEBUG_C)
9064 if (ssl->session_negotiate->verify_result != 0) {
9065 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
9066 (unsigned int) ssl->session_negotiate->verify_result));
9067 } else {
9068 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
9069 }
9070#endif /* MBEDTLS_DEBUG_C */
9071
9072 return ret;
9073}
9074#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
9075
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009076#endif /* MBEDTLS_SSL_TLS_C */