blob: 4cb593466760e4b694cdeeccb35c7d65e23f8b9e [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
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
SimonBd5800b72016-04-26 07:43:27 +010028#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010029
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000030#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010031#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010032#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000033#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040034
Janos Follath73c616b2019-12-18 15:07:04 +000035#include "mbedtls/debug.h"
36#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050037#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010038#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020039#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020040
Rich Evans00ab4702015-02-06 13:43:58 +000041#include <string.h>
42
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050043#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020044#include "md_psa.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050045#include "mbedtls/psa_util.h"
46#include "psa/crypto.h"
47#endif
48
Janos Follath23bdca02016-10-07 14:47:14 +010049#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000050#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020051#endif
52
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050053#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040054/* Define local translating functions to save code size by not using too many
55 * arguments in each translating place. */
56static int local_err_translation(psa_status_t status)
57{
58 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040059 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040060 psa_generic_status_to_mbedtls);
61}
62#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050063#endif
64
Ronald Cronad8c17b2022-06-10 17:18:09 +020065#if defined(MBEDTLS_TEST_HOOKS)
66static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
67
68void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010069 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020070{
71 chk_buf_ptr_fail_args.cur = cur;
72 chk_buf_ptr_fail_args.end = end;
73 chk_buf_ptr_fail_args.need = need;
74}
75
Gilles Peskine449bd832023-01-11 14:50:10 +010076void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020077{
Gilles Peskine449bd832023-01-11 14:50:10 +010078 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020079}
80
Gilles Peskine449bd832023-01-11 14:50:10 +010081int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020082{
Gilles Peskine449bd832023-01-11 14:50:10 +010083 return (chk_buf_ptr_fail_args.cur != args->cur) ||
84 (chk_buf_ptr_fail_args.end != args->end) ||
85 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020086}
87#endif /* MBEDTLS_TEST_HOOKS */
88
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020089#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010090
Hanno Beckera0e20d02019-05-15 14:03:01 +010091#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010092/* Top-level Connection ID API */
93
Gilles Peskine449bd832023-01-11 14:50:10 +010094int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
95 size_t len,
96 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010097{
Gilles Peskine449bd832023-01-11 14:50:10 +010098 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
99 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
100 }
Hanno Beckerad4a1372019-05-03 13:06:44 +0100101
Gilles Peskine449bd832023-01-11 14:50:10 +0100102 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
103 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
104 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +0100105 }
106
107 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100108 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100109 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100110}
111
Gilles Peskine449bd832023-01-11 14:50:10 +0100112int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
113 int enable,
114 unsigned char const *own_cid,
115 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100116{
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
119 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100120
Hanno Beckerca092242019-04-25 16:01:49 +0100121 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100122 if (enable == MBEDTLS_SSL_CID_DISABLED) {
123 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
124 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100125 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
127 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 if (own_cid_len != ssl->conf->cid_len) {
130 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
131 (unsigned) own_cid_len,
132 (unsigned) ssl->conf->cid_len));
133 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100134 }
135
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100137 /* Truncation is not an issue here because
138 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
139 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100140
Gilles Peskine449bd832023-01-11 14:50:10 +0100141 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100142}
143
Gilles Peskine449bd832023-01-11 14:50:10 +0100144int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
145 int *enabled,
146 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
147 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000148{
149 *enabled = MBEDTLS_SSL_CID_DISABLED;
150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
152 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
153 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000154
155 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
156 * zero as this is indistinguishable from not requesting to use
157 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
159 return 0;
160 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000163 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100164 if (own_cid != NULL) {
165 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
166 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000167 }
168
169 *enabled = MBEDTLS_SSL_CID_ENABLED;
170
Gilles Peskine449bd832023-01-11 14:50:10 +0100171 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000172}
173
Gilles Peskine449bd832023-01-11 14:50:10 +0100174int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
175 int *enabled,
176 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
177 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100178{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100179 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100180
Gilles Peskine449bd832023-01-11 14:50:10 +0100181 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
182 mbedtls_ssl_is_handshake_over(ssl) == 0) {
183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100184 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100185
Hanno Beckerc5f24222019-05-03 12:54:52 +0100186 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
187 * were used, but client and server requested the empty CID.
188 * This is indistinguishable from not using the CID extension
189 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100190 if (ssl->transform_in->in_cid_len == 0 &&
191 ssl->transform_in->out_cid_len == 0) {
192 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100193 }
194
Gilles Peskine449bd832023-01-11 14:50:10 +0100195 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100196 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100197 if (peer_cid != NULL) {
198 memcpy(peer_cid, ssl->transform_in->out_cid,
199 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100200 }
201 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100202
203 *enabled = MBEDTLS_SSL_CID_ENABLED;
204
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100206}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100207#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100208
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200210
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200212/*
213 * Convert max_fragment_length codes to length.
214 * RFC 6066 says:
215 * enum{
216 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
217 * } MaxFragmentLength;
218 * and we add 0 -> extension unused
219 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100220static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200221{
Gilles Peskine449bd832023-01-11 14:50:10 +0100222 switch (mfl) {
223 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
224 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
225 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
226 return 512;
227 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
228 return 1024;
229 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
230 return 2048;
231 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
232 return 4096;
233 default:
234 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000235 }
236}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200238
Gilles Peskine449bd832023-01-11 14:50:10 +0100239int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
240 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200241{
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 mbedtls_ssl_session_free(dst);
243 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800244#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
245 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000246#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
247 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000248 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800249#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000250#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800251
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200252#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000253
254#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000256 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200257
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
259 if (dst->peer_cert == NULL) {
260 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
261 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
266 src->peer_cert->raw.len)) != 0) {
267 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200268 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200270 }
271 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000272#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000274 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 mbedtls_calloc(1, src->peer_cert_digest_len);
276 if (dst->peer_cert_digest == NULL) {
277 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
278 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000279
Gilles Peskine449bd832023-01-11 14:50:10 +0100280 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
281 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000282 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000283 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000284 }
285#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
286
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200287#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200288
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200289#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 if (src->ticket != NULL) {
291 dst->ticket = mbedtls_calloc(1, src->ticket_len);
292 if (dst->ticket == NULL) {
293 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
294 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200295
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200297 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000298
299#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
300 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000302 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
304 if (ret != 0) {
305 return ret;
306 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000307 }
308#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
309 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200310#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200311
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200313}
314
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500315#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200316MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100317static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500318{
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
320 if (resized_buffer == NULL) {
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500321 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500323
324 /* We want to copy len_new bytes when downsizing the buffer, and
325 * len_old bytes when upsizing, so we choose the smaller of two sizes,
326 * to fit one buffer into another. Size checks, ensuring that no data is
327 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 memcpy(resized_buffer, *buffer,
329 (len_new < *len_old) ? len_new : *len_old);
330 mbedtls_platform_zeroize(*buffer, *len_old);
331 mbedtls_free(*buffer);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500332
333 *buffer = resized_buffer;
334 *len_old = len_new;
335
336 return 0;
337}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200338
Gilles Peskine449bd832023-01-11 14:50:10 +0100339static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
340 size_t in_buf_new_len,
341 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200342{
343 int modified = 0;
344 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
345 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200347 written_in = ssl->in_msg - ssl->in_buf;
348 iv_offset_in = ssl->in_iv - ssl->in_buf;
349 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200351 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 ssl->in_buf_len < in_buf_new_len) {
353 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
354 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
355 } else {
356 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
357 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200358 modified = 1;
359 }
360 }
361 }
362
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200364 written_out = ssl->out_msg - ssl->out_buf;
365 iv_offset_out = ssl->out_iv - ssl->out_buf;
366 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200368 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 ssl->out_buf_len < out_buf_new_len) {
370 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
371 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
372 } else {
373 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
374 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200375 modified = 1;
376 }
377 }
378 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200380 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200382 /* Fields below might not be properly updated with record
383 * splitting or with CID, so they are manually updated here. */
384 ssl->out_msg = ssl->out_buf + written_out;
385 ssl->out_len = ssl->out_buf + len_offset_out;
386 ssl->out_iv = ssl->out_buf + iv_offset_out;
387
388 ssl->in_msg = ssl->in_buf + written_in;
389 ssl->in_len = ssl->in_buf + len_offset_in;
390 ssl->in_iv = ssl->in_buf + iv_offset_in;
391 }
392}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500393#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
394
Jerry Yudb8c48a2022-01-27 14:54:54 +0800395#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800396
397#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100398typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
399 const char *label,
400 const unsigned char *random, size_t rlen,
401 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800402
Gilles Peskine449bd832023-01-11 14:50:10 +0100403static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800404
405#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
406
407/* Type for the TLS PRF */
408typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
409 const unsigned char *, size_t,
410 unsigned char *, size_t);
411
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200412MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100413static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
414 int ciphersuite,
415 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200416#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200418#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 ssl_tls_prf_t tls_prf,
420 const unsigned char randbytes[64],
421 mbedtls_ssl_protocol_version tls_version,
422 unsigned endpoint,
423 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800424
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100425#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200426MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100427static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300428 const char *label,
429 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100431static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
432static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100433
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100434#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100435
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100436#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100437MBEDTLS_CHECK_RETURN_CRITICAL
438static int tls_prf_sha384(const unsigned char *secret, size_t slen,
439 const char *label,
440 const unsigned char *random, size_t rlen,
441 unsigned char *dstbuf, size_t dlen);
442
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100443static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
444static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100445#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100446
447static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
448 unsigned char *buf,
449 size_t buf_len);
450
451MBEDTLS_CHECK_RETURN_CRITICAL
452static int ssl_tls12_session_load(mbedtls_ssl_session *session,
453 const unsigned char *buf,
454 size_t len);
455#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
456
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100457static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100458
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100459#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100460static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100461#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100462
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100463#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100464static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100465#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100466
467int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
468 const unsigned char *secret, size_t slen,
469 const char *label,
470 const unsigned char *random, size_t rlen,
471 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300472{
473 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
474
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300476#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100477#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300478 case MBEDTLS_SSL_TLS_PRF_SHA384:
479 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100480 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100481#endif /* MBEDTLS_MD_CAN_SHA384*/
482#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300483 case MBEDTLS_SSL_TLS_PRF_SHA256:
484 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100486#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300487#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100488 default:
489 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300490 }
491
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300493}
494
Jerry Yuc73c6182022-02-08 20:29:25 +0800495#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100496static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800497{
498#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100499 if (session->peer_cert != NULL) {
500 mbedtls_x509_crt_free(session->peer_cert);
501 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800502 session->peer_cert = NULL;
503 }
504#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800506 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800508 session->peer_cert_digest = NULL;
509 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
510 session->peer_cert_digest_len = 0;
511 }
512#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
513}
514#endif /* MBEDTLS_X509_CRT_PARSE_C */
515
Gilles Peskine449bd832023-01-11 14:50:10 +0100516uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800517{
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800519 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800521
522 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100523 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800524
525 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100526 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800527
528 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100529 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800530
531 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800533
534 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800536
537 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800539
540 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800542
543 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800545
546 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800548
549 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800551
552 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800554
555 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800557
558 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800560
561 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800563
564 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800566
567 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800569
570 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800572
573 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800575
576 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800578
579 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800581
582 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800584
585 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800587
588 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800590
591 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800593
594 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100595 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800596
Jan Bruckner151f6422023-02-10 12:45:19 +0100597 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
598 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
599
Jerry Yu7a485c12022-10-31 13:08:18 +0800600 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800602
603 }
604
Gilles Peskine449bd832023-01-11 14:50:10 +0100605 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800606}
607
Gilles Peskine449bd832023-01-11 14:50:10 +0100608uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800609{
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800611}
612
Jerry Yud25cab02022-10-31 12:48:30 +0800613#if defined(MBEDTLS_DEBUG_C)
614static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800615 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800616 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
617 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
618 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
619 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
620 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
621 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
622 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
623 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
624 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
625 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
626 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
627 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
628 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
629 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
630 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
631 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
632 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
633 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
634 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
635 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
636 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
637 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
638 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
639 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
640 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
641 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100642 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
643 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800644};
645
Gilles Peskine449bd832023-01-11 14:50:10 +0100646static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800647 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
648 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
649 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
650 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
651 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
652 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
653 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
654 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
655 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
656 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
657 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
658 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
659 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
660 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
661 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
662 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
663 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
664 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
665 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
666 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
667 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
668 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
669 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
670 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
671 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
672 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
673 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100674 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
675 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800676};
677
Gilles Peskine449bd832023-01-11 14:50:10 +0100678const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800679{
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 return extension_name_table[
681 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800682}
683
Gilles Peskine449bd832023-01-11 14:50:10 +0100684static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800685{
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800687 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800689 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800691 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800693 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800695 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800697 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800699 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100700 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800701 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800703}
704
Gilles Peskine449bd832023-01-11 14:50:10 +0100705void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
706 int level, const char *file, int line,
707 int hs_msg_type, unsigned int extension_type,
708 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800709{
710 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800712 mbedtls_debug_print_msg(
713 ssl, level, file, line,
714 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100715 ssl_tls13_get_hs_msg_name(hs_msg_type),
716 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800717 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800719 return;
720 }
721
722 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100723 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800724 mbedtls_debug_print_msg(
725 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100726 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
727 mbedtls_ssl_get_extension_name(extension_type), extension_type,
728 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800729 return;
730 }
731
732 mbedtls_debug_print_msg(
733 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100734 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
735 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800736}
737
Gilles Peskine449bd832023-01-11 14:50:10 +0100738void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
739 int level, const char *file, int line,
740 int hs_msg_type, uint32_t extensions_mask,
741 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800742{
743
Gilles Peskine449bd832023-01-11 14:50:10 +0100744 for (unsigned i = 0;
745 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
746 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800747 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800748 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800750 }
751}
752
Pengyu Lvee455c02023-01-12 14:37:24 +0800753#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800754static const char *ticket_flag_name_table[] =
755{
756 [0] = "ALLOW_PSK_RESUMPTION",
757 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
758 [3] = "ALLOW_EARLY_DATA",
759};
760
Pengyu Lv4938a562023-01-16 11:28:49 +0800761void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
762 int level, const char *file, int line,
763 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800764{
765 size_t i;
766
767 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800768 "print ticket_flags (0x%02x)", flags);
769
770 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800771
772 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800773 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800774 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
775 ticket_flag_name_table[i]);
776 }
777 }
778}
779#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
780
Jerry Yud25cab02022-10-31 12:48:30 +0800781#endif /* MBEDTLS_DEBUG_C */
782
Gilles Peskine449bd832023-01-11 14:50:10 +0100783void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
784 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800785{
786 ((void) ciphersuite_info);
787
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100788#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800790 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100791 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800792#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100793#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800795 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800797#endif
798 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100799 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800800 return;
801 }
802}
803
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100804int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100805 unsigned hs_type,
806 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100807{
808 unsigned char hs_hdr[4];
809
810 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100811 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
812 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
813 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
814 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100815
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100816 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100817}
818
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100819int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100820 unsigned hs_type,
821 unsigned char const *msg,
822 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100823{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100824 int ret;
825 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100826 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100827 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100828 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100829 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100830}
831
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100832int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800833{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100834#if defined(MBEDTLS_MD_CAN_SHA256) || \
835 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100836#if defined(MBEDTLS_USE_PSA_CRYPTO)
837 psa_status_t status;
838#else
839 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
840#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100841#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800842 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100843#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100844#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800845#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100846 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
847 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200848 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100849 }
850 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
851 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200852 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100853 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100855 mbedtls_md_free(&ssl->handshake->fin_sha256);
856 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100857 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
858 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
859 0);
860 if (ret != 0) {
861 return ret;
862 }
863 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100864 if (ret != 0) {
865 return ret;
866 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800867#endif
868#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100869#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800870#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100871 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
872 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200873 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100874 }
875 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
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é-Gonnardb72ff492023-02-06 09:54:49 +0100878 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800879#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100880 mbedtls_md_free(&ssl->handshake->fin_sha384);
881 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100882 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
883 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
884 if (ret != 0) {
885 return ret;
886 }
887 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100888 if (ret != 0) {
889 return ret;
890 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800891#endif
892#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100893 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800894}
895
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100896static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100897 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800898{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100899#if defined(MBEDTLS_MD_CAN_SHA256) || \
900 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100901#if defined(MBEDTLS_USE_PSA_CRYPTO)
902 psa_status_t status;
903#else
904 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
905#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100906#else /* SHA-256 or SHA-384 */
907 ((void) ssl);
908 (void) buf;
909 (void) len;
910#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100911#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800912#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
914 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200915 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800917#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100918 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100919 if (ret != 0) {
920 return ret;
921 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800922#endif
923#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100924#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800925#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100926 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
927 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200928 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100929 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800930#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100931 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100932 if (ret != 0) {
933 return ret;
934 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800935#endif
936#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100937 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800938}
939
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100940#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100941static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100942 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800943{
944#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200945 return mbedtls_md_error_from_psa(psa_hash_update(
946 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800947#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100948 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800949#endif
950}
951#endif
952
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100953#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100954static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100955 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800956{
957#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200958 return mbedtls_md_error_from_psa(psa_hash_update(
959 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800960#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100961 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800962#endif
963}
964#endif
965
Gilles Peskine449bd832023-01-11 14:50:10 +0100966static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200967{
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200969
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100970#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500971#if defined(MBEDTLS_USE_PSA_CRYPTO)
972 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500973#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100974 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200975#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500976#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100977#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500978#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500979 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500980#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100981 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200982#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500983#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200984
985 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100986
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200987#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200989#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200990#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200992#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200993#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200994#if defined(MBEDTLS_USE_PSA_CRYPTO)
995 handshake->psa_pake_ctx = psa_pake_operation_init();
996 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
997#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200999#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02001000#if defined(MBEDTLS_SSL_CLI_C)
1001 handshake->ecjpake_cache = NULL;
1002 handshake->ecjpake_cache_len = 0;
1003#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001004#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001005
Gilles Peskineeccd8882020-03-10 12:19:08 +01001006#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001008#endif
1009
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001010#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1011 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1012#endif
Hanno Becker75173122019-02-06 16:18:31 +00001013
1014#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1015 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001017#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001018}
1019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001021{
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001023
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001024#if defined(MBEDTLS_USE_PSA_CRYPTO)
1025 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1026 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001027#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1029 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001030#endif
1031
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001032#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001033#if defined(MBEDTLS_USE_PSA_CRYPTO)
1034 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1035 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001036#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 mbedtls_md_init(&transform->md_ctx_enc);
1038 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001039#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001040#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041}
1042
Gilles Peskine449bd832023-01-11 14:50:10 +01001043void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001044{
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001046}
1047
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001048MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001049static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001050{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1052
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (ssl->transform_negotiate) {
1056 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1057 }
Jerry Yu2e199812022-12-01 18:57:19 +08001058#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->session_negotiate) {
1060 mbedtls_ssl_session_free(ssl->session_negotiate);
1061 }
1062 if (ssl->handshake) {
1063 mbedtls_ssl_handshake_free(ssl);
1064 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001065
Jerry Yu2e199812022-12-01 18:57:19 +08001066#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001067 /*
1068 * Either the pointers are now NULL or cleared properly and can be freed.
1069 * Now allocate missing structures.
1070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 if (ssl->transform_negotiate == NULL) {
1072 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001073 }
Jerry Yu2e199812022-12-01 18:57:19 +08001074#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001075
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (ssl->session_negotiate == NULL) {
1077 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001078 }
Paul Bakker48916f92012-09-16 19:57:18 +00001079
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 if (ssl->handshake == NULL) {
1081 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001082 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001083#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1084 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1087 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001088#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001089
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001090 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001092#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001093 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001094#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 ssl->session_negotiate == NULL) {
1096 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001097
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001099 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001100
1101#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001103 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001104#endif
1105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001107 ssl->session_negotiate = NULL;
1108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001110 }
1111
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001112 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001113 mbedtls_ssl_session_init(ssl->session_negotiate);
1114 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001115
Jerry Yu2e199812022-12-01 18:57:19 +08001116#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001118#endif
1119
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001120 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001121 ret = mbedtls_ssl_reset_checksum(ssl);
1122 if (ret != 0) {
1123 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1124 return ret;
1125 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001126
Jerry Yud0766ec2022-09-22 10:46:57 +08001127#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1128 defined(MBEDTLS_SSL_SRV_C) && \
1129 defined(MBEDTLS_SSL_SESSION_TICKETS)
1130 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001132#endif
1133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001136 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001137
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001139 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001141 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001143
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001145 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001146#endif
1147
Brett Warrene0edc842021-08-17 09:53:13 +01001148/*
1149 * curve_list is translated to IANA TLS group identifiers here because
1150 * mbedtls_ssl_conf_curves returns void and so can't return
1151 * any error codes.
1152 */
Valerio Setti6f0441d2023-07-03 12:11:36 +02001153#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01001154#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1155 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001157 size_t length;
1158 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1159
Thomas Daubney850a0792023-05-22 12:05:03 +01001160 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 }
Brett Warrene0edc842021-08-17 09:53:13 +01001162
1163 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1165 if (group_list == NULL) {
1166 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1167 }
Brett Warrene0edc842021-08-17 09:53:13 +01001168
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001170 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 curve_list[i]);
1172 if (tls_id == 0) {
1173 mbedtls_free(group_list);
1174 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001175 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001176 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001177 }
1178
1179 group_list[length] = 0;
1180
1181 ssl->handshake->group_list = group_list;
1182 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001184 ssl->handshake->group_list = ssl->conf->group_list;
1185 ssl->handshake->group_list_heap_allocated = 0;
1186 }
1187#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02001188#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01001189
Ronald Crone68ab4f2022-10-05 12:46:29 +02001190#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001191#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001192#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001193 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1194 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1196 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001197 const int *md;
1198 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001199 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001200 uint16_t *p;
1201
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001202 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1203 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1204 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001205
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1207 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001208 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 }
Valerio Setti75fba322023-02-23 17:35:09 +01001210#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001212#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001213
Jerry Yub476a442022-01-21 18:14:45 +08001214#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001216#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1218 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1219 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001220 }
1221
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1223 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1224 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1227 sizeof(uint16_t));
1228 if (ssl->handshake->sig_algs == NULL) {
1229 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1230 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 p = (uint16_t *) ssl->handshake->sig_algs;
1233 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1234 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1235 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001236 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 }
Valerio Setti75fba322023-02-23 17:35:09 +01001238#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001239 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001241#endif
1242#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001244 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001245#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001247 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001248 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001250#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001251 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001252 ssl->handshake->sig_algs_heap_allocated = 0;
1253 }
Jerry Yucc539102022-06-27 16:27:35 +08001254#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001255#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001256 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001257}
1258
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001259#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001260/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001261MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001262static int ssl_cookie_write_dummy(void *ctx,
1263 unsigned char **p, unsigned char *end,
1264 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001265{
1266 ((void) ctx);
1267 ((void) p);
1268 ((void) end);
1269 ((void) cli_id);
1270 ((void) cli_id_len);
1271
Gilles Peskine449bd832023-01-11 14:50:10 +01001272 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001273}
1274
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001275MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001276static int ssl_cookie_check_dummy(void *ctx,
1277 const unsigned char *cookie, size_t cookie_len,
1278 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001279{
1280 ((void) ctx);
1281 ((void) cookie);
1282 ((void) cookie_len);
1283 ((void) cli_id);
1284 ((void) cli_id_len);
1285
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001287}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001288#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001289
Paul Bakker5121ce52009-01-03 21:22:43 +00001290/*
1291 * Initialize an SSL context
1292 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001293void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001294{
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001296}
1297
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001298MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001299static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001300{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001301 const mbedtls_ssl_config *conf = ssl->conf;
1302
Ronald Cron6f135e12021-12-08 16:57:54 +01001303#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1305 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1306 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1307 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001308 }
1309
Gilles Peskine449bd832023-01-11 14:50:10 +01001310 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1311 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001312 }
1313#endif
1314
1315#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1317 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1318 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001319 }
1320#endif
1321
Ronald Cron6f135e12021-12-08 16:57:54 +01001322#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1324 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1325 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1326 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001327 }
1328
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1330 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001331 }
1332#endif
1333
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1335 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001336}
1337
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001338MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001339static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1340{
1341 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 ret = ssl_conf_version_check(ssl);
1343 if (ret != 0) {
1344 return ret;
1345 }
Jerry Yu60835a82021-08-04 10:13:52 +08001346
Jerry Yudef7ae42022-10-30 14:13:19 +08001347#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1348 /* RFC 8446 section 4.4.3
1349 *
1350 * If the verification fails, the receiver MUST terminate the handshake with
1351 * a "decrypt_error" alert.
1352 *
1353 * If the client is configured as TLS 1.3 only with optional verify, return
1354 * bad config.
1355 *
1356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1358 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001359 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1360 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1361 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001363 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 1, ("Optional verify auth mode "
1365 "is not available for TLS 1.3 client"));
1366 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001367 }
1368#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1369
Jerry Yu60835a82021-08-04 10:13:52 +08001370 /* Space for further checks */
1371
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001373}
1374
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001375/*
1376 * Setup an SSL context
1377 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001378
Gilles Peskine449bd832023-01-11 14:50:10 +01001379int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1380 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001381{
Janos Follath865b3eb2019-12-16 11:46:15 +00001382 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001383 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1384 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001385
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001386 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001387
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 if ((ret = ssl_conf_check(ssl)) != 0) {
1389 return ret;
1390 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001391 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001392
Paul Bakker62f2dee2012-09-28 07:31:51 +00001393 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001394 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001395 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001396
1397 /* Set to NULL in case of an error condition */
1398 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001399
Darryl Greenb33cc762019-11-28 14:29:44 +00001400#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1401 ssl->in_buf_len = in_buf_len;
1402#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1404 if (ssl->in_buf == NULL) {
1405 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001406 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001407 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001408 }
1409
Darryl Greenb33cc762019-11-28 14:29:44 +00001410#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1411 ssl->out_buf_len = out_buf_len;
1412#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1414 if (ssl->out_buf == NULL) {
1415 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001416 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001417 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001418 }
1419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001421
Johan Pascalb62bb512015-12-03 21:56:45 +01001422#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001424#endif
1425
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001427 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001431
1432error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 mbedtls_free(ssl->in_buf);
1434 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001435
1436 ssl->conf = NULL;
1437
Darryl Greenb33cc762019-11-28 14:29:44 +00001438#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1439 ssl->in_buf_len = 0;
1440 ssl->out_buf_len = 0;
1441#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001442 ssl->in_buf = NULL;
1443 ssl->out_buf = NULL;
1444
1445 ssl->in_hdr = NULL;
1446 ssl->in_ctr = NULL;
1447 ssl->in_len = NULL;
1448 ssl->in_iv = NULL;
1449 ssl->in_msg = NULL;
1450
1451 ssl->out_hdr = NULL;
1452 ssl->out_ctr = NULL;
1453 ssl->out_len = NULL;
1454 ssl->out_iv = NULL;
1455 ssl->out_msg = NULL;
1456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001458}
1459
1460/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001461 * Reset an initialized and used SSL context for re-use while retaining
1462 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001463 *
1464 * If partial is non-zero, keep data in the input buffer and client ID.
1465 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001466 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001467void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1468 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001469{
Darryl Greenb33cc762019-11-28 14:29:44 +00001470#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1471 size_t in_buf_len = ssl->in_buf_len;
1472 size_t out_buf_len = ssl->out_buf_len;
1473#else
1474 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1475 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1476#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001477
Hanno Beckerb0302c42021-08-03 09:39:42 +01001478#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1479 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001480#endif
1481
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001482 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001484
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001486
1487 /* Reset incoming message parsing */
1488 ssl->in_offt = NULL;
1489 ssl->nb_zero = 0;
1490 ssl->in_msgtype = 0;
1491 ssl->in_msglen = 0;
1492 ssl->in_hslen = 0;
1493 ssl->keep_current_message = 0;
1494 ssl->transform_in = NULL;
1495
1496#if defined(MBEDTLS_SSL_PROTO_DTLS)
1497 ssl->next_record_offset = 0;
1498 ssl->in_epoch = 0;
1499#endif
1500
1501 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001505 }
1506
Ronald Cronad8c17b2022-06-10 17:18:09 +02001507 ssl->send_alert = 0;
1508
Hanno Beckerb0302c42021-08-03 09:39:42 +01001509 /* Reset outgoing message writing */
1510 ssl->out_msgtype = 0;
1511 ssl->out_msglen = 0;
1512 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 memset(ssl->out_buf, 0, out_buf_len);
1514 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001515 ssl->transform_out = NULL;
1516
1517#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001519#endif
1520
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 if (ssl->transform) {
1523 mbedtls_ssl_transform_free(ssl->transform);
1524 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001525 ssl->transform = NULL;
1526 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001527#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1528
XiaokangQian2b01dc32022-01-21 02:53:13 +00001529#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 mbedtls_ssl_transform_free(ssl->transform_application);
1531 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532 ssl->transform_application = NULL;
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001535#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1537 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001538 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001539#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1542 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001543 ssl->handshake->transform_handshake = NULL;
1544 }
1545
XiaokangQian2b01dc32022-01-21 02:53:13 +00001546#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001547}
1548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001550{
1551 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1552
1553 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1554
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001556
1557 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558#if defined(MBEDTLS_SSL_RENEGOTIATION)
1559 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001560 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001561
1562 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1564 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001565#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001567
Hanno Beckerb0302c42021-08-03 09:39:42 +01001568 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001569 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 if (ssl->session) {
1571 mbedtls_ssl_session_free(ssl->session);
1572 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001573 ssl->session = NULL;
1574 }
1575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001577 ssl->alpn_chosen = NULL;
1578#endif
1579
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001580#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001581 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001582#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001584#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 if (free_cli_id) {
1586 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001587 ssl->cli_id = NULL;
1588 ssl->cli_id_len = 0;
1589 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001590#endif
1591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 if ((ret = ssl_handshake_init(ssl)) != 0) {
1593 return ret;
1594 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001597}
1598
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001599/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001600 * Reset an initialized and used SSL context for re-use while retaining
1601 * all application-set variables, function pointers and data.
1602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001603int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001604{
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001606}
1607
1608/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001609 * SSL set accessors
1610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001611void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001612{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001613 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001614}
1615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001619}
1620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001622void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001623{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001624 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001625}
1626#endif
1627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001629{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001630 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001631}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001633#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001634
Gilles Peskine449bd832023-01-11 14:50:10 +01001635void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1636 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001637{
1638 ssl->disable_datagram_packing = !allow_packing;
1639}
1640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1642 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001643{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001644 conf->hs_timeout_min = min;
1645 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001646}
1647#endif
1648
Gilles Peskine449bd832023-01-11 14:50:10 +01001649void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001650{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001651 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001652}
1653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001655void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1656 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1657 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001658{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001659 conf->f_vrfy = f_vrfy;
1660 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001661}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001663
Gilles Peskine449bd832023-01-11 14:50:10 +01001664void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1665 int (*f_rng)(void *, unsigned char *, size_t),
1666 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001667{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001668 conf->f_rng = f_rng;
1669 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001670}
1671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1673 void (*f_dbg)(void *, int, const char *, int, const char *),
1674 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001675{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001676 conf->f_dbg = f_dbg;
1677 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001678}
1679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1681 void *p_bio,
1682 mbedtls_ssl_send_t *f_send,
1683 mbedtls_ssl_recv_t *f_recv,
1684 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001685{
1686 ssl->p_bio = p_bio;
1687 ssl->f_send = f_send;
1688 ssl->f_recv = f_recv;
1689 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001690}
1691
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001692#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001693void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001694{
1695 ssl->mtu = mtu;
1696}
1697#endif
1698
Gilles Peskine449bd832023-01-11 14:50:10 +01001699void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001700{
1701 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001702}
1703
Gilles Peskine449bd832023-01-11 14:50:10 +01001704void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1705 void *p_timer,
1706 mbedtls_ssl_set_timer_t *f_set_timer,
1707 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001708{
1709 ssl->p_timer = p_timer;
1710 ssl->f_set_timer = f_set_timer;
1711 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001712
1713 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001715}
1716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001718void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1719 void *p_cache,
1720 mbedtls_ssl_cache_get_t *f_get_cache,
1721 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001722{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001723 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001724 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001725 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001726}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001730int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001731{
Janos Follath865b3eb2019-12-16 11:46:15 +00001732 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001735 session == NULL ||
1736 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1738 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001739 }
1740
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 if (ssl->handshake->resume == 1) {
1742 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1743 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001744
Jerry Yu21092062022-10-10 21:21:31 +08001745#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001747 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001751 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1753 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1754 session->ciphersuite));
1755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001756 }
Jerry Yu40afab62022-10-08 10:42:13 +08001757 }
Jerry Yu21092062022-10-10 21:21:31 +08001758#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1761 session)) != 0) {
1762 return ret;
1763 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001764
Paul Bakker0a597072012-09-25 21:55:46 +00001765 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001768}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1772 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001773{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001774 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001775}
1776
Ronald Cron6f135e12021-12-08 16:57:54 +01001777#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001778void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1779 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001780{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001781 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001782}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001783
1784#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001785void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
1786 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787{
1788 conf->early_data_enabled = early_data_enabled;
1789}
Jerry Yucc4e0072022-11-22 17:22:22 +08001790
1791#if defined(MBEDTLS_SSL_SRV_C)
1792void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001794{
Jerry Yu39da9852022-12-06 16:58:36 +08001795 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001796}
1797#endif /* MBEDTLS_SSL_SRV_C */
1798
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001799#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001800#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001803void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1804 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001805{
1806 conf->cert_profile = profile;
1807}
1808
Gilles Peskine449bd832023-01-11 14:50:10 +01001809static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001810{
1811 mbedtls_ssl_key_cert *cur = key_cert, *next;
1812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001814 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001816 cur = next;
1817 }
1818}
1819
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001820/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001821MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001822static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1823 mbedtls_x509_crt *cert,
1824 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001825{
niisato8ee24222018-06-25 19:05:48 +09001826 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001829 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001831 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001833 }
1834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1836 if (new_cert == NULL) {
1837 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1838 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001839
niisato8ee24222018-06-25 19:05:48 +09001840 new_cert->cert = cert;
1841 new_cert->key = key;
1842 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001843
Glenn Strauss36872db2022-01-22 05:06:31 -05001844 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001846 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001848 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 }
niisato8ee24222018-06-25 19:05:48 +09001852 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001853 }
1854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001856}
1857
Gilles Peskine449bd832023-01-11 14:50:10 +01001858int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001859 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001861{
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001863}
1864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001866 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001868{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001869 conf->ca_chain = ca_chain;
1870 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001871
1872#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1873 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1874 * cannot be used together. */
1875 conf->f_ca_cb = NULL;
1876 conf->p_ca_cb = NULL;
1877#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001878}
Hanno Becker5adaad92019-03-27 16:54:37 +00001879
1880#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001881void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1882 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1883 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001884{
1885 conf->f_ca_cb = f_ca_cb;
1886 conf->p_ca_cb = p_ca_cb;
1887
1888 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1889 * cannot be used together. */
1890 conf->ca_chain = NULL;
1891 conf->ca_crl = NULL;
1892}
1893#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001895
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001896#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001897const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1898 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001899{
1900 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001902}
1903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1905 mbedtls_x509_crt *own_cert,
1906 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001907{
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1909 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001910}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1913 mbedtls_x509_crt *ca_chain,
1914 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001915{
1916 ssl->handshake->sni_ca_chain = ca_chain;
1917 ssl->handshake->sni_ca_crl = ca_crl;
1918}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001919
Glenn Strauss999ef702022-03-11 01:37:23 -05001920#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001921void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1922 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001923{
1924 ssl->handshake->dn_hints = crt;
1925}
1926#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1927
Gilles Peskine449bd832023-01-11 14:50:10 +01001928void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1929 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001930{
1931 ssl->handshake->sni_authmode = authmode;
1932}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001933#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1934
Hanno Becker8927c832019-04-03 12:52:50 +01001935#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001936void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1937 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1938 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001939{
1940 ssl->f_vrfy = f_vrfy;
1941 ssl->p_vrfy = p_vrfy;
1942}
1943#endif
1944
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001945#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001946
Valerio Setti016f6822022-12-09 14:17:50 +01001947#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001948static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1949static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1950
Valerio Setti016f6822022-12-09 14:17:50 +01001951static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 mbedtls_ssl_context *ssl,
1953 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001954{
1955 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001956 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001957 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001958 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001959 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001960 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1962 psa_pake_cs_set_primitive(&cipher_suite,
1963 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1964 PSA_ECC_FAMILY_SECP_R1,
1965 256));
1966 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1969 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001970 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001972
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001974 user = jpake_server_id;
1975 user_len = sizeof(jpake_server_id);
1976 peer = jpake_client_id;
1977 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001979 user = jpake_client_id;
1980 user_len = sizeof(jpake_client_id);
1981 peer = jpake_server_id;
1982 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001984
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001985 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1986 if (status != PSA_SUCCESS) {
1987 return status;
1988 }
1989
1990 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001992 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 }
Valerio Setti016f6822022-12-09 14:17:50 +01001994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1996 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001997 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 }
Valerio Setti016f6822022-12-09 14:17:50 +01001999
2000 ssl->handshake->psa_pake_ctx_is_ok = 1;
2001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002003}
2004
Gilles Peskine449bd832023-01-11 14:50:10 +01002005int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2006 const unsigned char *pw,
2007 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002008{
2009 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2010 psa_status_t status;
2011
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 if (ssl->handshake == NULL || ssl->conf == NULL) {
2013 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002014 }
2015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 /* Empty password is not valid */
2017 if ((pw == NULL) || (pw_len == 0)) {
2018 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2019 }
2020
2021 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2022 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2023 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2024
2025 status = psa_import_key(&attributes, pw, pw_len,
2026 &ssl->handshake->psa_pake_password);
2027 if (status != PSA_SUCCESS) {
2028 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2029 }
2030
2031 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2032 ssl->handshake->psa_pake_password);
2033 if (status != PSA_SUCCESS) {
2034 psa_destroy_key(ssl->handshake->psa_pake_password);
2035 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2036 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2037 }
2038
2039 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002040}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2043 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002044{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002045 psa_status_t status;
2046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 if (ssl->handshake == NULL || ssl->conf == NULL) {
2048 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002049 }
2050
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 if (mbedtls_svc_key_id_is_null(pwd)) {
2052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2053 }
2054
2055 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2056 if (status != PSA_SUCCESS) {
2057 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2058 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2059 }
2060
2061 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002062}
2063#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002064int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2065 const unsigned char *pw,
2066 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002067{
2068 mbedtls_ecjpake_role role;
2069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 if (ssl->handshake == NULL || ssl->conf == NULL) {
2071 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2072 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002073
Valerio Settic689ed82022-12-07 14:40:38 +01002074 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 if ((pw == NULL) || (pw_len == 0)) {
2076 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2077 }
Valerio Settic689ed82022-12-07 14:40:38 +01002078
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002080 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002082 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2086 role,
2087 MBEDTLS_MD_SHA256,
2088 MBEDTLS_ECP_DP_SECP256R1,
2089 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002090}
Valerio Setti02c25b52022-11-15 14:08:42 +01002091#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002092#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002093
Ronald Cron73fe8df2022-10-05 14:31:43 +02002094#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002095int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002096{
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (conf->psk_identity == NULL ||
2098 conf->psk_identity_len == 0) {
2099 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002100 }
2101
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002102#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2104 return 1;
2105 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002106#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (conf->psk != NULL && conf->psk_len != 0) {
2109 return 1;
2110 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002113}
2114
Gilles Peskine449bd832023-01-11 14:50:10 +01002115static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002116{
2117 /* Remove reference to existing PSK, if any. */
2118#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002120 /* The maintenance of the PSK key slot is the
2121 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002122 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002123 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002124#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 if (conf->psk != NULL) {
2126 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002127
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 mbedtls_free(conf->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002129 conf->psk = NULL;
2130 conf->psk_len = 0;
2131 }
2132
2133 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 if (conf->psk_identity != NULL) {
2135 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002136 conf->psk_identity = NULL;
2137 conf->psk_identity_len = 0;
2138 }
2139}
2140
Hanno Becker7390c712018-11-15 13:33:04 +00002141/* This function assumes that PSK identity in the SSL config is unset.
2142 * It checks that the provided identity is well-formed and attempts
2143 * to make a copy of it in the SSL config.
2144 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002145MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002146static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2147 unsigned char const *psk_identity,
2148 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002149{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002150 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002152 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 (psk_identity_len >> 16) != 0 ||
2154 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2155 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002156 }
2157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2159 if (conf->psk_identity == NULL) {
2160 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2161 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002162
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002163 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002167}
2168
Gilles Peskine449bd832023-01-11 14:50:10 +01002169int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2170 const unsigned char *psk, size_t psk_len,
2171 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002172{
Janos Follath865b3eb2019-12-16 11:46:15 +00002173 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002174
2175 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2177 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2178 }
Hanno Becker7390c712018-11-15 13:33:04 +00002179
2180 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 if (psk == NULL) {
2182 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2183 }
2184 if (psk_len == 0) {
2185 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2186 }
2187 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2188 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2189 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002190
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2192 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2193 }
Hanno Becker7390c712018-11-15 13:33:04 +00002194 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002196
2197 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2199 if (ret != 0) {
2200 ssl_conf_remove_psk(conf);
2201 }
Hanno Becker7390c712018-11-15 13:33:04 +00002202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002204}
2205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002207{
2208#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002210 /* The maintenance of the external PSK key slot is the
2211 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 if (ssl->handshake->psk_opaque_is_internal) {
2213 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002214 ssl->handshake->psk_opaque_is_internal = 0;
2215 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002216 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002217 }
Neil Armstronge952a302022-05-03 10:22:14 +02002218#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 if (ssl->handshake->psk != NULL) {
2220 mbedtls_platform_zeroize(ssl->handshake->psk,
2221 ssl->handshake->psk_len);
2222 mbedtls_free(ssl->handshake->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002223 ssl->handshake->psk_len = 0;
2224 }
Neil Armstronge952a302022-05-03 10:22:14 +02002225#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002226}
2227
Gilles Peskine449bd832023-01-11 14:50:10 +01002228int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2229 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002230{
Neil Armstrong501c9322022-05-03 09:35:09 +02002231#if defined(MBEDTLS_USE_PSA_CRYPTO)
2232 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002233 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002234 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002235 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002236#endif /* MBEDTLS_USE_PSA_CRYPTO */
2237
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 if (psk == NULL || ssl->handshake == NULL) {
2239 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2240 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2243 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2244 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002245
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002247
Neil Armstrong501c9322022-05-03 09:35:09 +02002248#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002249#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2251 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2252 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2253 } else {
2254 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2255 }
2256 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002257 }
2258#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002259
Jerry Yu568ec252022-07-22 21:27:34 +08002260#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2262 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2263 psa_set_key_usage_flags(&key_attributes,
2264 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002265 }
2266#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 psa_set_key_algorithm(&key_attributes, alg);
2269 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2272 if (status != PSA_SUCCESS) {
2273 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2274 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002275
2276 /* Allow calling psa_destroy_key() on psk remove */
2277 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002279#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2281 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2282 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002283
2284 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002286
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002288#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002289}
2290
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002291#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002292int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2293 mbedtls_svc_key_id_t psk,
2294 const unsigned char *psk_identity,
2295 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002296{
Janos Follath865b3eb2019-12-16 11:46:15 +00002297 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002298
2299 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2301 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2302 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002303
Hanno Becker7390c712018-11-15 13:33:04 +00002304 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 if (mbedtls_svc_key_id_is_null(psk)) {
2306 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2307 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002308 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002309
2310 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2312 psk_identity_len);
2313 if (ret != 0) {
2314 ssl_conf_remove_psk(conf);
2315 }
Hanno Becker7390c712018-11-15 13:33:04 +00002316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002318}
2319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2321 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002322{
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 if ((mbedtls_svc_key_id_is_null(psk)) ||
2324 (ssl->handshake == NULL)) {
2325 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2326 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002327
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002329 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002331}
2332#endif /* MBEDTLS_USE_PSA_CRYPTO */
2333
Jerry Yu8897c072022-08-12 13:56:53 +08002334#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002335void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2336 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2337 size_t),
2338 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002339{
2340 conf->f_psk = f_psk;
2341 conf->p_psk = p_psk;
2342}
Jerry Yu8897c072022-08-12 13:56:53 +08002343#endif /* MBEDTLS_SSL_SRV_C */
2344
Ronald Cron73fe8df2022-10-05 14:31:43 +02002345#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002346
2347#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002348static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002350{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002351#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 if (alg == PSA_ALG_CBC_NO_PADDING) {
2353 return MBEDTLS_SSL_MODE_CBC;
2354 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002355#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 if (PSA_ALG_IS_AEAD(alg)) {
2357 return MBEDTLS_SSL_MODE_AEAD;
2358 }
2359 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002360}
2361
2362#else /* MBEDTLS_USE_PSA_CRYPTO */
2363
2364static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002366{
2367#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 if (mode == MBEDTLS_MODE_CBC) {
2369 return MBEDTLS_SSL_MODE_CBC;
2370 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002371#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2372
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002373#if defined(MBEDTLS_GCM_C) || \
2374 defined(MBEDTLS_CCM_C) || \
2375 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002377 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 mode == MBEDTLS_MODE_CHACHAPOLY) {
2379 return MBEDTLS_SSL_MODE_AEAD;
2380 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002382
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002384}
Gilles Peskine301711e2022-04-26 16:57:05 +02002385#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002386
Gilles Peskinee108d982022-04-26 16:50:40 +02002387static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2388 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002390{
2391#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2393 base_mode == MBEDTLS_SSL_MODE_CBC) {
2394 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002395 }
2396#else
2397 (void) encrypt_then_mac;
2398#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002400}
2401
Neil Armstrongab555e02022-04-04 11:07:59 +02002402mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002404{
Gilles Peskinee108d982022-04-26 16:50:40 +02002405 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002406#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002408#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002410#endif
2411 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002412
Gilles Peskinee108d982022-04-26 16:50:40 +02002413 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002414#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002415 encrypt_then_mac = transform->encrypt_then_mac;
2416#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002418}
2419
Neil Armstrongab555e02022-04-04 11:07:59 +02002420mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002421#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002423#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002425{
Gilles Peskinee108d982022-04-26 16:50:40 +02002426 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2427
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002428#if defined(MBEDTLS_USE_PSA_CRYPTO)
2429 psa_status_t status;
2430 psa_algorithm_t alg;
2431 psa_key_type_t type;
2432 size_t size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 status = mbedtls_ssl_cipher_to_psa(suite->cipher, 0, &alg, &type, &size);
2434 if (status == PSA_SUCCESS) {
2435 base_mode = mbedtls_ssl_get_base_mode(alg);
2436 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002437#else
2438 const mbedtls_cipher_info_t *cipher =
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 mbedtls_cipher_info_from_type(suite->cipher);
2440 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002441 base_mode =
2442 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002444 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002445#endif /* MBEDTLS_USE_PSA_CRYPTO */
2446
Gilles Peskinee108d982022-04-26 16:50:40 +02002447#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2448 int encrypt_then_mac = 0;
2449#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002451}
2452
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002453#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002454
2455#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002456/* Serialization of TLS 1.3 sessions:
2457 *
2458 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002459 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002460 * uint64 ticket_received;
2461 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002462 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002463 * } ClientOnlyData;
2464 *
2465 * struct {
2466 * uint8 endpoint;
2467 * uint8 ciphersuite[2];
2468 * uint32 ticket_age_add;
2469 * uint8 ticket_flags;
2470 * opaque resumption_key<0..255>;
2471 * select ( endpoint ) {
2472 * case client: ClientOnlyData;
2473 * case server: uint64 start_time;
2474 * };
2475 * } serialized_session_tls13;
2476 *
2477 */
2478#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002479MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002480static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2481 unsigned char *buf,
2482 size_t buf_len,
2483 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002484{
2485 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002486#if defined(MBEDTLS_SSL_CLI_C) && \
2487 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 size_t hostname_len = (session->hostname == NULL) ?
2489 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002490#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002491 size_t needed = 1 /* endpoint */
2492 + 2 /* ciphersuite */
2493 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002494 + 1 /* ticket_flags */
2495 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002496 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002497
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2499 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2500 }
Jerry Yu34191072022-08-18 10:32:09 +08002501 needed += session->resumption_key_len; /* resumption_key */
2502
Jerry Yu438ddd82022-07-07 06:55:50 +00002503#if defined(MBEDTLS_HAVE_TIME)
2504 needed += 8; /* start_time or ticket_received */
2505#endif
2506
2507#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002509#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002510 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002512#endif
2513
Jerry Yu438ddd82022-07-07 06:55:50 +00002514 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002515 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002516
2517 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 if (session->ticket_len > SIZE_MAX - needed) {
2519 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2520 }
Jerry Yu34191072022-08-18 10:32:09 +08002521
Jerry Yue28d9742022-08-18 15:44:03 +08002522 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002523 }
2524#endif /* MBEDTLS_SSL_CLI_C */
2525
Jerry Yue36fdd62022-08-17 21:31:36 +08002526 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 if (needed > buf_len) {
2528 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2529 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002530
2531 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2533 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002534 p[7] = session->ticket_flags;
2535
2536 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002537 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002538 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002540 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002541
2542#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002543 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2544 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002545 p += 8;
2546 }
2547#endif /* MBEDTLS_HAVE_TIME */
2548
2549#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002551#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002553 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002555 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002557 p += hostname_len;
2558 }
2559#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2560
Jerry Yu438ddd82022-07-07 06:55:50 +00002561#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002563 p += 8;
2564#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002566 p += 4;
2567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002569 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002570
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 if (session->ticket != NULL && session->ticket_len > 0) {
2572 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002573 p += session->ticket_len;
2574 }
2575 }
2576#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002578}
2579
2580MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002581static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2582 const unsigned char *buf,
2583 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002584{
2585 const unsigned char *p = buf;
2586 const unsigned char *end = buf + len;
2587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 if (end - p < 9) {
2589 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2590 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002591 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2593 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002594 session->ticket_flags = p[7];
2595
2596 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002597 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002598 p += 9;
2599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if (end - p < session->resumption_key_len) {
2601 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2602 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002603
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2605 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2606 }
2607 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002608 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002609
2610#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2612 if (end - p < 8) {
2613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2614 }
2615 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002616 p += 8;
2617 }
2618#endif /* MBEDTLS_HAVE_TIME */
2619
2620#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002622#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002624 size_t hostname_len;
2625 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 if (end - p < 2) {
2627 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2628 }
2629 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002630 p += 2;
2631
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 if (end - p < (long int) hostname_len) {
2633 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2634 }
2635 if (hostname_len > 0) {
2636 session->hostname = mbedtls_calloc(1, hostname_len);
2637 if (session->hostname == NULL) {
2638 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2639 }
2640 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002641 p += hostname_len;
2642 }
2643#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2644 MBEDTLS_SSL_SESSION_TICKETS */
2645
Jerry Yu438ddd82022-07-07 06:55:50 +00002646#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 if (end - p < 8) {
2648 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2649 }
2650 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002651 p += 8;
2652#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 if (end - p < 4) {
2654 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2655 }
2656 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002657 p += 4;
2658
Gilles Peskine449bd832023-01-11 14:50:10 +01002659 if (end - p < 2) {
2660 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2661 }
2662 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002663 p += 2;
2664
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 if (end - p < (long int) session->ticket_len) {
2666 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2667 }
2668 if (session->ticket_len > 0) {
2669 session->ticket = mbedtls_calloc(1, session->ticket_len);
2670 if (session->ticket == NULL) {
2671 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2672 }
2673 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002674 p += session->ticket_len;
2675 }
2676 }
2677#endif /* MBEDTLS_SSL_CLI_C */
2678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002680
2681}
2682#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002683MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002684static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2685 unsigned char *buf,
2686 size_t buf_len,
2687 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002688{
2689 ((void) session);
2690 ((void) buf);
2691 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002692 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002693 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002694}
Jerry Yu438ddd82022-07-07 06:55:50 +00002695
Gilles Peskine449bd832023-01-11 14:50:10 +01002696static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2697 unsigned char *buf,
2698 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002699{
2700 ((void) session);
2701 ((void) buf);
2702 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002704}
2705#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002706#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2707
Gilles Peskine449bd832023-01-11 14:50:10 +01002708psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2709 size_t taglen,
2710 psa_algorithm_t *alg,
2711 psa_key_type_t *key_type,
2712 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002713{
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002715 case MBEDTLS_CIPHER_AES_128_CBC:
2716 *alg = PSA_ALG_CBC_NO_PADDING;
2717 *key_type = PSA_KEY_TYPE_AES;
2718 *key_size = 128;
2719 break;
2720 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002722 *key_type = PSA_KEY_TYPE_AES;
2723 *key_size = 128;
2724 break;
2725 case MBEDTLS_CIPHER_AES_128_GCM:
2726 *alg = PSA_ALG_GCM;
2727 *key_type = PSA_KEY_TYPE_AES;
2728 *key_size = 128;
2729 break;
2730 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002731 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002732 *key_type = PSA_KEY_TYPE_AES;
2733 *key_size = 192;
2734 break;
2735 case MBEDTLS_CIPHER_AES_192_GCM:
2736 *alg = PSA_ALG_GCM;
2737 *key_type = PSA_KEY_TYPE_AES;
2738 *key_size = 192;
2739 break;
2740 case MBEDTLS_CIPHER_AES_256_CBC:
2741 *alg = PSA_ALG_CBC_NO_PADDING;
2742 *key_type = PSA_KEY_TYPE_AES;
2743 *key_size = 256;
2744 break;
2745 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002747 *key_type = PSA_KEY_TYPE_AES;
2748 *key_size = 256;
2749 break;
2750 case MBEDTLS_CIPHER_AES_256_GCM:
2751 *alg = PSA_ALG_GCM;
2752 *key_type = PSA_KEY_TYPE_AES;
2753 *key_size = 256;
2754 break;
2755 case MBEDTLS_CIPHER_ARIA_128_CBC:
2756 *alg = PSA_ALG_CBC_NO_PADDING;
2757 *key_type = PSA_KEY_TYPE_ARIA;
2758 *key_size = 128;
2759 break;
2760 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002762 *key_type = PSA_KEY_TYPE_ARIA;
2763 *key_size = 128;
2764 break;
2765 case MBEDTLS_CIPHER_ARIA_128_GCM:
2766 *alg = PSA_ALG_GCM;
2767 *key_type = PSA_KEY_TYPE_ARIA;
2768 *key_size = 128;
2769 break;
2770 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002772 *key_type = PSA_KEY_TYPE_ARIA;
2773 *key_size = 192;
2774 break;
2775 case MBEDTLS_CIPHER_ARIA_192_GCM:
2776 *alg = PSA_ALG_GCM;
2777 *key_type = PSA_KEY_TYPE_ARIA;
2778 *key_size = 192;
2779 break;
2780 case MBEDTLS_CIPHER_ARIA_256_CBC:
2781 *alg = PSA_ALG_CBC_NO_PADDING;
2782 *key_type = PSA_KEY_TYPE_ARIA;
2783 *key_size = 256;
2784 break;
2785 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002787 *key_type = PSA_KEY_TYPE_ARIA;
2788 *key_size = 256;
2789 break;
2790 case MBEDTLS_CIPHER_ARIA_256_GCM:
2791 *alg = PSA_ALG_GCM;
2792 *key_type = PSA_KEY_TYPE_ARIA;
2793 *key_size = 256;
2794 break;
2795 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2796 *alg = PSA_ALG_CBC_NO_PADDING;
2797 *key_type = PSA_KEY_TYPE_CAMELLIA;
2798 *key_size = 128;
2799 break;
2800 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002802 *key_type = PSA_KEY_TYPE_CAMELLIA;
2803 *key_size = 128;
2804 break;
2805 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2806 *alg = PSA_ALG_GCM;
2807 *key_type = PSA_KEY_TYPE_CAMELLIA;
2808 *key_size = 128;
2809 break;
2810 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002812 *key_type = PSA_KEY_TYPE_CAMELLIA;
2813 *key_size = 192;
2814 break;
2815 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2816 *alg = PSA_ALG_GCM;
2817 *key_type = PSA_KEY_TYPE_CAMELLIA;
2818 *key_size = 192;
2819 break;
2820 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2821 *alg = PSA_ALG_CBC_NO_PADDING;
2822 *key_type = PSA_KEY_TYPE_CAMELLIA;
2823 *key_size = 256;
2824 break;
2825 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002827 *key_type = PSA_KEY_TYPE_CAMELLIA;
2828 *key_size = 256;
2829 break;
2830 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2831 *alg = PSA_ALG_GCM;
2832 *key_type = PSA_KEY_TYPE_CAMELLIA;
2833 *key_size = 256;
2834 break;
2835 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2836 *alg = PSA_ALG_CHACHA20_POLY1305;
2837 *key_type = PSA_KEY_TYPE_CHACHA20;
2838 *key_size = 256;
2839 break;
2840 case MBEDTLS_CIPHER_NULL:
2841 *alg = MBEDTLS_SSL_NULL_CIPHER;
2842 *key_type = 0;
2843 *key_size = 0;
2844 break;
2845 default:
2846 return PSA_ERROR_NOT_SUPPORTED;
2847 }
2848
2849 return PSA_SUCCESS;
2850}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002851#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002852
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002853#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002854int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2855 const unsigned char *dhm_P, size_t P_len,
2856 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002857{
Janos Follath865b3eb2019-12-16 11:46:15 +00002858 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 mbedtls_mpi_free(&conf->dhm_P);
2861 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2864 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2865 mbedtls_mpi_free(&conf->dhm_P);
2866 mbedtls_mpi_free(&conf->dhm_G);
2867 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002868 }
2869
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002871}
Paul Bakker5121ce52009-01-03 21:22:43 +00002872
Gilles Peskine449bd832023-01-11 14:50:10 +01002873int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002874{
Janos Follath865b3eb2019-12-16 11:46:15 +00002875 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 mbedtls_mpi_free(&conf->dhm_P);
2878 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002879
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2881 &conf->dhm_P)) != 0 ||
2882 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2883 &conf->dhm_G)) != 0) {
2884 mbedtls_mpi_free(&conf->dhm_P);
2885 mbedtls_mpi_free(&conf->dhm_G);
2886 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002887 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002888
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002890}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002891#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002892
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002893#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2894/*
2895 * Set the minimum length for Diffie-Hellman parameters
2896 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002897void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2898 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002899{
2900 conf->dhm_min_bitlen = bitlen;
2901}
2902#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2903
Ronald Crone68ab4f2022-10-05 12:46:29 +02002904#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002905#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002906/*
2907 * Set allowed/preferred hashes for handshake signatures
2908 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002909void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2910 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002911{
2912 conf->sig_hashes = hashes;
2913}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002914#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002915
Jerry Yuf017ee42022-01-12 15:49:48 +08002916/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002917void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2918 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002919{
Jerry Yuf017ee42022-01-12 15:49:48 +08002920#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2921 conf->sig_hashes = NULL;
2922#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2923 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002924}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002925#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002926
Valerio Setti6f0441d2023-07-03 12:11:36 +02002927#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01002928#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002929/*
2930 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002931 *
2932 * mbedtls_ssl_setup() takes the provided list
2933 * and translates it to a list of IANA TLS group identifiers,
2934 * stored in ssl->handshake->group_list.
2935 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002936 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002937void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2938 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002939{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002940 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002941 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002942}
Brett Warrene0edc842021-08-17 09:53:13 +01002943#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02002944#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002945
Brett Warrene0edc842021-08-17 09:53:13 +01002946/*
2947 * Set the allowed groups
2948 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002949void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2950 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002951{
Valerio Setti6f0441d2023-07-03 12:11:36 +02002952#if defined(MBEDTLS_PK_HAVE_ECC_KEYS) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002953 conf->curve_list = NULL;
2954#endif
2955 conf->group_list = group_list;
2956}
2957
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002958#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002959int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002960{
Hanno Becker947194e2017-04-07 13:25:49 +01002961 /* Initialize to suppress unnecessary compiler warning */
2962 size_t hostname_len = 0;
2963
2964 /* Check if new hostname is valid before
2965 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 if (hostname != NULL) {
2967 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002968
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2970 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2971 }
Hanno Becker947194e2017-04-07 13:25:49 +01002972 }
2973
2974 /* Now it's clear that we will overwrite the old hostname,
2975 * so we can free it safely */
2976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 if (ssl->hostname != NULL) {
2978 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
2979 mbedtls_free(ssl->hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002980 }
2981
2982 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002983
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002985 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 } else {
2987 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2988 if (ssl->hostname == NULL) {
2989 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2990 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002993
Hanno Becker947194e2017-04-07 13:25:49 +01002994 ssl->hostname[hostname_len] = '\0';
2995 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002996
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002998}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002999#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003000
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003001#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003002void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3003 int (*f_sni)(void *, mbedtls_ssl_context *,
3004 const unsigned char *, size_t),
3005 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003006{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003007 conf->f_sni = f_sni;
3008 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003009}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003011
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003013int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003014{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003015 size_t cur_len, tot_len;
3016 const char **p;
3017
3018 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003019 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3020 * MUST NOT be truncated."
3021 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003022 */
3023 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 for (p = protos; *p != NULL; p++) {
3025 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003026 tot_len += cur_len;
3027
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 if ((cur_len == 0) ||
3029 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3030 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3031 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3032 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003033 }
3034
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003035 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003036
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003038}
3039
Gilles Peskine449bd832023-01-11 14:50:10 +01003040const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003041{
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003043}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003044#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003045
Johan Pascalb62bb512015-12-03 21:56:45 +01003046#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003047void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3048 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003049{
3050 conf->dtls_srtp_mki_support = support_mki_value;
3051}
3052
Gilles Peskine449bd832023-01-11 14:50:10 +01003053int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3054 unsigned char *mki_value,
3055 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003056{
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3058 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003059 }
Ron Eldor591f1622018-01-22 12:30:04 +02003060
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3062 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003063 }
Ron Eldor591f1622018-01-22 12:30:04 +02003064
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003066 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003068}
3069
Gilles Peskine449bd832023-01-11 14:50:10 +01003070int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3071 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003072{
Johan Pascal253d0262020-09-22 13:04:45 +02003073 const mbedtls_ssl_srtp_profile *p;
3074 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003075
Johan Pascal253d0262020-09-22 13:04:45 +02003076 /* check the profiles list: all entry must be valid,
3077 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3079 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3080 p++) {
3081 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003082 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003084 /* unsupported value, stop parsing and set the size to an error value */
3085 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003086 }
3087 }
3088
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3090 conf->dtls_srtp_profile_list = NULL;
3091 conf->dtls_srtp_profile_list_len = 0;
3092 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003093 }
3094
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003095 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003096 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003097
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003099}
3100
Gilles Peskine449bd832023-01-11 14:50:10 +01003101void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3102 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003103{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003104 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3105 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003107 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003109 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3111 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003112 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003113}
Johan Pascalb62bb512015-12-03 21:56:45 +01003114#endif /* MBEDTLS_SSL_DTLS_SRTP */
3115
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303116#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003117void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003118{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003119 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00003120}
3121
Gilles Peskine449bd832023-01-11 14:50:10 +01003122void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003123{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003124 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00003125}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303126#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003127
Janos Follath088ce432017-04-10 12:42:31 +01003128#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003129void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3130 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003131{
3132 conf->cert_req_ca_list = cert_req_ca_list;
3133}
3134#endif
3135
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003137void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003138{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003139 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003140}
3141#endif
3142
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003143#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003144void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003145{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003146 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003147}
3148#endif
3149
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003151int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003152{
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3154 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3155 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003156 }
3157
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003158 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003159
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003161}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003162#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003163
Gilles Peskine449bd832023-01-11 14:50:10 +01003164void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003165{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003166 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003167}
3168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003169#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003170void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003171{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003172 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003173}
3174
Gilles Peskine449bd832023-01-11 14:50:10 +01003175void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003176{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003177 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003178}
3179
Gilles Peskine449bd832023-01-11 14:50:10 +01003180void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3181 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003182{
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003184}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003186
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003187#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003188#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003189void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003190{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003191 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003192}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003193#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003194
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003195#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003196
Jerry Yud0766ec2022-09-22 10:46:57 +08003197#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003198void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3199 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003200{
Jerry Yud0766ec2022-09-22 10:46:57 +08003201 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003202}
3203#endif
3204
Gilles Peskine449bd832023-01-11 14:50:10 +01003205void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3206 mbedtls_ssl_ticket_write_t *f_ticket_write,
3207 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3208 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003209{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003210 conf->f_ticket_write = f_ticket_write;
3211 conf->f_ticket_parse = f_ticket_parse;
3212 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003213}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003214#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003215#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003216
Gilles Peskine449bd832023-01-11 14:50:10 +01003217void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3218 mbedtls_ssl_export_keys_t *f_export_keys,
3219 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003220{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003221 ssl->f_export_keys = f_export_keys;
3222 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003223}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003224
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003225#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003226void mbedtls_ssl_conf_async_private_cb(
3227 mbedtls_ssl_config *conf,
3228 mbedtls_ssl_async_sign_t *f_async_sign,
3229 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3230 mbedtls_ssl_async_resume_t *f_async_resume,
3231 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003232 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003233{
3234 conf->f_async_sign_start = f_async_sign;
3235 conf->f_async_decrypt_start = f_async_decrypt;
3236 conf->f_async_resume = f_async_resume;
3237 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003238 conf->p_async_config_data = async_config_data;
3239}
3240
Gilles Peskine449bd832023-01-11 14:50:10 +01003241void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003242{
Gilles Peskine449bd832023-01-11 14:50:10 +01003243 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003244}
3245
Gilles Peskine449bd832023-01-11 14:50:10 +01003246void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003247{
Gilles Peskine449bd832023-01-11 14:50:10 +01003248 if (ssl->handshake == NULL) {
3249 return NULL;
3250 } else {
3251 return ssl->handshake->user_async_ctx;
3252 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003253}
3254
Gilles Peskine449bd832023-01-11 14:50:10 +01003255void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3256 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003257{
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003259 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003260 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003261}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003262#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003263
Paul Bakker5121ce52009-01-03 21:22:43 +00003264/*
3265 * SSL get accessors
3266 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003267uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003268{
Gilles Peskine449bd832023-01-11 14:50:10 +01003269 if (ssl->session != NULL) {
3270 return ssl->session->verify_result;
3271 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003272
Gilles Peskine449bd832023-01-11 14:50:10 +01003273 if (ssl->session_negotiate != NULL) {
3274 return ssl->session_negotiate->verify_result;
3275 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003276
Gilles Peskine449bd832023-01-11 14:50:10 +01003277 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003278}
3279
Gilles Peskine449bd832023-01-11 14:50:10 +01003280int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003281{
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 if (ssl == NULL || ssl->session == NULL) {
3283 return 0;
3284 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003285
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003287}
3288
Gilles Peskine449bd832023-01-11 14:50:10 +01003289const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003290{
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 if (ssl == NULL || ssl->session == NULL) {
3292 return NULL;
3293 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003294
Gilles Peskine449bd832023-01-11 14:50:10 +01003295 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003296}
3297
Gilles Peskine449bd832023-01-11 14:50:10 +01003298const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003299{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003300#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3302 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003303 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003304 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003305 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003307 }
3308 }
3309#endif
3310
Gilles Peskine449bd832023-01-11 14:50:10 +01003311 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003312 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003313 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003314 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003316 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003318 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003319}
3320
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003321#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003322size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003323{
David Horstmann95d516f2021-05-04 18:36:56 +01003324 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003325 size_t read_mfl;
3326
Jerry Yuddda0502022-12-01 19:43:12 +08003327#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003328 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003329 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3330 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3331 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003332 }
Jerry Yuddda0502022-12-01 19:43:12 +08003333#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003334
3335 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 if (ssl->session_out != NULL) {
3337 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3338 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003339 max_len = read_mfl;
3340 }
3341 }
3342
Jerry Yuddda0502022-12-01 19:43:12 +08003343 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 if (ssl->session_negotiate != NULL) {
3345 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3346 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003347 max_len = read_mfl;
3348 }
3349 }
3350
Gilles Peskine449bd832023-01-11 14:50:10 +01003351 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003352}
3353
Gilles Peskine449bd832023-01-11 14:50:10 +01003354size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003355{
3356 size_t max_len;
3357
3358 /*
3359 * Assume mfl_code is correct since it was checked when set
3360 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003362
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003363 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003364 if (ssl->session_out != NULL &&
3365 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3366 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003367 }
3368
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003369 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 if (ssl->session_negotiate != NULL &&
3371 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3372 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003373 }
3374
Gilles Peskine449bd832023-01-11 14:50:10 +01003375 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003376}
3377#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3378
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003379#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003380size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003381{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003382 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003383 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3384 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3385 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3386 return 0;
3387 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003388
Gilles Peskine449bd832023-01-11 14:50:10 +01003389 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3390 return ssl->mtu;
3391 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003392
Gilles Peskine449bd832023-01-11 14:50:10 +01003393 if (ssl->mtu == 0) {
3394 return ssl->handshake->mtu;
3395 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003396
Gilles Peskine449bd832023-01-11 14:50:10 +01003397 return ssl->mtu < ssl->handshake->mtu ?
3398 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003399}
3400#endif /* MBEDTLS_SSL_PROTO_DTLS */
3401
Gilles Peskine449bd832023-01-11 14:50:10 +01003402int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003403{
3404 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3405
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003406#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3407 !defined(MBEDTLS_SSL_PROTO_DTLS)
3408 (void) ssl;
3409#endif
3410
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003411#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003412 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003413
Gilles Peskine449bd832023-01-11 14:50:10 +01003414 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003415 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003416 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003417#endif
3418
3419#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3421 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3422 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003423 const size_t overhead = (size_t) ret;
3424
Gilles Peskine449bd832023-01-11 14:50:10 +01003425 if (ret < 0) {
3426 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003427 }
3428
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 if (mtu <= overhead) {
3430 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3431 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3432 }
3433
3434 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003435 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003436 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003437 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003438#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003439
Hanno Becker0defedb2018-08-10 12:35:02 +01003440#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3441 !defined(MBEDTLS_SSL_PROTO_DTLS)
3442 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003443#endif
3444
Gilles Peskine449bd832023-01-11 14:50:10 +01003445 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003446}
3447
Gilles Peskine449bd832023-01-11 14:50:10 +01003448int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003449{
3450 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3451
3452#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3453 (void) ssl;
3454#endif
3455
3456#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003457 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003458
Gilles Peskine449bd832023-01-11 14:50:10 +01003459 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003460 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003461 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003462#endif
3463
Gilles Peskine449bd832023-01-11 14:50:10 +01003464 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003465}
3466
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003467#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003468const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003469{
Gilles Peskine449bd832023-01-11 14:50:10 +01003470 if (ssl == NULL || ssl->session == NULL) {
3471 return NULL;
3472 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003473
Hanno Beckere6824572019-02-07 13:18:46 +00003474#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003475 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003476#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003477 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003478#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003479}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003481
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003482#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003483int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3484 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003485{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003486 int ret;
3487
Gilles Peskine449bd832023-01-11 14:50:10 +01003488 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003489 dst == NULL ||
3490 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003491 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3492 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003493 }
3494
Hanno Beckere810bbc2021-05-14 16:01:05 +01003495 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3496 * idempotent: Each session can only be exported once.
3497 *
3498 * (This is in preparation for TLS 1.3 support where we will
3499 * need the ability to export multiple sessions (aka tickets),
3500 * which will be achieved by calling mbedtls_ssl_get_session()
3501 * multiple times until it fails.)
3502 *
3503 * Check whether we have already exported the current session,
3504 * and fail if so.
3505 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003506 if (ssl->session->exported == 1) {
3507 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3508 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003509
Gilles Peskine449bd832023-01-11 14:50:10 +01003510 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3511 if (ret != 0) {
3512 return ret;
3513 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003514
3515 /* Remember that we've exported the session. */
3516 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003517 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003518}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003519#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003520
Paul Bakker5121ce52009-01-03 21:22:43 +00003521/*
Hanno Beckera835da52019-05-16 12:39:07 +01003522 * Define ticket header determining Mbed TLS version
3523 * and structure of the ticket.
3524 */
3525
Hanno Becker94ef3b32019-05-16 12:50:45 +01003526/*
Hanno Becker50b59662019-05-28 14:30:45 +01003527 * Define bitflag determining compile-time settings influencing
3528 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003529 */
3530
Hanno Becker50b59662019-05-28 14:30:45 +01003531#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003532#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003533#else
Hanno Becker3e088662019-05-29 11:10:18 +01003534#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003535#endif /* MBEDTLS_HAVE_TIME */
3536
3537#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003538#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003539#else
Hanno Becker3e088662019-05-29 11:10:18 +01003540#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003541#endif /* MBEDTLS_X509_CRT_PARSE_C */
3542
3543#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003544#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003545#else
Hanno Becker3e088662019-05-29 11:10:18 +01003546#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003547#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3548
3549#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003550#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003551#else
Hanno Becker3e088662019-05-29 11:10:18 +01003552#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003553#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3554
Hanno Becker94ef3b32019-05-16 12:50:45 +01003555#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003556#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003557#else
Hanno Becker3e088662019-05-29 11:10:18 +01003558#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003559#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3560
Hanno Becker94ef3b32019-05-16 12:50:45 +01003561#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3562#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3563#else
3564#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3565#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3566
Hanno Becker3e088662019-05-29 11:10:18 +01003567#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3568#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3569#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3570#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003571#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3572#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003573
Hanno Becker50b59662019-05-28 14:30:45 +01003574#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003575 ((uint16_t) ( \
3576 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3577 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3578 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3579 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3580 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3581 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3582 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003583
Hanno Beckerf8787072019-05-16 12:41:07 +01003584static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003585 MBEDTLS_VERSION_MAJOR,
3586 MBEDTLS_VERSION_MINOR,
3587 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003588 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3589 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003590};
Hanno Beckera835da52019-05-16 12:39:07 +01003591
3592/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003593 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003594 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003595 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003596 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003597 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003598 * opaque mbedtls_version[3]; // library version: major, minor, patch
3599 * opaque session_format[2]; // library-version specific 16-bit field
3600 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003601 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003602 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003603 * Note: When updating the format, remember to keep
3604 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003605 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003606 * // In this version, `session_format` determines
3607 * // the setting of those compile-time
3608 * // configuration options which influence
3609 * // the structure of mbedtls_ssl_session.
3610 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003611 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003612 * // - TLS 1.2 (0x0303)
3613 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003614 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003615 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003616 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003617 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003618 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003619 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003620 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003621 *
3622 * };
3623 *
3624 * } serialized_session;
3625 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003626 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003627
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003628MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003629static int ssl_session_save(const mbedtls_ssl_session *session,
3630 unsigned char omit_header,
3631 unsigned char *buf,
3632 size_t buf_len,
3633 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003634{
3635 unsigned char *p = buf;
3636 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003637 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003638#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3639 size_t out_len;
3640 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3641#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003642 if (session == NULL) {
3643 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3644 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003645
Gilles Peskine449bd832023-01-11 14:50:10 +01003646 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003647 /*
3648 * Add Mbed TLS version identifier
3649 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003650 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003651
Gilles Peskine449bd832023-01-11 14:50:10 +01003652 if (used <= buf_len) {
3653 memcpy(p, ssl_serialized_session_header,
3654 sizeof(ssl_serialized_session_header));
3655 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003656 }
3657 }
3658
3659 /*
3660 * TLS version identifier
3661 */
3662 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003663 if (used <= buf_len) {
3664 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003665 }
3666
3667 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003668 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003669 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003670#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003671 case MBEDTLS_SSL_VERSION_TLS1_2:
3672 used += ssl_tls12_session_save(session, p, remaining_len);
3673 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003674#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3675
Jerry Yu251a12e2022-07-13 15:15:48 +08003676#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003677 case MBEDTLS_SSL_VERSION_TLS1_3:
3678 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3679 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3680 return ret;
3681 }
3682 used += out_len;
3683 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003684#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3685
Gilles Peskine449bd832023-01-11 14:50:10 +01003686 default:
3687 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003688 }
3689
3690 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003691 if (used > buf_len) {
3692 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3693 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003694
Gilles Peskine449bd832023-01-11 14:50:10 +01003695 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003696}
3697
3698/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003699 * Public wrapper for ssl_session_save()
3700 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003701int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3702 unsigned char *buf,
3703 size_t buf_len,
3704 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003705{
Gilles Peskine449bd832023-01-11 14:50:10 +01003706 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003707}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003708
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003709/*
3710 * Deserialize session, see mbedtls_ssl_session_save() for format.
3711 *
3712 * This internal version is wrapped by a public function that cleans up in
3713 * case of error, and has an extra option omit_header.
3714 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003715MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003716static int ssl_session_load(mbedtls_ssl_session *session,
3717 unsigned char omit_header,
3718 const unsigned char *buf,
3719 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003720{
3721 const unsigned char *p = buf;
3722 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003723 size_t remaining_len;
3724
3725
Gilles Peskine449bd832023-01-11 14:50:10 +01003726 if (session == NULL) {
3727 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3728 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003729
Gilles Peskine449bd832023-01-11 14:50:10 +01003730 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003731 /*
3732 * Check Mbed TLS version identifier
3733 */
3734
Gilles Peskine449bd832023-01-11 14:50:10 +01003735 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3736 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003737 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003738
3739 if (memcmp(p, ssl_serialized_session_header,
3740 sizeof(ssl_serialized_session_header)) != 0) {
3741 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3742 }
3743 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003744 }
3745
3746 /*
3747 * TLS version identifier
3748 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003749 if (1 > (size_t) (end - p)) {
3750 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3751 }
Glenn Straussda7851c2022-03-14 13:29:48 -04003752 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003753
3754 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003755 remaining_len = (end - p);
3756 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003757#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003758 case MBEDTLS_SSL_VERSION_TLS1_2:
3759 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003760#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3761
Jerry Yu438ddd82022-07-07 06:55:50 +00003762#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003763 case MBEDTLS_SSL_VERSION_TLS1_3:
3764 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003765#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3766
Gilles Peskine449bd832023-01-11 14:50:10 +01003767 default:
3768 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003769 }
3770}
3771
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003772/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003773 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003774 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003775int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3776 const unsigned char *buf,
3777 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003778{
Gilles Peskine449bd832023-01-11 14:50:10 +01003779 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003780
Gilles Peskine449bd832023-01-11 14:50:10 +01003781 if (ret != 0) {
3782 mbedtls_ssl_session_free(session);
3783 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003784
Gilles Peskine449bd832023-01-11 14:50:10 +01003785 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003786}
3787
3788/*
Paul Bakker1961b702013-01-25 14:49:24 +01003789 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003790 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003791MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003792static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003793{
3794 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3795
Ronald Cron66dbf912022-02-02 15:33:46 +01003796 /*
3797 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003798 * that were written into the output buffer by the previous handshake step,
3799 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003800 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3801 * We proceed to the next handshake step only when all data from the
3802 * previous one have been sent to the peer, thus we make sure that this is
3803 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3804 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3805 * we have to wait before to go ahead.
3806 * In the case of TLS 1.3, handshake step handlers do not send data to the
3807 * peer. Data are only sent here and through
3808 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003809 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003810 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003811 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3812 return ret;
3813 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003814
3815#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003816 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3817 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3818 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3819 return ret;
3820 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003821 }
3822#endif /* MBEDTLS_SSL_PROTO_DTLS */
3823
Gilles Peskine449bd832023-01-11 14:50:10 +01003824 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003825}
3826
Gilles Peskine449bd832023-01-11 14:50:10 +01003827int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003828{
Hanno Becker41934dd2021-08-07 19:13:43 +01003829 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003830
Gilles Peskine449bd832023-01-11 14:50:10 +01003831 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003832 ssl->conf == NULL ||
3833 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003834 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3835 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003836 }
3837
Gilles Peskine449bd832023-01-11 14:50:10 +01003838 ret = ssl_prepare_handshake_step(ssl);
3839 if (ret != 0) {
3840 return ret;
3841 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003842
Gilles Peskine449bd832023-01-11 14:50:10 +01003843 ret = mbedtls_ssl_handle_pending_alert(ssl);
3844 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003845 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003846 }
Jerry Yue7047812021-09-13 19:26:39 +08003847
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003848 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3849 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3850 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3851
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003852#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003853 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3854 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
3855 mbedtls_ssl_states_str(ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003856
Gilles Peskine449bd832023-01-11 14:50:10 +01003857 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003858 case MBEDTLS_SSL_HELLO_REQUEST:
3859 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003860 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003861 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003862
Ronald Cron9f0fba32022-02-10 16:45:15 +01003863 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003864 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003865 break;
3866
3867 default:
3868#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003869 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3870 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3871 } else {
3872 ret = mbedtls_ssl_handshake_client_step(ssl);
3873 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003874#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003875 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003876#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003877 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003878#endif
3879 }
Jerry Yub9930e72021-08-06 17:11:51 +08003880 }
Ronald Cron6291b232023-03-08 15:51:25 +01003881#endif /* MBEDTLS_SSL_CLI_C */
3882
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003883#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003884 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003885#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3886 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003887 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003888 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003889 ret = mbedtls_ssl_handshake_server_step(ssl);
3890 }
Ronald Cron6291b232023-03-08 15:51:25 +01003891#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3892 ret = mbedtls_ssl_handshake_server_step(ssl);
3893#else
3894 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003895#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003896 }
3897#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003898
Gilles Peskine449bd832023-01-11 14:50:10 +01003899 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003900 /* handshake_step return error. And it is same
3901 * with alert_reason.
3902 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003903 if (ssl->send_alert) {
3904 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003905 goto cleanup;
3906 }
3907 }
3908
3909cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003910 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003911}
3912
3913/*
3914 * Perform the SSL handshake
3915 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003916int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003917{
3918 int ret = 0;
3919
Hanno Beckera817ea42020-10-20 15:20:23 +01003920 /* Sanity checks */
3921
Gilles Peskine449bd832023-01-11 14:50:10 +01003922 if (ssl == NULL || ssl->conf == NULL) {
3923 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3924 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003925
Hanno Beckera817ea42020-10-20 15:20:23 +01003926#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003927 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3928 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3929 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3930 "mbedtls_ssl_set_timer_cb() for DTLS"));
3931 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003932 }
3933#endif /* MBEDTLS_SSL_PROTO_DTLS */
3934
Gilles Peskine449bd832023-01-11 14:50:10 +01003935 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003936
Hanno Beckera817ea42020-10-20 15:20:23 +01003937 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3939 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003940
Gilles Peskine449bd832023-01-11 14:50:10 +01003941 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003942 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003943 }
Paul Bakker1961b702013-01-25 14:49:24 +01003944 }
3945
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003947
Gilles Peskine449bd832023-01-11 14:50:10 +01003948 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003949}
3950
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003951#if defined(MBEDTLS_SSL_RENEGOTIATION)
3952#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003953/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003954 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003955 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003956MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003957static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003958{
Janos Follath865b3eb2019-12-16 11:46:15 +00003959 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003960
Gilles Peskine449bd832023-01-11 14:50:10 +01003961 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003962
3963 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003964 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3965 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003966
Gilles Peskine449bd832023-01-11 14:50:10 +01003967 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3968 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3969 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003970 }
3971
Gilles Peskine449bd832023-01-11 14:50:10 +01003972 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003973
Gilles Peskine449bd832023-01-11 14:50:10 +01003974 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003975}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003976#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003977
3978/*
3979 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003980 * - any side: calling mbedtls_ssl_renegotiate(),
3981 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3982 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003983 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003984 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003985 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003986 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003987int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003988{
Janos Follath865b3eb2019-12-16 11:46:15 +00003989 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003990
Gilles Peskine449bd832023-01-11 14:50:10 +01003991 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00003992
Gilles Peskine449bd832023-01-11 14:50:10 +01003993 if ((ret = ssl_handshake_init(ssl)) != 0) {
3994 return ret;
3995 }
Paul Bakker48916f92012-09-16 19:57:18 +00003996
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003997 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3998 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003999#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004000 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4001 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4002 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004003 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004004 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004005 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004006 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004007 }
4008#endif
4009
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004010 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4011 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004012
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4014 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4015 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004016 }
4017
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004019
Gilles Peskine449bd832023-01-11 14:50:10 +01004020 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004021}
4022
4023/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004024 * Renegotiate current connection on client,
4025 * or request renegotiation on server
4026 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004027int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004028{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004029 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004030
Gilles Peskine449bd832023-01-11 14:50:10 +01004031 if (ssl == NULL || ssl->conf == NULL) {
4032 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4033 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004034
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004035#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004036 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4038 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4039 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4040 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004042 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004043
4044 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004045 if (ssl->out_left != 0) {
4046 return mbedtls_ssl_flush_output(ssl);
4047 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004048
Gilles Peskine449bd832023-01-11 14:50:10 +01004049 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004050 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004051#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004052
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004053#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004054 /*
4055 * On client, either start the renegotiation process or,
4056 * if already in progress, continue the handshake
4057 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4059 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4060 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004061 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004062
4063 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4064 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4065 return ret;
4066 }
4067 } else {
4068 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4069 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4070 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004071 }
4072 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004073#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004074
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004076}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004077#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004078
Gilles Peskine449bd832023-01-11 14:50:10 +01004079void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004080{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004081 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4082
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004084 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004086
Valerio Setti6f0441d2023-07-03 12:11:36 +02004087#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004088#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004089 if (ssl->handshake->group_list_heap_allocated) {
4090 mbedtls_free((void *) handshake->group_list);
4091 }
Brett Warrene0edc842021-08-17 09:53:13 +01004092 handshake->group_list = NULL;
4093#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004094#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004095
Ronald Crone68ab4f2022-10-05 12:46:29 +02004096#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004097#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004098 if (ssl->handshake->sig_algs_heap_allocated) {
4099 mbedtls_free((void *) handshake->sig_algs);
4100 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004101 handshake->sig_algs = NULL;
4102#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004103#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 if (ssl->handshake->certificate_request_context) {
4105 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004106 }
4107#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004108#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004109
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004110#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4112 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004113 handshake->async_in_progress = 0;
4114 }
4115#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4116
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004117#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004118#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004120#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004121 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004122#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004123#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004124#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004125#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004127#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004128 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004129#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004130#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004131
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004132#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004134#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02004135#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004137#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004138
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004139#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004140#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004141 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004142 /*
4143 * Opaque keys are not stored in the handshake's data and it's the user
4144 * responsibility to destroy them. Clear ones, instead, are created by
4145 * the TLS library and should be destroyed at the same level
4146 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4148 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004149 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004150 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4151#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004153#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004154#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004156 handshake->ecjpake_cache = NULL;
4157 handshake->ecjpake_cache_len = 0;
4158#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004159#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004160
Janos Follath4ae5c292016-02-10 11:27:43 +00004161#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4162 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004163 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004165#endif
4166
Ronald Cron73fe8df2022-10-05 14:31:43 +02004167#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004168#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004169 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004170 /* The maintenance of the external PSK key slot is the
4171 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 if (ssl->handshake->psk_opaque_is_internal) {
4173 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004174 ssl->handshake->psk_opaque_is_internal = 0;
4175 }
4176 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4177 }
Neil Armstronge952a302022-05-03 10:22:14 +02004178#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 if (handshake->psk != NULL) {
4180 mbedtls_platform_zeroize(handshake->psk, handshake->psk_len);
4181 mbedtls_free(handshake->psk);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004182 }
Neil Armstronge952a302022-05-03 10:22:14 +02004183#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004184#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004186#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4187 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004188 /*
4189 * Free only the linked list wrapper, not the keys themselves
4190 * since the belong to the SNI callback
4191 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004193#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004194
Gilles Peskineeccd8882020-03-10 12:19:08 +01004195#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4197 if (handshake->ecrs_peer_cert != NULL) {
4198 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4199 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004200 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004201#endif
4202
Hanno Becker75173122019-02-06 16:18:31 +00004203#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4204 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004206#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4207
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004208#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4210 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004211#endif /* MBEDTLS_SSL_CLI_C &&
4212 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004213
4214#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 mbedtls_ssl_flight_free(handshake->flight);
4216 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004217#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004218
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02004219#if (defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 (defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004221 if (handshake->xxdh_psa_privkey_is_external == 0) {
4222 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 }
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02004224#endif /* (PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH) &&
4225 (MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3) */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004226
Ronald Cron6f135e12021-12-08 16:57:54 +01004227#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 mbedtls_ssl_transform_free(handshake->transform_handshake);
4229 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004230#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4232 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004233#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004234#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004235
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004236
4237#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4238 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4239 * processes datagrams and the fact that a datagram is allowed to have
4240 * several records in it, it is possible that the I/O buffers are not
4241 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4243 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004244#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004245
Jerry Yuba9c7272021-10-30 11:54:10 +08004246 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004247 mbedtls_platform_zeroize(handshake,
4248 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004249}
4250
Gilles Peskine449bd832023-01-11 14:50:10 +01004251void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004252{
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004254 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004256
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004257#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004259#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004260
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004261#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004262#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4263 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004265#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004267#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004268
Gilles Peskine449bd832023-01-11 14:50:10 +01004269 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004270}
4271
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004272#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004273
4274#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4275#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4276#else
4277#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4278#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4279
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004280#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004281
4282#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4283#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4284#else
4285#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4286#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4287
4288#if defined(MBEDTLS_SSL_ALPN)
4289#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4290#else
4291#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4292#endif /* MBEDTLS_SSL_ALPN */
4293
4294#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4295#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4296#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4297#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4298
4299#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 ((uint32_t) ( \
4301 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4302 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4303 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4304 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4305 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4306 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4307 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4308 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004309
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004310static unsigned char ssl_serialized_context_header[] = {
4311 MBEDTLS_VERSION_MAJOR,
4312 MBEDTLS_VERSION_MINOR,
4313 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4315 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4316 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4317 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4318 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004319};
4320
Paul Bakker5121ce52009-01-03 21:22:43 +00004321/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004322 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004323 *
4324 * The format of the serialized data is:
4325 * (in the presentation language of TLS, RFC 8446 section 3)
4326 *
4327 * // header
4328 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004329 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004330 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004331 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004332 * Note: When updating the format, remember to keep these
4333 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004334 *
4335 * // session sub-structure
4336 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4337 * // transform sub-structure
4338 * uint8 random[64]; // ServerHello.random+ClientHello.random
4339 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4340 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4341 * // fields from ssl_context
4342 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4343 * uint64 in_window_top; // DTLS: last validated record seq_num
4344 * uint64 in_window; // DTLS: bitmask for replay protection
4345 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4346 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4347 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4348 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4349 *
4350 * Note that many fields of the ssl_context or sub-structures are not
4351 * serialized, as they fall in one of the following categories:
4352 *
4353 * 1. forced value (eg in_left must be 0)
4354 * 2. pointer to dynamically-allocated memory (eg session, transform)
4355 * 3. value can be re-derived from other data (eg session keys from MS)
4356 * 4. value was temporary (eg content of input buffer)
4357 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004358 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004359int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4360 unsigned char *buf,
4361 size_t buf_len,
4362 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004363{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004364 unsigned char *p = buf;
4365 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004366 size_t session_len;
4367 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004368
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004369 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004370 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4371 * this function's documentation.
4372 *
4373 * These are due to assumptions/limitations in the implementation. Some of
4374 * them are likely to stay (no handshake in progress) some might go away
4375 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004376 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004377 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4379 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4380 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004381 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if (ssl->handshake != NULL) {
4383 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4384 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004385 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004386 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 if (ssl->transform == NULL || ssl->session == NULL) {
4388 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4389 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004390 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004391 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 if (mbedtls_ssl_check_pending(ssl) != 0) {
4393 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4394 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004395 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 if (ssl->out_left != 0) {
4397 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4398 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004399 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004400 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4402 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4403 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004404 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004405 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4407 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4408 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004409 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004410 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4412 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4413 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004414 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004415 /* Renegotiation must not be enabled */
4416#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4418 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4419 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004420 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004421#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004422
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004423 /*
4424 * Version and format identifier
4425 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004427
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 if (used <= buf_len) {
4429 memcpy(p, ssl_serialized_context_header,
4430 sizeof(ssl_serialized_context_header));
4431 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004432 }
4433
4434 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004435 * Session (length + data)
4436 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4438 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4439 return ret;
4440 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004441
4442 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004443 if (used <= buf_len) {
4444 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004445 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 ret = ssl_session_save(ssl->session, 1,
4448 p, session_len, &session_len);
4449 if (ret != 0) {
4450 return ret;
4451 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004452
4453 p += session_len;
4454 }
4455
4456 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004457 * Transform
4458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 used += sizeof(ssl->transform->randbytes);
4460 if (used <= buf_len) {
4461 memcpy(p, ssl->transform->randbytes,
4462 sizeof(ssl->transform->randbytes));
4463 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004464 }
4465
4466#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4467 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004469 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004471 p += ssl->transform->in_cid_len;
4472
4473 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004475 p += ssl->transform->out_cid_len;
4476 }
4477#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4478
4479 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004480 * Saved fields from top-level ssl_context structure
4481 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004482 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 if (used <= buf_len) {
4484 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004485 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004486 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004487
4488#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4489 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 if (used <= buf_len) {
4491 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004492 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004493
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004495 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004496 }
4497#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4498
4499#if defined(MBEDTLS_SSL_PROTO_DTLS)
4500 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004502 *p++ = ssl->disable_datagram_packing;
4503 }
4504#endif /* MBEDTLS_SSL_PROTO_DTLS */
4505
Jerry Yuae0b2e22021-10-08 15:21:19 +08004506 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004507 if (used <= buf_len) {
4508 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004509 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004510 }
4511
4512#if defined(MBEDTLS_SSL_PROTO_DTLS)
4513 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 if (used <= buf_len) {
4515 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004516 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004517 }
4518#endif /* MBEDTLS_SSL_PROTO_DTLS */
4519
4520#if defined(MBEDTLS_SSL_ALPN)
4521 {
4522 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004524 : 0;
4525
4526 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004528 *p++ = alpn_len;
4529
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 if (ssl->alpn_chosen != NULL) {
4531 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004532 p += alpn_len;
4533 }
4534 }
4535 }
4536#endif /* MBEDTLS_SSL_ALPN */
4537
4538 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004539 * Done
4540 */
4541 *olen = used;
4542
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 if (used > buf_len) {
4544 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4545 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004548
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004550}
4551
4552/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004553 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004554 *
4555 * This internal version is wrapped by a public function that cleans up in
4556 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004557 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004558MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004559static int ssl_context_load(mbedtls_ssl_context *ssl,
4560 const unsigned char *buf,
4561 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004562{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004563 const unsigned char *p = buf;
4564 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004565 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004566 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004567#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004568 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004569#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004570
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004571 /*
4572 * The context should have been freshly setup or reset.
4573 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004574 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004575 * renegotiating, or if the user mistakenly loaded a session first.)
4576 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4578 ssl->session != NULL) {
4579 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004580 }
4581
4582 /*
4583 * We can't check that the config matches the initial one, but we can at
4584 * least check it matches the requirements for serializing.
4585 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004587 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4588 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004589#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004590 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004591#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 0) {
4593 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004594 }
4595
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004597
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004598 /*
4599 * Check version identifier
4600 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4602 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004603 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004604
4605 if (memcmp(p, ssl_serialized_context_header,
4606 sizeof(ssl_serialized_context_header)) != 0) {
4607 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4608 }
4609 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004610
4611 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004612 * Session
4613 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 if ((size_t) (end - p) < 4) {
4615 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4616 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004617
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004618 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004619 p += 4;
4620
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004621 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004622 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004623 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004624 ssl->session_in = ssl->session;
4625 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004626 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004627
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 if ((size_t) (end - p) < session_len) {
4629 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4630 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004631
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 ret = ssl_session_load(ssl->session, 1, p, session_len);
4633 if (ret != 0) {
4634 mbedtls_ssl_session_free(ssl->session);
4635 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004636 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004637
4638 p += session_len;
4639
4640 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004641 * Transform
4642 */
4643
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004644 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004645 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004646#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004647 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004648 ssl->transform_in = ssl->transform;
4649 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004650 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004651#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004652
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004653#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4655 if (prf_func == NULL) {
4656 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4657 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004658
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004659 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4661 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4662 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004663
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 ret = ssl_tls12_populate_transform(ssl->transform,
4665 ssl->session->ciphersuite,
4666 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004667#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004669#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 prf_func,
4671 p, /* currently pointing to randbytes */
4672 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4673 ssl->conf->endpoint,
4674 ssl);
4675 if (ret != 0) {
4676 return ret;
4677 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004678#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004680
4681#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4682 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 if ((size_t) (end - p) < 1) {
4684 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4685 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004686
4687 ssl->transform->in_cid_len = *p++;
4688
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4690 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4691 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004694 p += ssl->transform->in_cid_len;
4695
4696 ssl->transform->out_cid_len = *p++;
4697
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4700 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004701
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004703 p += ssl->transform->out_cid_len;
4704#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4705
4706 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004707 * Saved fields from top-level ssl_context structure
4708 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 if ((size_t) (end - p) < 4) {
4710 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4711 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004712
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004713 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004714 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004715
4716#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 if ((size_t) (end - p) < 16) {
4718 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4719 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004720
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004721 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004722 p += 8;
4723
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004724 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004725 p += 8;
4726#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4727
4728#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 if ((size_t) (end - p) < 1) {
4730 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4731 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004732
4733 ssl->disable_datagram_packing = *p++;
4734#endif /* MBEDTLS_SSL_PROTO_DTLS */
4735
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4738 }
4739 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4740 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004741
4742#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 if ((size_t) (end - p) < 2) {
4744 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4745 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004746
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004748 p += 2;
4749#endif /* MBEDTLS_SSL_PROTO_DTLS */
4750
4751#if defined(MBEDTLS_SSL_ALPN)
4752 {
4753 uint8_t alpn_len;
4754 const char **cur;
4755
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 if ((size_t) (end - p) < 1) {
4757 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4758 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004759
4760 alpn_len = *p++;
4761
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004763 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4765 if (strlen(*cur) == alpn_len &&
4766 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004767 ssl->alpn_chosen = *cur;
4768 break;
4769 }
4770 }
4771 }
4772
4773 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4775 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4776 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004777
4778 p += alpn_len;
4779 }
4780#endif /* MBEDTLS_SSL_ALPN */
4781
4782 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004783 * Forced fields from top-level ssl_context structure
4784 *
4785 * Most of them already set to the correct value by mbedtls_ssl_init() and
4786 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4787 */
4788 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004789 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004790
Hanno Becker361b10d2019-08-30 10:42:49 +01004791 /* Adjust pointers for header fields of outgoing records to
4792 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004794
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004795#if defined(MBEDTLS_SSL_PROTO_DTLS)
4796 ssl->in_epoch = 1;
4797#endif
4798
4799 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4800 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004801 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4802 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 if (ssl->handshake != NULL) {
4804 mbedtls_ssl_handshake_free(ssl);
4805 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004806 ssl->handshake = NULL;
4807 }
4808
4809 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004810 * Done - should have consumed entire buffer
4811 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 if (p != end) {
4813 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4814 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004815
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004817}
4818
4819/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004820 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004821 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004822int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4823 const unsigned char *buf,
4824 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004825{
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004827
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 if (ret != 0) {
4829 mbedtls_ssl_free(context);
4830 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004831
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004833}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004834#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004835
4836/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004837 * Free an SSL context
4838 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004839void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004840{
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004842 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004844
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004846
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004848#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4849 size_t out_buf_len = ssl->out_buf_len;
4850#else
4851 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4852#endif
4853
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 mbedtls_platform_zeroize(ssl->out_buf, out_buf_len);
4855 mbedtls_free(ssl->out_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004856 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004857 }
4858
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004860#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4861 size_t in_buf_len = ssl->in_buf_len;
4862#else
4863 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4864#endif
4865
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 mbedtls_platform_zeroize(ssl->in_buf, in_buf_len);
4867 mbedtls_free(ssl->in_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004868 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004869 }
4870
Gilles Peskine449bd832023-01-11 14:50:10 +01004871 if (ssl->transform) {
4872 mbedtls_ssl_transform_free(ssl->transform);
4873 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004874 }
4875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 if (ssl->handshake) {
4877 mbedtls_ssl_handshake_free(ssl);
4878 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004879
4880#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4882 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004883#endif
4884
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 mbedtls_ssl_session_free(ssl->session_negotiate);
4886 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004887 }
4888
Ronald Cron6f135e12021-12-08 16:57:54 +01004889#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 mbedtls_ssl_transform_free(ssl->transform_application);
4891 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004892#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004893
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 if (ssl->session) {
4895 mbedtls_ssl_session_free(ssl->session);
4896 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004897 }
4898
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004899#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 if (ssl->hostname != NULL) {
4901 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
4902 mbedtls_free(ssl->hostname);
Paul Bakker5121ce52009-01-03 21:22:43 +00004903 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004904#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004905
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004906#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004908#endif
4909
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004911
Paul Bakker86f04f42013-02-14 11:20:09 +01004912 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004914}
4915
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004916/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004917 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004918 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004919void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004920{
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004922}
4923
Gilles Peskineae270bf2021-06-02 00:05:29 +02004924/* The selection should be the same as mbedtls_x509_crt_profile_default in
4925 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004926 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004927 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004928 * about this list.
4929 */
Brett Warrene0edc842021-08-17 09:53:13 +01004930static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004931#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004932 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004933#endif
4934#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004935 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004936#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004937#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004938 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004939#endif
4940#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004941 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004942#endif
4943#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004944 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004945#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004946#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004947 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004948#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004949#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004950 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004951#endif
4952#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004953 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004954#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02004955#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01004956 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
4957 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
4958 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
4959 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
4960 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
4961#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004962 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004963};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004964
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03004965static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004966 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4967 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4968 0
4969};
4970
Ronald Crone68ab4f2022-10-05 12:46:29 +02004971#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004972
Jerry Yu909df7b2022-01-22 11:56:27 +08004973/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004974 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004975 * rules SHOULD be upheld.
4976 * - No duplicate entries.
4977 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004978 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004979 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004980 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004981static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004982
Valerio Setti75fba322023-02-23 17:35:09 +01004983#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004984 defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004985 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4986 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004987#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA256 &&
Jerry Yued5e9f42022-01-26 11:21:34 +08004988 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004989
Valerio Setti75fba322023-02-23 17:35:09 +01004990#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004991 defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08004992 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4993 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004994#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004995 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4996
Valerio Setti75fba322023-02-23 17:35:09 +01004997#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004998 defined(MBEDTLS_MD_CAN_SHA512) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004999 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
5000 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005001#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yued5e9f42022-01-26 11:21:34 +08005002 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005003
Gilles Peskine449bd832023-01-11 14:50:10 +01005004#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005005 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005006 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005007#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005008 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005011 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005012 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005013#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005014 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005015
Gilles Peskine449bd832023-01-11 14:50:10 +01005016#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005017 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005018 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005019#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005020 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005021
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005022#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005023 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005024#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005025
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005026#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005027 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005028#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005029
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005030#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005031 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005032#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005033
Gabor Mezei15b95a62022-05-09 16:37:58 +02005034 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005035};
5036
5037/* NOTICE: see above */
5038#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5039static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005040#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Setti75fba322023-02-23 17:35:09 +01005041#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005043#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005044#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5045 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5046#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005047#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005049#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005050#endif /* MBEDTLS_MD_CAN_SHA512*/
5051#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Setti75fba322023-02-23 17:35:09 +01005052#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005054#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005055#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5056 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5057#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005058#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005060#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005061#endif /* MBEDTLS_MD_CAN_SHA384*/
5062#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Setti75fba322023-02-23 17:35:09 +01005063#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005065#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005066#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5067 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5068#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005069#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005071#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005072#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005073 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005074};
5075#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5076/* NOTICE: see above */
5077static uint16_t ssl_preset_suiteb_sig_algs[] = {
5078
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005079#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08005080 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5081 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005082#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA256&&
Jerry Yu909df7b2022-01-22 11:56:27 +08005083 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
5084
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005085#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu53037892022-01-25 11:02:06 +08005086 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5087 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005088#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu53037892022-01-25 11:02:06 +08005089 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005090
Gilles Peskine449bd832023-01-11 14:50:10 +01005091#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005092 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005093 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005094#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005095 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005096
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005097#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005098 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005099#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005100
Gabor Mezei15b95a62022-05-09 16:37:58 +02005101 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005102};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005103
Jerry Yu909df7b2022-01-22 11:56:27 +08005104/* NOTICE: see above */
5105#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5106static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005107#if defined(MBEDTLS_MD_CAN_SHA256)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005108#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005110#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005111#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005113#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005114#endif /* MBEDTLS_MD_CAN_SHA256*/
5115#if defined(MBEDTLS_MD_CAN_SHA384)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005116#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005118#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005119#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005121#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005122#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005123 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005124};
Jerry Yu909df7b2022-01-22 11:56:27 +08005125#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5126
Ronald Crone68ab4f2022-10-05 12:46:29 +02005127#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005128
Brett Warrene0edc842021-08-17 09:53:13 +01005129static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01005130#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005131 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005132#endif
5133#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005134 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005135#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005136 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005137};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005138
Ronald Crone68ab4f2022-10-05 12:46:29 +02005139#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005140/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005141 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005142MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005143static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005144{
5145 size_t i, j;
5146 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005147
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5149 for (j = 0; j < i; j++) {
5150 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005151 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 }
5153 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5154 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5155 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005156 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005157 }
5158 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005160}
5161
Ronald Crone68ab4f2022-10-05 12:46:29 +02005162#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005163
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005164/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005165 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005166 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005167int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5168 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005169{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005170#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005171 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005172#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005173
Ronald Crone68ab4f2022-10-05 12:46:29 +02005174#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5176 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5177 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005178 }
5179
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5181 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5182 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005183 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005184
5185#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5187 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5188 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005189 }
5190
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5192 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5193 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005194 }
5195#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005196#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005197
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005198 /* Use the functions here so that they are covered in tests,
5199 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005200 mbedtls_ssl_conf_endpoint(conf, endpoint);
5201 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005202
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005203 /*
5204 * Things that are common to all presets
5205 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005206#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005207 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005208 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5209#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5210 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5211#endif
5212 }
5213#endif
5214
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005215#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5216 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5217#endif
5218
5219#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5220 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5221#endif
5222
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005223#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005224 conf->f_cookie_write = ssl_cookie_write_dummy;
5225 conf->f_cookie_check = ssl_cookie_check_dummy;
5226#endif
5227
5228#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5229 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5230#endif
5231
Janos Follath088ce432017-04-10 12:42:31 +01005232#if defined(MBEDTLS_SSL_SRV_C)
5233 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005234 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005235#endif
5236
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005237#if defined(MBEDTLS_SSL_PROTO_DTLS)
5238 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5239 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5240#endif
5241
5242#if defined(MBEDTLS_SSL_RENEGOTIATION)
5243 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 memset(conf->renego_period, 0x00, 2);
5245 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005246#endif
5247
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005248#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005249 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005250 const unsigned char dhm_p[] =
5251 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5252 const unsigned char dhm_g[] =
5253 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005254
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5256 dhm_p, sizeof(dhm_p),
5257 dhm_g, sizeof(dhm_g))) != 0) {
5258 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005259 }
5260 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005261#endif
5262
Ronald Cron6f135e12021-12-08 16:57:54 +01005263#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005264
5265#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 mbedtls_ssl_tls13_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005267#if defined(MBEDTLS_SSL_SRV_C)
5268 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005270#endif
5271#endif /* MBEDTLS_SSL_EARLY_DATA */
5272
Jerry Yud0766ec2022-09-22 10:46:57 +08005273#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005274 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005276#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005277 /*
5278 * Allow all TLS 1.3 key exchange modes by default.
5279 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005280 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005281#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005282
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005284#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005285 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005286 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005287#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005288 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005289#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005290 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005291#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005292 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5293 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005294#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5295 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5296 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5297#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5298 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5299 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5300#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005301 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005302#endif
5303 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005304
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005305 /*
5306 * Preset-specific defaults
5307 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005309 /*
5310 * NSA Suite B
5311 */
5312 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005313
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005314 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005315
5316#if defined(MBEDTLS_X509_CRT_PARSE_C)
5317 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005318#endif
5319
Ronald Crone68ab4f2022-10-05 12:46:29 +02005320#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005321#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005323 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005325#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005327#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005328
Valerio Setti6f0441d2023-07-03 12:11:36 +02005329#if defined(MBEDTLS_PK_HAVE_ECC_KEYS) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005330 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005331#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005332 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005333 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005334
5335 /*
5336 * Default
5337 */
5338 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005339
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005340 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005341
5342#if defined(MBEDTLS_X509_CRT_PARSE_C)
5343 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5344#endif
5345
Ronald Crone68ab4f2022-10-05 12:46:29 +02005346#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005347#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005349 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005351#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005353#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005354
Valerio Setti6f0441d2023-07-03 12:11:36 +02005355#if defined(MBEDTLS_PK_HAVE_ECC_KEYS) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005356 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005357#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005358 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005359
5360#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5361 conf->dhm_min_bitlen = 1024;
5362#endif
5363 }
5364
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005366}
5367
5368/*
5369 * Free mbedtls_ssl_config
5370 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005371void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005372{
5373#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 mbedtls_mpi_free(&conf->dhm_P);
5375 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005376#endif
5377
Ronald Cron73fe8df2022-10-05 14:31:43 +02005378#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005379#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005381 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5382 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005383#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 if (conf->psk != NULL) {
5385 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
5386 mbedtls_free(conf->psk);
Azim Khan27e8a122018-03-21 14:24:11 +00005387 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005388 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005389 }
5390
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 if (conf->psk_identity != NULL) {
5392 mbedtls_platform_zeroize(conf->psk_identity, conf->psk_identity_len);
5393 mbedtls_free(conf->psk_identity);
Azim Khan27e8a122018-03-21 14:24:11 +00005394 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005395 conf->psk_identity_len = 0;
5396 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005397#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005398
5399#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005401#endif
5402
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005404}
5405
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005406#if defined(MBEDTLS_PK_C) && \
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005407 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_CAN_ECDSA_SOME))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005408/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005409 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005410 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005411unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005412{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005413#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5415 return MBEDTLS_SSL_SIG_RSA;
5416 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005417#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005418#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5420 return MBEDTLS_SSL_SIG_ECDSA;
5421 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005422#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005424}
5425
Gilles Peskine449bd832023-01-11 14:50:10 +01005426unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005427{
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005429 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005431 case MBEDTLS_PK_ECDSA:
5432 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005434 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005436 }
5437}
5438
Gilles Peskine449bd832023-01-11 14:50:10 +01005439mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005440{
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005442#if defined(MBEDTLS_RSA_C)
5443 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005444 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005445#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005446#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005447 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005448 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005449#endif
5450 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005452 }
5453}
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005454#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_PK_CAN_ECDSA_SOME ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005455
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005456/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005457 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005459mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005460{
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005462#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005463 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005465#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005466#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005467 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005469#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005470#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005471 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005473#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005474#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005475 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005477#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005478#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005481#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005482#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005483 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005485#endif
5486 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005488 }
5489}
5490
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005491/*
5492 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5493 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005494unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005495{
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005497#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005498 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005499 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005500#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005501#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005502 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005504#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005505#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005506 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005508#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005509#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005510 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005512#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005513#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005514 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005516#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005517#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005518 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005520#endif
5521 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005523 }
5524}
5525
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005526/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005527 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005528 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005529 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005530int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005531{
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005533
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 if (group_list == NULL) {
5535 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005536 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005537
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 for (; *group_list != 0; group_list++) {
5539 if (*group_list == tls_id) {
5540 return 0;
5541 }
5542 }
5543
5544 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005545}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005546
Valerio Setti49e69072023-06-27 17:27:51 +02005547#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005548/*
5549 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5550 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005551int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005552{
Gilles Peskine449bd832023-01-11 14:50:10 +01005553 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005554
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005556 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005558
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005560}
Valerio Setti49e69072023-06-27 17:27:51 +02005561#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005562
Valerio Setti18c9fed2022-12-30 17:44:24 +01005563static const struct {
5564 uint16_t tls_id;
5565 mbedtls_ecp_group_id ecp_group_id;
5566 psa_ecc_family_t psa_family;
5567 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005568} tls_id_match_table[] =
5569{
5570#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005571 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005572#endif
5573#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005574 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005575#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005576#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005577 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005578#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005579#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005580 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005581#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005582#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005583 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005584#endif
5585#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005586 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005587#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005588#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005589 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005590#endif
5591#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005592 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005593#endif
5594#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005595 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005596#endif
5597#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005598 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005599#endif
5600#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005601 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005602#endif
5603#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005604 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005605#endif
5606#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005607 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005608#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005609 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005610};
5611
Gilles Peskine449bd832023-01-11 14:50:10 +01005612int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005613 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005615{
Gilles Peskine449bd832023-01-11 14:50:10 +01005616 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5617 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005618 if (type != NULL) {
5619 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 }
5621 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005622 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005624 return PSA_SUCCESS;
5625 }
5626 }
5627
5628 return PSA_ERROR_NOT_SUPPORTED;
5629}
5630
Gilles Peskine449bd832023-01-11 14:50:10 +01005631mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005632{
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5634 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005635 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005636 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005637 }
5638
5639 return MBEDTLS_ECP_DP_NONE;
5640}
5641
Gilles Peskine449bd832023-01-11 14:50:10 +01005642uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005643{
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5645 i++) {
5646 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005647 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005649 }
5650
5651 return 0;
5652}
5653
Valerio Setti67419f02023-01-04 16:12:42 +01005654#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005655static const struct {
5656 uint16_t tls_id;
5657 const char *name;
5658} tls_id_curve_name_table[] =
5659{
Valerio Setti54e23792023-07-07 10:49:27 +02005660 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5661 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5662 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5663 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5664 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5665 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5666 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5667 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5668 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5669 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5670 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5671 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5672 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005673 { 0, NULL },
5674};
5675
Gilles Peskine449bd832023-01-11 14:50:10 +01005676const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005677{
Valerio Settiacd32c02023-06-29 18:06:29 +02005678 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5679 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5680 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005681 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005682 }
5683
5684 return NULL;
5685}
Valerio Setti67419f02023-01-04 16:12:42 +01005686#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005687
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005688#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005689int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5690 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5691 int cert_endpoint,
5692 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005693{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005694 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005695 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005696 const char *ext_oid;
5697 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005698
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005700 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005701 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005702 case MBEDTLS_KEY_EXCHANGE_RSA:
5703 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005704 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005705 break;
5706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005707 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5708 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5709 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5710 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005711 break;
5712
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005713 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5714 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005715 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005716 break;
5717
5718 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005719 case MBEDTLS_KEY_EXCHANGE_NONE:
5720 case MBEDTLS_KEY_EXCHANGE_PSK:
5721 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5722 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005723 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005724 usage = 0;
5725 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005727 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5728 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005729 }
5730
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005732 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005733 ret = -1;
5734 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005735
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005737 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5739 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005740 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005742 }
5743
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005745 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005746 ret = -1;
5747 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005748
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005750}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005751#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005752
Jerry Yu148165c2021-09-24 23:20:59 +08005753#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005754int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5755 const mbedtls_md_type_t md,
5756 unsigned char *dst,
5757 size_t dst_len,
5758 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005759{
Ronald Cronf6893e12022-01-07 22:09:01 +01005760 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5761 psa_hash_operation_t *hash_operation_to_clone;
5762 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5763
Jerry Yu148165c2021-09-24 23:20:59 +08005764 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005765
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005767#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005768 case MBEDTLS_MD_SHA384:
5769 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5770 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005771#endif
5772
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005773#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 case MBEDTLS_MD_SHA256:
5775 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5776 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005777#endif
5778
Gilles Peskine449bd832023-01-11 14:50:10 +01005779 default:
5780 goto exit;
5781 }
5782
5783 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5784 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005785 goto exit;
5786 }
5787
Gilles Peskine449bd832023-01-11 14:50:10 +01005788 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5789 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005790 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005792
5793exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005794#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5795 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005796 (void) ssl;
5797#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005798 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005799}
5800#else /* MBEDTLS_USE_PSA_CRYPTO */
5801
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005802#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005803MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005804static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5805 unsigned char *dst,
5806 size_t dst_len,
5807 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005808{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005809 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005810 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005811
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 if (dst_len < 48) {
5813 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5814 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005815
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005816 mbedtls_md_init(&sha384);
5817 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005818 if (ret != 0) {
5819 goto exit;
5820 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005821 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005822 if (ret != 0) {
5823 goto exit;
5824 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005825
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005826 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005827 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005828 goto exit;
5829 }
5830
5831 *olen = 48;
5832
5833exit:
5834
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005835 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005837}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005838#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005839
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005840#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005841MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005842static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5843 unsigned char *dst,
5844 size_t dst_len,
5845 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005846{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005847 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005848 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005849
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 if (dst_len < 32) {
5851 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5852 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005853
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005854 mbedtls_md_init(&sha256);
5855 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5856 if (ret != 0) {
5857 goto exit;
5858 }
5859 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5860 if (ret != 0) {
5861 goto exit;
5862 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005863
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005864 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5865 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005866 goto exit;
5867 }
5868
5869 *olen = 32;
5870
5871exit:
5872
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005873 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005875}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005876#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005877
Gilles Peskine449bd832023-01-11 14:50:10 +01005878int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5879 const mbedtls_md_type_t md,
5880 unsigned char *dst,
5881 size_t dst_len,
5882 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005883{
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005885
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005886#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 case MBEDTLS_MD_SHA384:
5888 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005889#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005890
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005891#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 case MBEDTLS_MD_SHA256:
5893 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005894#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005895
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005897#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5898 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005899 (void) ssl;
5900 (void) dst;
5901 (void) dst_len;
5902 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005903#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005904 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005905 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005907}
XiaokangQian647719a2021-12-07 09:16:29 +00005908
Jerry Yu148165c2021-09-24 23:20:59 +08005909#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005910
Ronald Crone68ab4f2022-10-05 12:46:29 +02005911#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005912/* mbedtls_ssl_parse_sig_alg_ext()
5913 *
5914 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5915 * value (TLS 1.3 RFC8446):
5916 * enum {
5917 * ....
5918 * ecdsa_secp256r1_sha256( 0x0403 ),
5919 * ecdsa_secp384r1_sha384( 0x0503 ),
5920 * ecdsa_secp521r1_sha512( 0x0603 ),
5921 * ....
5922 * } SignatureScheme;
5923 *
5924 * struct {
5925 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5926 * } SignatureSchemeList;
5927 *
5928 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5929 * value (TLS 1.2 RFC5246):
5930 * enum {
5931 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5932 * sha512(6), (255)
5933 * } HashAlgorithm;
5934 *
5935 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5936 * SignatureAlgorithm;
5937 *
5938 * struct {
5939 * HashAlgorithm hash;
5940 * SignatureAlgorithm signature;
5941 * } SignatureAndHashAlgorithm;
5942 *
5943 * SignatureAndHashAlgorithm
5944 * supported_signature_algorithms<2..2^16-2>;
5945 *
5946 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5947 * generalization of the TLS 1.2 signature algorithm extension.
5948 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5949 * `SignatureScheme` field of TLS 1.3
5950 *
5951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005952int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5953 const unsigned char *buf,
5954 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005955{
5956 const unsigned char *p = buf;
5957 size_t supported_sig_algs_len = 0;
5958 const unsigned char *supported_sig_algs_end;
5959 uint16_t sig_alg;
5960 uint32_t common_idx = 0;
5961
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5963 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005964 p += 2;
5965
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 memset(ssl->handshake->received_sig_algs, 0,
5967 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005968
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005970 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 while (p < supported_sig_algs_end) {
5972 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5973 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005974 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5976 sig_alg,
5977 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005978#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5980 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5981 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005982 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005983 }
5984#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005985
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5987 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005988
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005990 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5991 common_idx += 1;
5992 }
5993 }
5994 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 if (p != end) {
5996 MBEDTLS_SSL_DEBUG_MSG(1,
5997 ("Signature algorithms extension length misaligned"));
5998 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5999 MBEDTLS_ERR_SSL_DECODE_ERROR);
6000 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006001 }
6002
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 if (common_idx == 0) {
6004 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6005 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6006 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6007 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006008 }
6009
Gabor Mezei15b95a62022-05-09 16:37:58 +02006010 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006012}
6013
Ronald Crone68ab4f2022-10-05 12:46:29 +02006014#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006015
Jerry Yudc7bd172022-02-17 13:44:15 +08006016#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6017
6018#if defined(MBEDTLS_USE_PSA_CRYPTO)
6019
Gilles Peskine449bd832023-01-11 14:50:10 +01006020static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6021 mbedtls_svc_key_id_t key,
6022 psa_algorithm_t alg,
6023 const unsigned char *raw_psk, size_t raw_psk_length,
6024 const unsigned char *seed, size_t seed_length,
6025 const unsigned char *label, size_t label_length,
6026 const unsigned char *other_secret,
6027 size_t other_secret_length,
6028 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006029{
6030 psa_status_t status;
6031
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 status = psa_key_derivation_setup(derivation, alg);
6033 if (status != PSA_SUCCESS) {
6034 return status;
6035 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006036
Gilles Peskine449bd832023-01-11 14:50:10 +01006037 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6038 status = psa_key_derivation_input_bytes(derivation,
6039 PSA_KEY_DERIVATION_INPUT_SEED,
6040 seed, seed_length);
6041 if (status != PSA_SUCCESS) {
6042 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006043 }
6044
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 if (other_secret != NULL) {
6046 status = psa_key_derivation_input_bytes(derivation,
6047 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6048 other_secret, other_secret_length);
6049 if (status != PSA_SUCCESS) {
6050 return status;
6051 }
6052 }
6053
6054 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006055 status = psa_key_derivation_input_bytes(
6056 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 raw_psk, raw_psk_length);
6058 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006059 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006061 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 if (status != PSA_SUCCESS) {
6063 return status;
6064 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006065
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 status = psa_key_derivation_input_bytes(derivation,
6067 PSA_KEY_DERIVATION_INPUT_LABEL,
6068 label, label_length);
6069 if (status != PSA_SUCCESS) {
6070 return status;
6071 }
6072 } else {
6073 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006074 }
6075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 status = psa_key_derivation_set_capacity(derivation, capacity);
6077 if (status != PSA_SUCCESS) {
6078 return status;
6079 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006080
Gilles Peskine449bd832023-01-11 14:50:10 +01006081 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006082}
6083
Andrzej Kurek57d10632022-10-24 10:32:01 -04006084#if defined(PSA_WANT_ALG_SHA_384) || \
6085 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006086MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006087static int tls_prf_generic(mbedtls_md_type_t md_type,
6088 const unsigned char *secret, size_t slen,
6089 const char *label,
6090 const unsigned char *random, size_t rlen,
6091 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006092{
6093 psa_status_t status;
6094 psa_algorithm_t alg;
6095 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6096 psa_key_derivation_operation_t derivation =
6097 PSA_KEY_DERIVATION_OPERATION_INIT;
6098
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006100 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006102 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006104
6105 /* Normally a "secret" should be long enough to be impossible to
6106 * find by brute force, and in particular should not be empty. But
6107 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6108 * and for this use case it makes sense to have a 0-length "secret".
6109 * Since the key API doesn't allow importing a key of length 0,
6110 * keep master_key=0, which setup_psa_key_derivation() understands
6111 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006113 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6115 psa_set_key_algorithm(&key_attributes, alg);
6116 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006117
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6119 if (status != PSA_SUCCESS) {
6120 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6121 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006122 }
6123
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 status = setup_psa_key_derivation(&derivation,
6125 master_key, alg,
6126 NULL, 0,
6127 random, rlen,
6128 (unsigned char const *) label,
6129 (size_t) strlen(label),
6130 NULL, 0,
6131 dlen);
6132 if (status != PSA_SUCCESS) {
6133 psa_key_derivation_abort(&derivation);
6134 psa_destroy_key(master_key);
6135 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006136 }
6137
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6139 if (status != PSA_SUCCESS) {
6140 psa_key_derivation_abort(&derivation);
6141 psa_destroy_key(master_key);
6142 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006143 }
6144
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 status = psa_key_derivation_abort(&derivation);
6146 if (status != PSA_SUCCESS) {
6147 psa_destroy_key(master_key);
6148 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006149 }
6150
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 if (!mbedtls_svc_key_id_is_null(master_key)) {
6152 status = psa_destroy_key(master_key);
6153 }
6154 if (status != PSA_SUCCESS) {
6155 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6156 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006157
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006159}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006160#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006161#else /* MBEDTLS_USE_PSA_CRYPTO */
6162
Andrzej Kurek57d10632022-10-24 10:32:01 -04006163#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006164 (defined(MBEDTLS_MD_CAN_SHA256) || \
6165 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006166MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006167static int tls_prf_generic(mbedtls_md_type_t md_type,
6168 const unsigned char *secret, size_t slen,
6169 const char *label,
6170 const unsigned char *random, size_t rlen,
6171 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006172{
6173 size_t nb;
6174 size_t i, j, k, md_len;
6175 unsigned char *tmp;
6176 size_t tmp_len = 0;
6177 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6178 const mbedtls_md_info_t *md_info;
6179 mbedtls_md_context_t md_ctx;
6180 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6181
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6185 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6186 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006187
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006189
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 tmp_len = md_len + strlen(label) + rlen;
6191 tmp = mbedtls_calloc(1, tmp_len);
6192 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006193 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6194 goto exit;
6195 }
6196
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 nb = strlen(label);
6198 memcpy(tmp + md_len, label, nb);
6199 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006200 nb += rlen;
6201
6202 /*
6203 * Compute P_<hash>(secret, label + random)[0..dlen]
6204 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006206 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006208
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6210 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006211 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 }
6213 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6214 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006215 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 }
6217 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6218 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006219 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006221
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 for (i = 0; i < dlen; i += md_len) {
6223 ret = mbedtls_md_hmac_reset(&md_ctx);
6224 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006225 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 }
6227 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6228 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006229 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 }
6231 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6232 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006233 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006235
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 ret = mbedtls_md_hmac_reset(&md_ctx);
6237 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006238 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 }
6240 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6241 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006242 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 }
6244 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6245 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006246 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006248
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006250
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006252 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006254 }
6255
6256exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006258
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 if (tmp != NULL) {
6260 mbedtls_platform_zeroize(tmp, tmp_len);
6261 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006262
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006264
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006266
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006268}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006269#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006270#endif /* MBEDTLS_USE_PSA_CRYPTO */
6271
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006272#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006273MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006274static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6275 const char *label,
6276 const unsigned char *random, size_t rlen,
6277 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006278{
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6280 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006281}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006282#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006283
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006284#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006285MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006286static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6287 const char *label,
6288 const unsigned char *random, size_t rlen,
6289 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006290{
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6292 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006293}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006294#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006295
Jerry Yuf009d862022-02-17 14:01:37 +08006296/*
6297 * Set appropriate PRF function and other SSL / TLS1.2 functions
6298 *
6299 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006300 * - hash associated with the ciphersuite (only used by TLS 1.2)
6301 *
6302 * Outputs:
6303 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6304 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006305MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006306static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6307 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006308{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006309#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006311 handshake->tls_prf = tls_prf_sha384;
6312 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6313 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006314 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006315#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006316#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006317 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006318 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006319 handshake->tls_prf = tls_prf_sha256;
6320 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6321 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6322 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006323#else
Jerry Yuf009d862022-02-17 14:01:37 +08006324 {
Jerry Yuf009d862022-02-17 14:01:37 +08006325 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006326 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006328 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006329#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006330
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006332}
Jerry Yud6ab2352022-02-17 14:03:43 +08006333
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006334/*
6335 * Compute master secret if needed
6336 *
6337 * Parameters:
6338 * [in/out] handshake
6339 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6340 * (PSA-PSK) ciphersuite_info, psk_opaque
6341 * [out] premaster (cleared)
6342 * [out] master
6343 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6344 * debug: conf->f_dbg, conf->p_dbg
6345 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006346 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006347 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006348MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006349static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6350 unsigned char *master,
6351 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006352{
6353 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6354
6355 /* cf. RFC 5246, Section 8.1:
6356 * "The master secret is always exactly 48 bytes in length." */
6357 size_t const master_secret_len = 48;
6358
6359#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6360 unsigned char session_hash[48];
6361#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6362
6363 /* The label for the KDF used for key expansion.
6364 * This is either "master secret" or "extended master secret"
6365 * depending on whether the Extended Master Secret extension
6366 * is used. */
6367 char const *lbl = "master secret";
6368
Przemek Stekielae4ed302022-04-05 17:15:55 +02006369 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006370 * - If the Extended Master Secret extension is not used,
6371 * this is ClientHello.Random + ServerHello.Random
6372 * (see Sect. 8.1 in RFC 5246).
6373 * - If the Extended Master Secret extension is used,
6374 * this is the transcript of the handshake so far.
6375 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006376 unsigned char const *seed = handshake->randbytes;
6377 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006378
6379#if !defined(MBEDTLS_DEBUG_C) && \
6380 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6381 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006383 ssl = NULL; /* make sure we don't use it except for those cases */
6384 (void) ssl;
6385#endif
6386
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 if (handshake->resume != 0) {
6388 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6389 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006390 }
6391
6392#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006394 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006395 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006396 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6397 if (ret != 0) {
6398 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6399 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006400
Gilles Peskine449bd832023-01-11 14:50:10 +01006401 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6402 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006403 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006404#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006405
Przemek Stekiel99114f32022-04-22 11:20:09 +02006406#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006407 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006409 /* Perform PSK-to-MS expansion in a single step. */
6410 psa_status_t status;
6411 psa_algorithm_t alg;
6412 mbedtls_svc_key_id_t psk;
6413 psa_key_derivation_operation_t derivation =
6414 PSA_KEY_DERIVATION_OPERATION_INIT;
6415 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6416
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006418
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006420
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006422 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006424 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006426
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006427 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006429
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006431 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006432 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006433 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006434 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006435 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006436 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006437 other_secret_len = 48;
6438 other_secret = handshake->premaster + 2;
6439 break;
6440 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006441 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006442 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6443 other_secret = handshake->premaster + 2;
6444 break;
6445 default:
6446 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006447 }
6448
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 status = setup_psa_key_derivation(&derivation, psk, alg,
6450 ssl->conf->psk, ssl->conf->psk_len,
6451 seed, seed_len,
6452 (unsigned char const *) lbl,
6453 (size_t) strlen(lbl),
6454 other_secret, other_secret_len,
6455 master_secret_len);
6456 if (status != PSA_SUCCESS) {
6457 psa_key_derivation_abort(&derivation);
6458 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006459 }
6460
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 status = psa_key_derivation_output_bytes(&derivation,
6462 master,
6463 master_secret_len);
6464 if (status != PSA_SUCCESS) {
6465 psa_key_derivation_abort(&derivation);
6466 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006467 }
6468
Gilles Peskine449bd832023-01-11 14:50:10 +01006469 status = psa_key_derivation_abort(&derivation);
6470 if (status != PSA_SUCCESS) {
6471 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6472 }
6473 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006474#endif
6475 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006476#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6478 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006479 psa_status_t status;
6480 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6481 psa_key_derivation_operation_t derivation =
6482 PSA_KEY_DERIVATION_OPERATION_INIT;
6483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006485
6486 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6487
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 status = psa_key_derivation_setup(&derivation, alg);
6489 if (status != PSA_SUCCESS) {
6490 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006491 }
6492
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 status = psa_key_derivation_set_capacity(&derivation,
6494 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6495 if (status != PSA_SUCCESS) {
6496 psa_key_derivation_abort(&derivation);
6497 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006498 }
6499
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6501 &derivation);
6502 if (status != PSA_SUCCESS) {
6503 psa_key_derivation_abort(&derivation);
6504 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006505 }
6506
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 status = psa_key_derivation_output_bytes(&derivation,
6508 handshake->premaster,
6509 handshake->pmslen);
6510 if (status != PSA_SUCCESS) {
6511 psa_key_derivation_abort(&derivation);
6512 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6513 }
6514
6515 status = psa_key_derivation_abort(&derivation);
6516 if (status != PSA_SUCCESS) {
6517 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006518 }
6519 }
6520#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6522 lbl, seed, seed_len,
6523 master,
6524 master_secret_len);
6525 if (ret != 0) {
6526 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6527 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006528 }
6529
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6531 handshake->premaster,
6532 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 mbedtls_platform_zeroize(handshake->premaster,
6535 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006536 }
6537
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006539}
6540
Gilles Peskine449bd832023-01-11 14:50:10 +01006541int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006542{
6543 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6544 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6545 ssl->handshake->ciphersuite_info;
6546
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006548
6549 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 ret = ssl_set_handshake_prfs(ssl->handshake,
6551 ciphersuite_info->mac);
6552 if (ret != 0) {
6553 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6554 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006555 }
6556
6557 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 ret = ssl_compute_master(ssl->handshake,
6559 ssl->session_negotiate->master,
6560 ssl);
6561 if (ret != 0) {
6562 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6563 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006564 }
6565
6566 /* Swap the client and server random values:
6567 * - MS derivation wanted client+server (RFC 5246 8.1)
6568 * - key derivation wants server+client (RFC 5246 6.3) */
6569 {
6570 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 memcpy(tmp, ssl->handshake->randbytes, 64);
6572 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6573 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6574 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006575 }
6576
6577 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006578 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6579 ssl->session_negotiate->ciphersuite,
6580 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006581#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006583#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 ssl->handshake->tls_prf,
6585 ssl->handshake->randbytes,
6586 ssl->tls_version,
6587 ssl->conf->endpoint,
6588 ssl);
6589 if (ret != 0) {
6590 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6591 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006592 }
6593
6594 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6596 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006597
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006599
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006601}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006602
Gilles Peskine449bd832023-01-11 14:50:10 +01006603int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006604{
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006606#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006607 case MBEDTLS_SSL_HASH_SHA384:
6608 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6609 break;
6610#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006611#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006612 case MBEDTLS_SSL_HASH_SHA256:
6613 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6614 break;
6615#endif
6616 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006617 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006618 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006619#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6620 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006621 (void) ssl;
6622#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006624}
6625
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006626#if defined(MBEDTLS_USE_PSA_CRYPTO)
6627static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6628 const psa_hash_operation_t *hs_op,
6629 size_t buffer_size,
6630 unsigned char *hash,
6631 size_t *hlen)
6632{
6633 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006634 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006635
6636#if !defined(MBEDTLS_DEBUG_C)
6637 (void) ssl;
6638#endif
6639 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006640 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006641 if (status != PSA_SUCCESS) {
6642 goto exit;
6643 }
6644
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006645 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006646 if (status != PSA_SUCCESS) {
6647 goto exit;
6648 }
6649
6650 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6651 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6652
6653exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006654 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006655 return mbedtls_md_error_from_psa(status);
6656}
6657#else
6658static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6659 const mbedtls_md_context_t *hs_ctx,
6660 unsigned char *hash,
6661 size_t *hlen)
6662{
6663 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006664 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006665
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006666 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006667
6668#if !defined(MBEDTLS_DEBUG_C)
6669 (void) ssl;
6670#endif
6671 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6672
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006673 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006674 if (ret != 0) {
6675 goto exit;
6676 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006677 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006678 if (ret != 0) {
6679 goto exit;
6680 }
6681
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006682 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006683 if (ret != 0) {
6684 goto exit;
6685 }
6686
6687 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6688
6689 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6690 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6691
6692exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006693 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006694 return ret;
6695}
6696#endif /* MBEDTLS_USE_PSA_CRYPTO */
6697
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006698#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006699int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6700 unsigned char *hash,
6701 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006702{
6703#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006704 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6705 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006706#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006707 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6708 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006709#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006710}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006711#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006712
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006713#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006714int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6715 unsigned char *hash,
6716 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006717{
6718#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006719 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6720 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006721#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006722 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6723 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006724#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006725}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006726#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006727
Neil Armstrong80f6f322022-05-03 17:56:38 +02006728#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6729 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006730int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006731{
6732 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006733 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006734 const unsigned char *psk = NULL;
6735 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006737
Gilles Peskine449bd832023-01-11 14:50:10 +01006738 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006739 /*
6740 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006741 * checked before calling this function.
6742 *
6743 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006744 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006745 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6747 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6748 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006749 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006750 }
6751
6752 /*
6753 * PMS = struct {
6754 * opaque other_secret<0..2^16-1>;
6755 * opaque psk<0..2^16-1>;
6756 * };
6757 * with "other_secret" depending on the particular key exchange
6758 */
6759#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6761 if (end - p < 2) {
6762 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6763 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006764
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006766 p += 2;
6767
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 if (end < p || (size_t) (end - p) < psk_len) {
6769 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6770 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006771
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006773 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006775#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6776#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006777 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006778 /*
6779 * other_secret already set by the ClientKeyExchange message,
6780 * and is 48 bytes long
6781 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 if (end - p < 2) {
6783 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6784 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006785
6786 *p++ = 0;
6787 *p++ = 48;
6788 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006790#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6791#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006793 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6794 size_t len;
6795
6796 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6798 p + 2, end - (p + 2), &len,
6799 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6800 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6801 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006802 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006804 p += 2 + len;
6805
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6807 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006808#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006809#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006811 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6812 size_t zlen;
6813
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6815 p + 2, end - (p + 2),
6816 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6817 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6818 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006819 }
6820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006822 p += 2 + zlen;
6823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6825 MBEDTLS_DEBUG_ECDH_Z);
6826 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006827#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006828 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6830 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006831 }
6832
6833 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006834 if (end - p < 2) {
6835 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6836 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006837
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006839 p += 2;
6840
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 if (end < p || (size_t) (end - p) < psk_len) {
6842 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6843 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006844
Gilles Peskine449bd832023-01-11 14:50:10 +01006845 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006846 p += psk_len;
6847
6848 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6849
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006851}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006852#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006853
6854#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006855MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006856static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006857
6858#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006859int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006860{
6861 /* If renegotiation is not enforced, retransmit until we would reach max
6862 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006864 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6865 unsigned char doublings = 1;
6866
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006868 ++doublings;
6869 ratio >>= 1;
6870 }
6871
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 if (++ssl->renego_records_seen > doublings) {
6873 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6874 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006875 }
6876 }
6877
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006879}
6880#endif
6881#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006882
Jerry Yud9526692022-02-17 14:23:47 +08006883/*
6884 * Handshake functions
6885 */
6886#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6887/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006888int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006889{
6890 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6891 ssl->handshake->ciphersuite_info;
6892
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006894
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6896 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006897 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006899 }
6900
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6902 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006903}
6904
Gilles Peskine449bd832023-01-11 14:50:10 +01006905int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006906{
6907 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6908 ssl->handshake->ciphersuite_info;
6909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006911
Gilles Peskine449bd832023-01-11 14:50:10 +01006912 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6913 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006914 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006916 }
6917
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6919 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006920}
6921
6922#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6923/* Some certificate support -> implement write and parse */
6924
Gilles Peskine449bd832023-01-11 14:50:10 +01006925int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006926{
6927 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6928 size_t i, n;
6929 const mbedtls_x509_crt *crt;
6930 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6931 ssl->handshake->ciphersuite_info;
6932
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006934
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6936 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006937 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006939 }
6940
6941#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6943 if (ssl->handshake->client_auth == 0) {
6944 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006945 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006947 }
6948 }
6949#endif /* MBEDTLS_SSL_CLI_C */
6950#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6952 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006953 /* Should never happen because we shouldn't have picked the
6954 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006956 }
6957 }
6958#endif
6959
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006961
6962 /*
6963 * 0 . 0 handshake type
6964 * 1 . 3 handshake length
6965 * 4 . 6 length of all certs
6966 * 7 . 9 length of cert. 1
6967 * 10 . n-1 peer certificate
6968 * n . n+2 length of cert. 2
6969 * n+3 . ... upper level cert, etc.
6970 */
6971 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006973
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006975 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6977 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6978 " > %" MBEDTLS_PRINTF_SIZET,
6979 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6980 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006981 }
6982
Gilles Peskine449bd832023-01-11 14:50:10 +01006983 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6984 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6985 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006986
Gilles Peskine449bd832023-01-11 14:50:10 +01006987 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006988 i += n; crt = crt->next;
6989 }
6990
Gilles Peskine449bd832023-01-11 14:50:10 +01006991 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6992 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6993 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006994
6995 ssl->out_msglen = i;
6996 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6997 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6998
6999 ssl->state++;
7000
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7002 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7003 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007004 }
7005
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007007
Gilles Peskine449bd832023-01-11 14:50:10 +01007008 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007009}
7010
7011#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7012
7013#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007014MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007015static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7016 unsigned char *crt_buf,
7017 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007018{
7019 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7020
Gilles Peskine449bd832023-01-11 14:50:10 +01007021 if (peer_crt == NULL) {
7022 return -1;
7023 }
Jerry Yud9526692022-02-17 14:23:47 +08007024
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 if (peer_crt->raw.len != crt_buf_len) {
7026 return -1;
7027 }
Jerry Yud9526692022-02-17 14:23:47 +08007028
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007030}
7031#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007032MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007033static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7034 unsigned char *crt_buf,
7035 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007036{
7037 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7038 unsigned char const * const peer_cert_digest =
7039 ssl->session->peer_cert_digest;
7040 mbedtls_md_type_t const peer_cert_digest_type =
7041 ssl->session->peer_cert_digest_type;
7042 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007043 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007044 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7045 size_t digest_len;
7046
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 if (peer_cert_digest == NULL || digest_info == NULL) {
7048 return -1;
7049 }
Jerry Yud9526692022-02-17 14:23:47 +08007050
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 digest_len = mbedtls_md_get_size(digest_info);
7052 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7053 return -1;
7054 }
Jerry Yud9526692022-02-17 14:23:47 +08007055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7057 if (ret != 0) {
7058 return -1;
7059 }
Jerry Yud9526692022-02-17 14:23:47 +08007060
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007062}
7063#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7064#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7065
7066/*
7067 * Once the certificate message is read, parse it into a cert chain and
7068 * perform basic checks, but leave actual verification to the caller
7069 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007070MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007071static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7072 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007073{
7074 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7075#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007077#endif
7078 size_t i, n;
7079 uint8_t alert;
7080
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7082 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7083 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7084 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7085 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007086 }
7087
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7089 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7090 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7091 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007092 }
7093
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7095 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7096 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7097 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7098 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007099 }
7100
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007102
7103 /*
7104 * Same message structure as in mbedtls_ssl_write_certificate()
7105 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007107
Gilles Peskine449bd832023-01-11 14:50:10 +01007108 if (ssl->in_msg[i] != 0 ||
7109 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7110 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7111 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7112 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7113 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007114 }
7115
7116 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7117 i += 3;
7118
7119 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007121 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 if (i + 3 > ssl->in_hslen) {
7123 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7124 mbedtls_ssl_send_alert_message(ssl,
7125 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7126 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7127 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007128 }
7129 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7130 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 if (ssl->in_msg[i] != 0) {
7132 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7133 mbedtls_ssl_send_alert_message(ssl,
7134 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7135 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7136 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007137 }
7138
7139 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007141 | (unsigned int) ssl->in_msg[i + 2];
7142 i += 3;
7143
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 if (n < 128 || i + n > ssl->in_hslen) {
7145 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7146 mbedtls_ssl_send_alert_message(ssl,
7147 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7148 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7149 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007150 }
7151
7152 /* Check if we're handling the first CRT in the chain. */
7153#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007155 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007157 /* During client-side renegotiation, check that the server's
7158 * end-CRTs hasn't changed compared to the initial handshake,
7159 * mitigating the triple handshake attack. On success, reuse
7160 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7162 if (ssl_check_peer_crt_unchanged(ssl,
7163 &ssl->in_msg[i],
7164 n) != 0) {
7165 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7166 mbedtls_ssl_send_alert_message(ssl,
7167 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7168 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7169 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007170 }
7171
7172 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007174 }
7175#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7176
7177 /* Parse the next certificate in the chain. */
7178#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007180#else
7181 /* If we don't need to store the CRT chain permanently, parse
7182 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007183 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007184#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007186 case 0: /*ok*/
7187 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7188 /* Ignore certificate with an unknown algorithm: maybe a
7189 prior certificate was already trusted. */
7190 break;
7191
7192 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7193 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7194 goto crt_parse_der_failed;
7195
7196 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7197 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7198 goto crt_parse_der_failed;
7199
7200 default:
7201 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007202crt_parse_der_failed:
7203 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7204 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7205 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007206 }
7207
7208 i += n;
7209 }
7210
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7212 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007213}
7214
7215#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007216MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007217static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007218{
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7220 return -1;
7221 }
Jerry Yud9526692022-02-17 14:23:47 +08007222
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007224 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7225 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7227 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7228 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007229 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007230 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007231}
7232#endif /* MBEDTLS_SSL_SRV_C */
7233
7234/* Check if a certificate message is expected.
7235 * Return either
7236 * - SSL_CERTIFICATE_EXPECTED, or
7237 * - SSL_CERTIFICATE_SKIP
7238 * indicating whether a Certificate message is expected or not.
7239 */
7240#define SSL_CERTIFICATE_EXPECTED 0
7241#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007242MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007243static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7244 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007245{
7246 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7247 ssl->handshake->ciphersuite_info;
7248
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7250 return SSL_CERTIFICATE_SKIP;
7251 }
Jerry Yud9526692022-02-17 14:23:47 +08007252
7253#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7255 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7256 return SSL_CERTIFICATE_SKIP;
7257 }
Jerry Yud9526692022-02-17 14:23:47 +08007258
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007260 ssl->session_negotiate->verify_result =
7261 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007263 }
7264 }
7265#else
7266 ((void) authmode);
7267#endif /* MBEDTLS_SSL_SRV_C */
7268
Gilles Peskine449bd832023-01-11 14:50:10 +01007269 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007270}
7271
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007272MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007273static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7274 int authmode,
7275 mbedtls_x509_crt *chain,
7276 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007277{
7278 int ret = 0;
7279 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7280 ssl->handshake->ciphersuite_info;
7281 int have_ca_chain = 0;
7282
7283 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7284 void *p_vrfy;
7285
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7287 return 0;
7288 }
Jerry Yud9526692022-02-17 14:23:47 +08007289
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 if (ssl->f_vrfy != NULL) {
7291 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007292 f_vrfy = ssl->f_vrfy;
7293 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 } else {
7295 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007296 f_vrfy = ssl->conf->f_vrfy;
7297 p_vrfy = ssl->conf->p_vrfy;
7298 }
7299
7300 /*
7301 * Main check: verify certificate
7302 */
7303#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007305 ((void) rs_ctx);
7306 have_ca_chain = 1;
7307
Gilles Peskine449bd832023-01-11 14:50:10 +01007308 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007309 ret = mbedtls_x509_crt_verify_with_ca_cb(
7310 chain,
7311 ssl->conf->f_ca_cb,
7312 ssl->conf->p_ca_cb,
7313 ssl->conf->cert_profile,
7314 ssl->hostname,
7315 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007316 f_vrfy, p_vrfy);
7317 } else
Jerry Yud9526692022-02-17 14:23:47 +08007318#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7319 {
7320 mbedtls_x509_crt *ca_chain;
7321 mbedtls_x509_crl *ca_crl;
7322
7323#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007324 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007325 ca_chain = ssl->handshake->sni_ca_chain;
7326 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007327 } else
Jerry Yud9526692022-02-17 14:23:47 +08007328#endif
7329 {
7330 ca_chain = ssl->conf->ca_chain;
7331 ca_crl = ssl->conf->ca_crl;
7332 }
7333
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007335 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 }
Jerry Yud9526692022-02-17 14:23:47 +08007337
7338 ret = mbedtls_x509_crt_verify_restartable(
7339 chain,
7340 ca_chain, ca_crl,
7341 ssl->conf->cert_profile,
7342 ssl->hostname,
7343 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007345 }
7346
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 if (ret != 0) {
7348 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007349 }
7350
7351#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7353 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7354 }
Jerry Yud9526692022-02-17 14:23:47 +08007355#endif
7356
7357 /*
7358 * Secondary checks: always done, but change 'ret' only if it was 0
7359 */
7360
Valerio Settiacd32c02023-06-29 18:06:29 +02007361#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007362 {
7363 const mbedtls_pk_context *pk = &chain->pk;
7364
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007365 /* If certificate uses an EC key, make sure the curve is OK.
7366 * This is a public key, so it can't be opaque, so can_do() is a good
7367 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007368 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007369 /* and in the unlikely case the above assumption no longer holds
7370 * we are making sure that pk_ec() here does not return a NULL
7371 */
Valerio Settid0405092023-05-24 13:16:40 +02007372 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7373 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7374 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007376 }
Valerio Setti97207782023-05-18 18:59:06 +02007377 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007378 ssl->session_negotiate->verify_result |=
7379 MBEDTLS_X509_BADCERT_BAD_KEY;
7380
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7382 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007383 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007384 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007385 }
Jerry Yud9526692022-02-17 14:23:47 +08007386 }
7387 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007388#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007389
Gilles Peskine449bd832023-01-11 14:50:10 +01007390 if (mbedtls_ssl_check_cert_usage(chain,
7391 ciphersuite_info,
7392 !ssl->conf->endpoint,
7393 &ssl->session_negotiate->verify_result) != 0) {
7394 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7395 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007396 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 }
Jerry Yud9526692022-02-17 14:23:47 +08007398 }
7399
7400 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7401 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7402 * with details encoded in the verification flags. All other kinds
7403 * of error codes, including those from the user provided f_vrfy
7404 * functions, are treated as fatal and lead to a failure of
7405 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7407 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7408 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007409 ret = 0;
7410 }
7411
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7413 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007414 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7415 }
7416
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007418 uint8_t alert;
7419
7420 /* The certificate may have been rejected for several reasons.
7421 Pick one and send the corresponding alert. Which alert to send
7422 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007424 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007426 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007428 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007430 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007432 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007434 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007436 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007438 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007440 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007442 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007444 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 }
7446 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7447 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007448 }
7449
7450#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 if (ssl->session_negotiate->verify_result != 0) {
7452 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7453 (unsigned int) ssl->session_negotiate->verify_result));
7454 } else {
7455 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007456 }
7457#endif /* MBEDTLS_DEBUG_C */
7458
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007460}
7461
7462#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007463MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007464static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7465 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007466{
7467 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7468 /* Remember digest of the peer's end-CRT. */
7469 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7471 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7472 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7473 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7474 mbedtls_ssl_send_alert_message(ssl,
7475 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7476 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007477
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007479 }
7480
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 ret = mbedtls_md(mbedtls_md_info_from_type(
7482 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7483 start, len,
7484 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007485
7486 ssl->session_negotiate->peer_cert_digest_type =
7487 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7488 ssl->session_negotiate->peer_cert_digest_len =
7489 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7490
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007492}
7493
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007494MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007495static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7496 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007497{
7498 unsigned char *end = start + len;
7499 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7500
7501 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7503 ret = mbedtls_pk_parse_subpubkey(&start, end,
7504 &ssl->handshake->peer_pubkey);
7505 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007506 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007508 }
7509
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007511}
7512#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7513
Gilles Peskine449bd832023-01-11 14:50:10 +01007514int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007515{
7516 int ret = 0;
7517 int crt_expected;
7518#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7519 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7520 ? ssl->handshake->sni_authmode
7521 : ssl->conf->authmode;
7522#else
7523 const int authmode = ssl->conf->authmode;
7524#endif
7525 void *rs_ctx = NULL;
7526 mbedtls_x509_crt *chain = NULL;
7527
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007529
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7531 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7532 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007533 goto exit;
7534 }
7535
7536#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 if (ssl->handshake->ecrs_enabled &&
7538 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007539 chain = ssl->handshake->ecrs_peer_cert;
7540 ssl->handshake->ecrs_peer_cert = NULL;
7541 goto crt_verify;
7542 }
7543#endif
7544
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007546 /* mbedtls_ssl_read_record may have sent an alert already. We
7547 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007549 goto exit;
7550 }
7551
7552#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007554 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7555
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007557 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 }
Jerry Yud9526692022-02-17 14:23:47 +08007559
7560 goto exit;
7561 }
7562#endif /* MBEDTLS_SSL_SRV_C */
7563
7564 /* Clear existing peer CRT structure in case we tried to
7565 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007567
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7569 if (chain == NULL) {
7570 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7571 sizeof(mbedtls_x509_crt)));
7572 mbedtls_ssl_send_alert_message(ssl,
7573 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7574 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007575
7576 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7577 goto exit;
7578 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007580
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 ret = ssl_parse_certificate_chain(ssl, chain);
7582 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007583 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 }
Jerry Yud9526692022-02-17 14:23:47 +08007585
7586#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007588 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 }
Jerry Yud9526692022-02-17 14:23:47 +08007590
7591crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007593 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 }
Jerry Yud9526692022-02-17 14:23:47 +08007595#endif
7596
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 ret = ssl_parse_certificate_verify(ssl, authmode,
7598 chain, rs_ctx);
7599 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007600 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 }
Jerry Yud9526692022-02-17 14:23:47 +08007602
7603#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7604 {
7605 unsigned char *crt_start, *pk_start;
7606 size_t crt_len, pk_len;
7607
7608 /* We parse the CRT chain without copying, so
7609 * these pointers point into the input buffer,
7610 * and are hence still valid after freeing the
7611 * CRT chain. */
7612
7613 crt_start = chain->raw.p;
7614 crt_len = chain->raw.len;
7615
7616 pk_start = chain->pk_raw.p;
7617 pk_len = chain->pk_raw.len;
7618
7619 /* Free the CRT structures before computing
7620 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 mbedtls_x509_crt_free(chain);
7622 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007623 chain = NULL;
7624
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7626 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007627 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 }
Jerry Yud9526692022-02-17 14:23:47 +08007629
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7631 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007632 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 }
Jerry Yud9526692022-02-17 14:23:47 +08007634 }
7635#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7636 /* Pass ownership to session structure. */
7637 ssl->session_negotiate->peer_cert = chain;
7638 chain = NULL;
7639#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7640
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007642
7643exit:
7644
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007646 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 }
Jerry Yud9526692022-02-17 14:23:47 +08007648
7649#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007651 ssl->handshake->ecrs_peer_cert = chain;
7652 chain = NULL;
7653 }
7654#endif
7655
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 if (chain != NULL) {
7657 mbedtls_x509_crt_free(chain);
7658 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007659 }
7660
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007662}
7663#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7664
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007665static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7666 unsigned char *padbuf, size_t hlen,
7667 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007668{
7669 int len = 12;
7670 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007671#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007672 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007673 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007674 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007675 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007676#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007677 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007678 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007679 mbedtls_md_context_t cloned_ctx;
7680 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007681#endif
7682
7683 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007685 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007687
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007689 ? "client finished"
7690 : "server finished";
7691
7692#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007693 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007694
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007695 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007697 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007698 }
7699
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007700 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007701 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007702 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007703 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007704 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007705#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007706 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007707
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007708 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007709 if (ret != 0) {
7710 goto exit;
7711 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007712 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007713 if (ret != 0) {
7714 goto exit;
7715 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007716
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007717 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007718 if (ret != 0) {
7719 goto exit;
7720 }
7721#endif /* MBEDTLS_USE_PSA_CRYPTO */
7722
7723 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7724
Jerry Yu615bd6f2022-02-17 14:25:15 +08007725 /*
7726 * TLSv1.2:
7727 * hash = PRF( master, finished_label,
7728 * Hash( handshake ) )[0.11]
7729 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007731 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007732
Gilles Peskine449bd832023-01-11 14:50:10 +01007733 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007734
Gilles Peskine449bd832023-01-11 14:50:10 +01007735 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007736
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007737 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007738
7739exit:
7740#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007741 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007742 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007743#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007744 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007745 return ret;
7746#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007747}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007748
7749#if defined(MBEDTLS_MD_CAN_SHA256)
7750static int ssl_calc_finished_tls_sha256(
7751 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7752{
7753 unsigned char padbuf[32];
7754 return ssl_calc_finished_tls_generic(ssl,
7755#if defined(MBEDTLS_USE_PSA_CRYPTO)
7756 &ssl->handshake->fin_sha256_psa,
7757#else
7758 &ssl->handshake->fin_sha256,
7759#endif
7760 padbuf, sizeof(padbuf),
7761 buf, from);
7762}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007763#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007764
Jerry Yub7ba49e2022-02-17 14:25:53 +08007765
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007766#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007767static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007769{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007770 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007771 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007772#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007773 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007774#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007775 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007776#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007777 padbuf, sizeof(padbuf),
7778 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007779}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007780#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007781
Gilles Peskine449bd832023-01-11 14:50:10 +01007782void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007783{
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007785
7786 /*
7787 * Free our handshake params
7788 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 mbedtls_ssl_handshake_free(ssl);
7790 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007791 ssl->handshake = NULL;
7792
7793 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007794 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007795 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 if (ssl->transform) {
7797 mbedtls_ssl_transform_free(ssl->transform);
7798 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007799 }
7800 ssl->transform = ssl->transform_negotiate;
7801 ssl->transform_negotiate = NULL;
7802
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007804}
7805
Gilles Peskine449bd832023-01-11 14:50:10 +01007806void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007807{
7808 int resume = ssl->handshake->resume;
7809
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007811
7812#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007814 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7815 ssl->renego_records_seen = 0;
7816 }
7817#endif
7818
7819 /*
7820 * Free the previous session and switch in the current one
7821 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007822 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007823#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7824 /* RFC 7366 3.1: keep the EtM state */
7825 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007827#endif
7828
Gilles Peskine449bd832023-01-11 14:50:10 +01007829 mbedtls_ssl_session_free(ssl->session);
7830 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007831 }
7832 ssl->session = ssl->session_negotiate;
7833 ssl->session_negotiate = NULL;
7834
7835 /*
7836 * Add cache entry
7837 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007839 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 resume == 0) {
7841 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7842 ssl->session->id,
7843 ssl->session->id_len,
7844 ssl->session) != 0) {
7845 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7846 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007847 }
7848
7849#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007850 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7851 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007852 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007854
7855 /* Keep last flight around in case we need to resend it:
7856 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007857 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7858 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007859#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007861
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007862 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007863
Gilles Peskine449bd832023-01-11 14:50:10 +01007864 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007865}
7866
Gilles Peskine449bd832023-01-11 14:50:10 +01007867int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007868{
7869 int ret, hash_len;
7870
Gilles Peskine449bd832023-01-11 14:50:10 +01007871 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007872
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007874
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007875 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7876 if (ret != 0) {
7877 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7878 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007879
7880 /*
7881 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7882 * may define some other value. Currently (early 2016), no defined
7883 * ciphersuite does this (and this is unlikely to change as activity has
7884 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7885 */
7886 hash_len = 12;
7887
7888#if defined(MBEDTLS_SSL_RENEGOTIATION)
7889 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007891#endif
7892
7893 ssl->out_msglen = 4 + hash_len;
7894 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7895 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7896
7897 /*
7898 * In case of session resuming, invert the client and server
7899 * ChangeCipherSpec messages order.
7900 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007902#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007904 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007906#endif
7907#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007908 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007909 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007911#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007912 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007913 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007915
7916 /*
7917 * Switch to our negotiated transform and session parameters for outbound
7918 * data.
7919 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007921
7922#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007924 unsigned char i;
7925
7926 /* Remember current epoch settings for resending */
7927 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007928 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7929 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007930
7931 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007932 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007933
7934
7935 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 for (i = 2; i > 0; i--) {
7937 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007938 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007939 }
7940 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007941
7942 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007943 if (i == 0) {
7944 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7945 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007946 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007947 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007948#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007949 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007950
7951 ssl->transform_out = ssl->transform_negotiate;
7952 ssl->session_out = ssl->session_negotiate;
7953
7954#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007955 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7956 mbedtls_ssl_send_flight_completed(ssl);
7957 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007958#endif
7959
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7961 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7962 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007963 }
7964
7965#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7967 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7968 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7969 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007970 }
7971#endif
7972
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007974
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007976}
7977
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007978#define SSL_MAX_HASH_LEN 12
7979
Gilles Peskine449bd832023-01-11 14:50:10 +01007980int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007981{
7982 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7983 unsigned int hash_len = 12;
7984 unsigned char buf[SSL_MAX_HASH_LEN];
7985
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007987
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007988 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7989 if (ret != 0) {
7990 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7991 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007992
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7994 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007995 goto exit;
7996 }
7997
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7999 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8000 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8001 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008002 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8003 goto exit;
8004 }
8005
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8007 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8008 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008009 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8010 goto exit;
8011 }
8012
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8014 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8015 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8016 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008017 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8018 goto exit;
8019 }
8020
Gilles Peskine449bd832023-01-11 14:50:10 +01008021 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8022 buf, hash_len) != 0) {
8023 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8024 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8025 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008026 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8027 goto exit;
8028 }
8029
8030#if defined(MBEDTLS_SSL_RENEGOTIATION)
8031 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008032 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008033#endif
8034
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008036#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008038 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008039 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008040#endif
8041#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008042 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008043 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008045#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008047 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008049
8050#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8052 mbedtls_ssl_recv_flight_completed(ssl);
8053 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008054#endif
8055
Gilles Peskine449bd832023-01-11 14:50:10 +01008056 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008057
8058exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 mbedtls_platform_zeroize(buf, hash_len);
8060 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008061}
8062
Jerry Yu392112c2022-02-17 14:34:10 +08008063#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8064/*
8065 * Helper to get TLS 1.2 PRF from ciphersuite
8066 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8067 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008068static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008069{
Jerry Yu392112c2022-02-17 14:34:10 +08008070 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008071 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008072#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008073 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8074 return tls_prf_sha384;
8075 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008076#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008077#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008078 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8080 return tls_prf_sha256;
8081 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008082 }
8083#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008084#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8085 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008086 (void) ciphersuite_info;
8087#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008088
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008090}
8091#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008092
Gilles Peskine449bd832023-01-11 14:50:10 +01008093static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008094{
8095 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008096#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008097 if (tls_prf == tls_prf_sha384) {
8098 return MBEDTLS_SSL_TLS_PRF_SHA384;
8099 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008100#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008101#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 if (tls_prf == tls_prf_sha256) {
8103 return MBEDTLS_SSL_TLS_PRF_SHA256;
8104 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008105#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008106 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008107}
8108
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008109/*
8110 * Populate a transform structure with session keys and all the other
8111 * necessary information.
8112 *
8113 * Parameters:
8114 * - [in/out]: transform: structure to populate
8115 * [in] must be just initialised with mbedtls_ssl_transform_init()
8116 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8117 * - [in] ciphersuite
8118 * - [in] master
8119 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008120 * - [in] tls_prf: pointer to PRF to use for key derivation
8121 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008122 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008123 * - [in] endpoint: client or server
8124 * - [in] ssl: used for:
8125 * - ssl->conf->{f,p}_export_keys
8126 * [in] optionally used for:
8127 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8128 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008129MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008130static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8131 int ciphersuite,
8132 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008133#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008134 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008135#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008136 ssl_tls_prf_t tls_prf,
8137 const unsigned char randbytes[64],
8138 mbedtls_ssl_protocol_version tls_version,
8139 unsigned endpoint,
8140 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008141{
8142 int ret = 0;
8143 unsigned char keyblk[256];
8144 unsigned char *key1;
8145 unsigned char *key2;
8146 unsigned char *mac_enc;
8147 unsigned char *mac_dec;
8148 size_t mac_key_len = 0;
8149 size_t iv_copy_len;
8150 size_t keylen;
8151 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008152 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008153#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008154 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008155 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008156#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008157
8158#if defined(MBEDTLS_USE_PSA_CRYPTO)
8159 psa_key_type_t key_type;
8160 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8161 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008162 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008163 size_t key_bits;
8164 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8165#endif
8166
8167#if !defined(MBEDTLS_DEBUG_C) && \
8168 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008169 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008170 ssl = NULL; /* make sure we don't use it except for these cases */
8171 (void) ssl;
8172 }
8173#endif
8174
8175 /*
8176 * Some data just needs copying into the structure
8177 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008178#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008179 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008180#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008181 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008182
8183#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008184 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008185#endif
8186
8187#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008189 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8190 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008191 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008192 }
8193#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8194
8195 /*
8196 * Get various info structures
8197 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008198 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8199 if (ciphersuite_info == NULL) {
8200 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8201 ciphersuite));
8202 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008203 }
8204
Neil Armstrongab555e02022-04-04 11:07:59 +02008205 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008206#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008208#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008210
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008212 transform->taglen =
8213 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008214 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008215
8216#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008217 if ((status = mbedtls_ssl_cipher_to_psa(ciphersuite_info->cipher,
8218 transform->taglen,
8219 &alg,
8220 &key_type,
8221 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008222 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008224 goto end;
8225 }
8226#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 cipher_info = mbedtls_cipher_info_from_type(ciphersuite_info->cipher);
8228 if (cipher_info == NULL) {
8229 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8230 ciphersuite_info->cipher));
8231 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008232 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008233#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008234
Neil Armstronge4512952022-03-08 09:08:22 +01008235#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008236 mac_alg = mbedtls_md_psa_alg_from_type(ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008237 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008238 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008239 (unsigned) ciphersuite_info->mac));
8240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008241 }
8242#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008243 md_info = mbedtls_md_info_from_type(ciphersuite_info->mac);
8244 if (md_info == NULL) {
8245 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8246 (unsigned) ciphersuite_info->mac));
8247 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008248 }
Neil Armstronge4512952022-03-08 09:08:22 +01008249#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008250
8251#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8252 /* Copy own and peer's CID if the use of the CID
8253 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008254 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8255 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008256
8257 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008258 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8259 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8260 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008261
8262 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8264 ssl->handshake->peer_cid_len);
8265 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8266 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008267 }
8268#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8269
8270 /*
8271 * Compute key block using the PRF
8272 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008273 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8274 if (ret != 0) {
8275 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8276 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008277 }
8278
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8280 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8281 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8282 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8283 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008284
8285 /*
8286 * Determine the appropriate key, IV and MAC length.
8287 */
8288
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008289#if defined(MBEDTLS_USE_PSA_CRYPTO)
8290 keylen = PSA_BITS_TO_BYTES(key_bits);
8291#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008293#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008294
8295#if defined(MBEDTLS_GCM_C) || \
8296 defined(MBEDTLS_CCM_C) || \
8297 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008298 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008299 size_t explicit_ivlen;
8300
8301 transform->maclen = 0;
8302 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008303
8304 /* All modes haves 96-bit IVs, but the length of the static parts vary
8305 * with mode and version:
8306 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8307 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8308 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8309 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8310 * sequence number).
8311 */
8312 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008313
8314 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008315#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008316 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008317#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008318 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8319 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008320#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008321
Gilles Peskine449bd832023-01-11 14:50:10 +01008322 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008323 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008324 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008325 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008326 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008327
8328 /* Minimum length of encrypted record */
8329 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8330 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008331 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008332#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8333#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008334 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008335 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008336 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008337#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008339#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008340 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008341#endif /* MBEDTLS_USE_PSA_CRYPTO */
8342
8343#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008344 /* Get MAC length */
8345 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8346#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008347 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008348 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8349 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8350 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008351 goto end;
8352 }
8353
8354 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008355 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008356#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008357 transform->maclen = mac_key_len;
8358
8359 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008360#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008361 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008362#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008363 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008364#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008365
8366 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008368 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008370 /*
8371 * GenericBlockCipher:
8372 * 1. if EtM is in use: one block plus MAC
8373 * otherwise: * first multiple of blocklen greater than maclen
8374 * 2. IV
8375 */
8376#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008377 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008378 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008379 + block_size;
8380 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008381#endif
8382 {
8383 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008384 + block_size
8385 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008386 }
8387
Gilles Peskine449bd832023-01-11 14:50:10 +01008388 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008389 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008390 } else {
8391 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008392 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8393 goto end;
8394 }
8395 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008396 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008397#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8398 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008399 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8400 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008401 }
8402
Gilles Peskine449bd832023-01-11 14:50:10 +01008403 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8404 (unsigned) keylen,
8405 (unsigned) transform->minlen,
8406 (unsigned) transform->ivlen,
8407 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008408
8409 /*
8410 * Finally setup the cipher contexts, IVs and MAC secrets.
8411 */
8412#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008413 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008414 key1 = keyblk + mac_key_len * 2;
8415 key2 = keyblk + mac_key_len * 2 + keylen;
8416
8417 mac_enc = keyblk;
8418 mac_dec = keyblk + mac_key_len;
8419
Gilles Peskine449bd832023-01-11 14:50:10 +01008420 iv_copy_len = (transform->fixed_ivlen) ?
8421 transform->fixed_ivlen : transform->ivlen;
8422 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8423 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8424 iv_copy_len);
8425 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008426#endif /* MBEDTLS_SSL_CLI_C */
8427#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008429 key1 = keyblk + mac_key_len * 2 + keylen;
8430 key2 = keyblk + mac_key_len * 2;
8431
8432 mac_enc = keyblk + mac_key_len;
8433 mac_dec = keyblk;
8434
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 iv_copy_len = (transform->fixed_ivlen) ?
8436 transform->fixed_ivlen : transform->ivlen;
8437 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8438 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8439 iv_copy_len);
8440 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008441#endif /* MBEDTLS_SSL_SRV_C */
8442 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008443 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008444 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8445 goto end;
8446 }
8447
Gilles Peskine449bd832023-01-11 14:50:10 +01008448 if (ssl != NULL && ssl->f_export_keys != NULL) {
8449 ssl->f_export_keys(ssl->p_export_keys,
8450 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8451 master, 48,
8452 randbytes + 32,
8453 randbytes,
8454 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008455 }
8456
8457#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008458 transform->psa_alg = alg;
8459
Gilles Peskine449bd832023-01-11 14:50:10 +01008460 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8461 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8462 psa_set_key_algorithm(&attributes, alg);
8463 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008464
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 if ((status = psa_import_key(&attributes,
8466 key1,
8467 PSA_BITS_TO_BYTES(key_bits),
8468 &transform->psa_key_enc)) != PSA_SUCCESS) {
8469 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008470 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008471 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008472 goto end;
8473 }
8474
Gilles Peskine449bd832023-01-11 14:50:10 +01008475 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008476
Gilles Peskine449bd832023-01-11 14:50:10 +01008477 if ((status = psa_import_key(&attributes,
8478 key2,
8479 PSA_BITS_TO_BYTES(key_bits),
8480 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008481 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008482 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008483 goto end;
8484 }
8485 }
8486#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008487 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8488 cipher_info)) != 0) {
8489 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008490 goto end;
8491 }
8492
Gilles Peskine449bd832023-01-11 14:50:10 +01008493 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8494 cipher_info)) != 0) {
8495 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008496 goto end;
8497 }
8498
Gilles Peskine449bd832023-01-11 14:50:10 +01008499 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8500 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8501 MBEDTLS_ENCRYPT)) != 0) {
8502 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008503 goto end;
8504 }
8505
Gilles Peskine449bd832023-01-11 14:50:10 +01008506 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8507 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8508 MBEDTLS_DECRYPT)) != 0) {
8509 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008510 goto end;
8511 }
8512
8513#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8515 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8516 MBEDTLS_PADDING_NONE)) != 0) {
8517 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008518 goto end;
8519 }
8520
Gilles Peskine449bd832023-01-11 14:50:10 +01008521 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8522 MBEDTLS_PADDING_NONE)) != 0) {
8523 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008524 goto end;
8525 }
8526 }
8527#endif /* MBEDTLS_CIPHER_MODE_CBC */
8528#endif /* MBEDTLS_USE_PSA_CRYPTO */
8529
Neil Armstrong29c0c042022-03-17 17:47:28 +01008530#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8531 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8532 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008533 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008534#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008535 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008536
Gilles Peskine449bd832023-01-11 14:50:10 +01008537 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8538 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8539 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008540
Gilles Peskine449bd832023-01-11 14:50:10 +01008541 if ((status = psa_import_key(&attributes,
8542 mac_enc, mac_key_len,
8543 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008544 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008545 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008546 goto end;
8547 }
8548
Gilles Peskine449bd832023-01-11 14:50:10 +01008549 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8550 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008551#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008552 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008553#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008555 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008556 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8557 PSA_KEY_USAGE_VERIFY_HASH);
8558 } else {
8559 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8560 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008561
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 if ((status = psa_import_key(&attributes,
8563 mac_dec, mac_key_len,
8564 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008565 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008566 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008567 goto end;
8568 }
8569#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8571 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008572 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008573 }
8574 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8575 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008576 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008577 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008578#endif /* MBEDTLS_USE_PSA_CRYPTO */
8579 }
8580#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8581
8582 ((void) mac_dec);
8583 ((void) mac_enc);
8584
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008585end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8587 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008588}
8589
Valerio Settia08b1a42022-11-17 15:10:02 +01008590#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8591 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008592int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008593 psa_pake_operation_t *pake_ctx,
8594 const unsigned char *buf,
8595 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008596{
8597 psa_status_t status;
8598 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008599 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008600 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8601 * At round two perform a single cycle
8602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008604
Gilles Peskine449bd832023-01-11 14:50:10 +01008605 for (; remaining_steps > 0; remaining_steps--) {
8606 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008607 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008608 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008609 /* Length is stored at the first byte */
8610 size_t length = buf[input_offset];
8611 input_offset += 1;
8612
Gilles Peskine449bd832023-01-11 14:50:10 +01008613 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008614 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8615 }
8616
Gilles Peskine449bd832023-01-11 14:50:10 +01008617 status = psa_pake_input(pake_ctx, step,
8618 buf + input_offset, length);
8619 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008620 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008621 }
8622
8623 input_offset += length;
8624 }
8625 }
8626
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008628 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008630
Gilles Peskine449bd832023-01-11 14:50:10 +01008631 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008632}
8633
Valerio Setti6b3dab02022-11-17 17:14:54 +01008634int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008635 psa_pake_operation_t *pake_ctx,
8636 unsigned char *buf,
8637 size_t len, size_t *olen,
8638 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008639{
8640 psa_status_t status;
8641 size_t output_offset = 0;
8642 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008643 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008644 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8645 * At round two perform a single cycle
8646 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008647 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008648
Gilles Peskine449bd832023-01-11 14:50:10 +01008649 for (; remaining_steps > 0; remaining_steps--) {
8650 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8651 step <= PSA_PAKE_STEP_ZK_PROOF;
8652 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008653 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008654 * For each step, prepend 1 byte with the length of the data as
8655 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008656 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008657 status = psa_pake_output(pake_ctx, step,
8658 buf + output_offset + 1,
8659 len - output_offset - 1,
8660 &output_len);
8661 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008662 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008663 }
8664
Valerio Setti99d88c12022-11-22 16:03:43 +01008665 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008666
8667 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008668 }
8669 }
8670
8671 *olen = output_offset;
8672
Gilles Peskine449bd832023-01-11 14:50:10 +01008673 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008674}
Valerio Settia08b1a42022-11-17 15:10:02 +01008675#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8676
Jerry Yuee40f9d2022-02-17 14:55:16 +08008677#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008678int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8679 unsigned char *hash, size_t *hashlen,
8680 unsigned char *data, size_t data_len,
8681 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008682{
8683 psa_status_t status;
8684 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008685 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008686
Gilles Peskine449bd832023-01-11 14:50:10 +01008687 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008688
Gilles Peskine449bd832023-01-11 14:50:10 +01008689 if ((status = psa_hash_setup(&hash_operation,
8690 hash_alg)) != PSA_SUCCESS) {
8691 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008692 goto exit;
8693 }
8694
Gilles Peskine449bd832023-01-11 14:50:10 +01008695 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8696 64)) != PSA_SUCCESS) {
8697 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008698 goto exit;
8699 }
8700
Gilles Peskine449bd832023-01-11 14:50:10 +01008701 if ((status = psa_hash_update(&hash_operation,
8702 data, data_len)) != PSA_SUCCESS) {
8703 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008704 goto exit;
8705 }
8706
Gilles Peskine449bd832023-01-11 14:50:10 +01008707 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8708 hashlen)) != PSA_SUCCESS) {
8709 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8710 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008711 }
8712
8713exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008714 if (status != PSA_SUCCESS) {
8715 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8716 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8717 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008718 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008719 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008720 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8721 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008722 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008723 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008725 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008726 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008727 }
8728 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008729 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008730}
8731
8732#else
8733
Gilles Peskine449bd832023-01-11 14:50:10 +01008734int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8735 unsigned char *hash, size_t *hashlen,
8736 unsigned char *data, size_t data_len,
8737 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008738{
8739 int ret = 0;
8740 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008741 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8742 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008743
Gilles Peskine449bd832023-01-11 14:50:10 +01008744 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008745
Gilles Peskine449bd832023-01-11 14:50:10 +01008746 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008747
8748 /*
8749 * digitally-signed struct {
8750 * opaque client_random[32];
8751 * opaque server_random[32];
8752 * ServerDHParams params;
8753 * };
8754 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008755 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8756 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008757 goto exit;
8758 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008759 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8760 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008761 goto exit;
8762 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008763 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8764 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008765 goto exit;
8766 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008767 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8768 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008769 goto exit;
8770 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008771 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8772 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008773 goto exit;
8774 }
8775
8776exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008777 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008778
Gilles Peskine449bd832023-01-11 14:50:10 +01008779 if (ret != 0) {
8780 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8781 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8782 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008783
Gilles Peskine449bd832023-01-11 14:50:10 +01008784 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008785}
8786#endif /* MBEDTLS_USE_PSA_CRYPTO */
8787
Jerry Yud9d91da2022-02-17 14:57:06 +08008788#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8789
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008790/* Find the preferred hash for a given signature algorithm. */
8791unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008792 mbedtls_ssl_context *ssl,
8793 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008794{
Gabor Mezei078e8032022-04-27 21:17:56 +02008795 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008796 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008797
Gilles Peskine449bd832023-01-11 14:50:10 +01008798 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8799 return MBEDTLS_SSL_HASH_NONE;
8800 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008801
Gilles Peskine449bd832023-01-11 14:50:10 +01008802 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008803 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008804 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8805 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008806 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008807 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8808 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008809
Gilles Peskine449bd832023-01-11 14:50:10 +01008810 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008811#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008812 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008813 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008814 mbedtls_md_psa_alg_from_type(hash_alg_received);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008815
Gilles Peskine449bd832023-01-11 14:50:10 +01008816 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8817 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8818 PSA_ALG_ECDSA(psa_hash_alg),
8819 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008820 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008821 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008822
Gilles Peskine449bd832023-01-11 14:50:10 +01008823 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8824 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8825 PSA_ALG_RSA_PKCS1V15_SIGN(
8826 psa_hash_alg),
8827 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008828 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008829 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008830 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008831#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008832
Gilles Peskine449bd832023-01-11 14:50:10 +01008833 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008834 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008835 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008836
Gilles Peskine449bd832023-01-11 14:50:10 +01008837 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008838}
8839
8840#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8841
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008842/* Serialization of TLS 1.2 sessions:
8843 *
8844 * struct {
8845 * uint64 start_time;
8846 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008847 * uint8 session_id_len; // at most 32
8848 * opaque session_id[32];
8849 * opaque master[48]; // fixed length in the standard
8850 * uint32 verify_result;
8851 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8852 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8853 * uint32 ticket_lifetime;
8854 * uint8 mfl_code; // up to 255 according to standard
8855 * uint8 encrypt_then_mac; // 0 or 1
8856 * } serialized_session_tls12;
8857 *
8858 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008859static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8860 unsigned char *buf,
8861 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008862{
8863 unsigned char *p = buf;
8864 size_t used = 0;
8865
8866#if defined(MBEDTLS_HAVE_TIME)
8867 uint64_t start;
8868#endif
8869#if defined(MBEDTLS_X509_CRT_PARSE_C)
8870#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8871 size_t cert_len;
8872#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8873#endif /* MBEDTLS_X509_CRT_PARSE_C */
8874
8875 /*
8876 * Time
8877 */
8878#if defined(MBEDTLS_HAVE_TIME)
8879 used += 8;
8880
Gilles Peskine449bd832023-01-11 14:50:10 +01008881 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008882 start = (uint64_t) session->start;
8883
Gilles Peskine449bd832023-01-11 14:50:10 +01008884 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008885 p += 8;
8886 }
8887#endif /* MBEDTLS_HAVE_TIME */
8888
8889 /*
8890 * Basic mandatory fields
8891 */
8892 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008893 + 1 /* id_len */
8894 + sizeof(session->id)
8895 + sizeof(session->master)
8896 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008897
Gilles Peskine449bd832023-01-11 14:50:10 +01008898 if (used <= buf_len) {
8899 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008900 p += 2;
8901
Gilles Peskine449bd832023-01-11 14:50:10 +01008902 *p++ = MBEDTLS_BYTE_0(session->id_len);
8903 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008904 p += 32;
8905
Gilles Peskine449bd832023-01-11 14:50:10 +01008906 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008907 p += 48;
8908
Gilles Peskine449bd832023-01-11 14:50:10 +01008909 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008910 p += 4;
8911 }
8912
8913 /*
8914 * Peer's end-entity certificate
8915 */
8916#if defined(MBEDTLS_X509_CRT_PARSE_C)
8917#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008918 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008919 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008920 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008921 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008922 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008923
8924 used += 3 + cert_len;
8925
Gilles Peskine449bd832023-01-11 14:50:10 +01008926 if (used <= buf_len) {
8927 *p++ = MBEDTLS_BYTE_2(cert_len);
8928 *p++ = MBEDTLS_BYTE_1(cert_len);
8929 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008930
Gilles Peskine449bd832023-01-11 14:50:10 +01008931 if (session->peer_cert != NULL) {
8932 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008933 p += cert_len;
8934 }
8935 }
8936#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008937 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008938 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008939 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008940 *p++ = (unsigned char) session->peer_cert_digest_type;
8941 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008942 memcpy(p, session->peer_cert_digest,
8943 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008944 p += session->peer_cert_digest_len;
8945 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008946 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008947 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008948 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008949 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8950 *p++ = 0;
8951 }
8952 }
8953#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8954#endif /* MBEDTLS_X509_CRT_PARSE_C */
8955
8956 /*
8957 * Session ticket if any, plus associated data
8958 */
8959#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8960 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8961
Gilles Peskine449bd832023-01-11 14:50:10 +01008962 if (used <= buf_len) {
8963 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
8964 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
8965 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008966
Gilles Peskine449bd832023-01-11 14:50:10 +01008967 if (session->ticket != NULL) {
8968 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008969 p += session->ticket_len;
8970 }
8971
Gilles Peskine449bd832023-01-11 14:50:10 +01008972 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008973 p += 4;
8974 }
8975#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8976
8977 /*
8978 * Misc extension-related info
8979 */
8980#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8981 used += 1;
8982
Gilles Peskine449bd832023-01-11 14:50:10 +01008983 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008984 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01008985 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008986#endif
8987
8988#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8989 used += 1;
8990
Gilles Peskine449bd832023-01-11 14:50:10 +01008991 if (used <= buf_len) {
8992 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
8993 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008994#endif
8995
Gilles Peskine449bd832023-01-11 14:50:10 +01008996 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008997}
8998
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008999MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009000static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9001 const unsigned char *buf,
9002 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009003{
9004#if defined(MBEDTLS_HAVE_TIME)
9005 uint64_t start;
9006#endif
9007#if defined(MBEDTLS_X509_CRT_PARSE_C)
9008#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9009 size_t cert_len;
9010#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9011#endif /* MBEDTLS_X509_CRT_PARSE_C */
9012
9013 const unsigned char *p = buf;
9014 const unsigned char * const end = buf + len;
9015
9016 /*
9017 * Time
9018 */
9019#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009020 if (8 > (size_t) (end - p)) {
9021 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9022 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009023
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009024 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009025 p += 8;
9026
9027 session->start = (time_t) start;
9028#endif /* MBEDTLS_HAVE_TIME */
9029
9030 /*
9031 * Basic mandatory fields
9032 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009033 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9034 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9035 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009036
Gilles Peskine449bd832023-01-11 14:50:10 +01009037 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009038 p += 2;
9039
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009040 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009041 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009042 p += 32;
9043
Gilles Peskine449bd832023-01-11 14:50:10 +01009044 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009045 p += 48;
9046
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009047 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009048 p += 4;
9049
9050 /* Immediately clear invalid pointer values that have been read, in case
9051 * we exit early before we replaced them with valid ones. */
9052#if defined(MBEDTLS_X509_CRT_PARSE_C)
9053#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9054 session->peer_cert = NULL;
9055#else
9056 session->peer_cert_digest = NULL;
9057#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9058#endif /* MBEDTLS_X509_CRT_PARSE_C */
9059#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9060 session->ticket = NULL;
9061#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9062
9063 /*
9064 * Peer certificate
9065 */
9066#if defined(MBEDTLS_X509_CRT_PARSE_C)
9067#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9068 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009069 if (3 > (size_t) (end - p)) {
9070 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9071 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009072
Gilles Peskine449bd832023-01-11 14:50:10 +01009073 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009074 p += 3;
9075
Gilles Peskine449bd832023-01-11 14:50:10 +01009076 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009077 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9078
Gilles Peskine449bd832023-01-11 14:50:10 +01009079 if (cert_len > (size_t) (end - p)) {
9080 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9081 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009082
Gilles Peskine449bd832023-01-11 14:50:10 +01009083 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009084
Gilles Peskine449bd832023-01-11 14:50:10 +01009085 if (session->peer_cert == NULL) {
9086 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9087 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009088
Gilles Peskine449bd832023-01-11 14:50:10 +01009089 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009090
Gilles Peskine449bd832023-01-11 14:50:10 +01009091 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9092 p, cert_len)) != 0) {
9093 mbedtls_x509_crt_free(session->peer_cert);
9094 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009095 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009096 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009097 }
9098
9099 p += cert_len;
9100 }
9101#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9102 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009103 if (2 > (size_t) (end - p)) {
9104 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9105 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009106
9107 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9108 session->peer_cert_digest_len = (size_t) *p++;
9109
Gilles Peskine449bd832023-01-11 14:50:10 +01009110 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009111 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009112 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9113 if (md_info == NULL) {
9114 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9115 }
9116 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9118 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009119
Gilles Peskine449bd832023-01-11 14:50:10 +01009120 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9122 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009123
9124 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009125 mbedtls_calloc(1, session->peer_cert_digest_len);
9126 if (session->peer_cert_digest == NULL) {
9127 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9128 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009129
Gilles Peskine449bd832023-01-11 14:50:10 +01009130 memcpy(session->peer_cert_digest, p,
9131 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009132 p += session->peer_cert_digest_len;
9133 }
9134#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9135#endif /* MBEDTLS_X509_CRT_PARSE_C */
9136
9137 /*
9138 * Session ticket and associated data
9139 */
9140#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009141 if (3 > (size_t) (end - p)) {
9142 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9143 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009144
Gilles Peskine449bd832023-01-11 14:50:10 +01009145 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009146 p += 3;
9147
Gilles Peskine449bd832023-01-11 14:50:10 +01009148 if (session->ticket_len != 0) {
9149 if (session->ticket_len > (size_t) (end - p)) {
9150 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9151 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009152
Gilles Peskine449bd832023-01-11 14:50:10 +01009153 session->ticket = mbedtls_calloc(1, session->ticket_len);
9154 if (session->ticket == NULL) {
9155 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9156 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009157
Gilles Peskine449bd832023-01-11 14:50:10 +01009158 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009159 p += session->ticket_len;
9160 }
9161
Gilles Peskine449bd832023-01-11 14:50:10 +01009162 if (4 > (size_t) (end - p)) {
9163 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9164 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009165
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009166 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009167 p += 4;
9168#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9169
9170 /*
9171 * Misc extension-related info
9172 */
9173#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009174 if (1 > (size_t) (end - p)) {
9175 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9176 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009177
9178 session->mfl_code = *p++;
9179#endif
9180
9181#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009182 if (1 > (size_t) (end - p)) {
9183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9184 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009185
9186 session->encrypt_then_mac = *p++;
9187#endif
9188
9189 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009190 if (p != end) {
9191 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9192 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009193
Gilles Peskine449bd832023-01-11 14:50:10 +01009194 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009195}
Jerry Yudc7bd172022-02-17 13:44:15 +08009196#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9197
XiaokangQian75d40ef2022-04-20 11:05:24 +00009198int mbedtls_ssl_validate_ciphersuite(
9199 const mbedtls_ssl_context *ssl,
9200 const mbedtls_ssl_ciphersuite_t *suite_info,
9201 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009203{
9204 (void) ssl;
9205
Gilles Peskine449bd832023-01-11 14:50:10 +01009206 if (suite_info == NULL) {
9207 return -1;
9208 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009209
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 if ((suite_info->min_tls_version > max_tls_version) ||
9211 (suite_info->max_tls_version < min_tls_version)) {
9212 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009213 }
9214
XiaokangQian060d8672022-04-21 09:24:56 +00009215#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009216#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009217#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009218 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9219 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009220#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009221 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9222 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009223#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009224 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009225 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009226 }
9227#endif
9228
9229 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9230#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009231 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9232 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9233 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009234 }
9235#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9236#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9237
Gilles Peskine449bd832023-01-11 14:50:10 +01009238 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009239}
9240
Ronald Crone68ab4f2022-10-05 12:46:29 +02009241#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009242/*
9243 * Function for writing a signature algorithm extension.
9244 *
9245 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9246 * value (TLS 1.3 RFC8446):
9247 * enum {
9248 * ....
9249 * ecdsa_secp256r1_sha256( 0x0403 ),
9250 * ecdsa_secp384r1_sha384( 0x0503 ),
9251 * ecdsa_secp521r1_sha512( 0x0603 ),
9252 * ....
9253 * } SignatureScheme;
9254 *
9255 * struct {
9256 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9257 * } SignatureSchemeList;
9258 *
9259 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9260 * value (TLS 1.2 RFC5246):
9261 * enum {
9262 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9263 * sha512(6), (255)
9264 * } HashAlgorithm;
9265 *
9266 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9267 * SignatureAlgorithm;
9268 *
9269 * struct {
9270 * HashAlgorithm hash;
9271 * SignatureAlgorithm signature;
9272 * } SignatureAndHashAlgorithm;
9273 *
9274 * SignatureAndHashAlgorithm
9275 * supported_signature_algorithms<2..2^16-2>;
9276 *
9277 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9278 * generalization of the TLS 1.2 signature algorithm extension.
9279 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9280 * `SignatureScheme` field of TLS 1.3
9281 *
9282 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009283int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9284 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009285{
9286 unsigned char *p = buf;
9287 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9288 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9289
9290 *out_len = 0;
9291
Gilles Peskine449bd832023-01-11 14:50:10 +01009292 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009293
9294 /* Check if we have space for header and length field:
9295 * - extension_type (2 bytes)
9296 * - extension_data_length (2 bytes)
9297 * - supported_signature_algorithms_length (2 bytes)
9298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009299 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009300 p += 6;
9301
9302 /*
9303 * Write supported_signature_algorithms
9304 */
9305 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009306 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9307 if (sig_alg == NULL) {
9308 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9309 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009310
Gilles Peskine449bd832023-01-11 14:50:10 +01009311 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9312 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9313 *sig_alg,
9314 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9315 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009316 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009317 }
9318 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9319 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009320 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009321 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9322 *sig_alg,
9323 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009324 }
9325
9326 /* Length of supported_signature_algorithms */
9327 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009328 if (supported_sig_alg_len == 0) {
9329 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9330 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009331 }
9332
Gilles Peskine449bd832023-01-11 14:50:10 +01009333 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9334 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9335 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009336
XiaokangQianeaf36512022-04-24 09:07:44 +00009337 *out_len = p - buf;
9338
9339#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009340 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009341#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009342
Gilles Peskine449bd832023-01-11 14:50:10 +01009343 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009344}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009345#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009346
XiaokangQian40a35232022-05-07 09:02:40 +00009347#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009348/*
9349 * mbedtls_ssl_parse_server_name_ext
9350 *
9351 * Structure of server_name extension:
9352 *
9353 * enum {
9354 * host_name(0), (255)
9355 * } NameType;
9356 * opaque HostName<1..2^16-1>;
9357 *
9358 * struct {
9359 * NameType name_type;
9360 * select (name_type) {
9361 * case host_name: HostName;
9362 * } name;
9363 * } ServerName;
9364 * struct {
9365 * ServerName server_name_list<1..2^16-1>
9366 * } ServerNameList;
9367 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009368MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009369int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9370 const unsigned char *buf,
9371 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009372{
9373 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9374 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009375 size_t server_name_list_len, hostname_len;
9376 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009377
Gilles Peskine449bd832023-01-11 14:50:10 +01009378 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009379
Gilles Peskine449bd832023-01-11 14:50:10 +01009380 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9381 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009382 p += 2;
9383
Gilles Peskine449bd832023-01-11 14:50:10 +01009384 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009385 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009386 while (p < server_name_list_end) {
9387 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9388 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9389 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9390 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009391
Gilles Peskine449bd832023-01-11 14:50:10 +01009392 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009393 /* sni_name is intended to be used only during the parsing of the
9394 * ClientHello message (it is reset to NULL before the end of
9395 * the message parsing). Thus it is ok to just point to the
9396 * reception buffer and not make a copy of it.
9397 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009398 ssl->handshake->sni_name = p + 3;
9399 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009400 if (ssl->conf->f_sni == NULL) {
9401 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009402 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009403 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9404 ssl, p + 3, hostname_len);
9405 if (ret != 0) {
9406 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9407 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9408 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9409 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9410 }
9411 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009412 }
9413
9414 p += hostname_len + 3;
9415 }
9416
Gilles Peskine449bd832023-01-11 14:50:10 +01009417 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009418}
9419#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9420
XiaokangQianacb39922022-06-17 10:18:48 +00009421#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009422MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009423int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9424 const unsigned char *buf,
9425 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009426{
9427 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009428 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009429 const unsigned char *protocol_name_list;
9430 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009431 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009432
9433 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009434 if (ssl->conf->alpn_list == NULL) {
9435 return 0;
9436 }
XiaokangQianacb39922022-06-17 10:18:48 +00009437
9438 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009439 * RFC7301, section 3.1
9440 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009441 *
XiaokangQianc7403452022-06-23 03:24:12 +00009442 * struct {
9443 * ProtocolName protocol_name_list<2..2^16-1>
9444 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009445 */
9446
XiaokangQianc7403452022-06-23 03:24:12 +00009447 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009448 * protocol_name_list_len 2 bytes
9449 * protocol_name_len 1 bytes
9450 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009451 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009452 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009453
Gilles Peskine449bd832023-01-11 14:50:10 +01009454 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009455 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009456 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009457 protocol_name_list = p;
9458 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009459
9460 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009461 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009462 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009463 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9464 protocol_name_len);
9465 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009466 MBEDTLS_SSL_PEND_FATAL_ALERT(
9467 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009468 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9469 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009470 }
9471
9472 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009473 }
9474
9475 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009476 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9477 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009478 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009479 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009480 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009481 if (protocol_name_len == alpn_len &&
9482 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009483 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009484 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009485 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009486
9487 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009488 }
9489 }
9490
XiaokangQian95d5f542022-06-24 02:29:26 +00009491 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009492 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009493 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9494 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9495 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009496}
9497
Gilles Peskine449bd832023-01-11 14:50:10 +01009498int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9499 unsigned char *buf,
9500 unsigned char *end,
9501 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009502{
9503 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009504 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009505 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009506
Gilles Peskine449bd832023-01-11 14:50:10 +01009507 if (ssl->alpn_chosen == NULL) {
9508 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009509 }
9510
Gilles Peskine449bd832023-01-11 14:50:10 +01009511 protocol_name_len = strlen(ssl->alpn_chosen);
9512 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009513
Gilles Peskine449bd832023-01-11 14:50:10 +01009514 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009515 /*
9516 * 0 . 1 ext identifier
9517 * 2 . 3 ext length
9518 * 4 . 5 protocol list length
9519 * 6 . 6 protocol name length
9520 * 7 . 7+n protocol name
9521 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009522 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009523
XiaokangQian95d5f542022-06-24 02:29:26 +00009524 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009525
Gilles Peskine449bd832023-01-11 14:50:10 +01009526 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9527 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009528 /* Note: the length of the chosen protocol has been checked to be less
9529 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9530 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009531 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009532
Gilles Peskine449bd832023-01-11 14:50:10 +01009533 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009534
9535#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009536 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009537#endif
9538
Gilles Peskine449bd832023-01-11 14:50:10 +01009539 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009540}
9541#endif /* MBEDTLS_SSL_ALPN */
9542
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009543#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009544 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009545 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009546 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009547int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9548 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009549{
9550 /* Initialize to suppress unnecessary compiler warning */
9551 size_t hostname_len = 0;
9552
9553 /* Check if new hostname is valid before
9554 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009555 if (hostname != NULL) {
9556 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009557
Gilles Peskine449bd832023-01-11 14:50:10 +01009558 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9559 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9560 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009561 }
9562
9563 /* Now it's clear that we will overwrite the old hostname,
9564 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009565 if (session->hostname != NULL) {
9566 mbedtls_platform_zeroize(session->hostname,
9567 strlen(session->hostname));
9568 mbedtls_free(session->hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009569 }
9570
9571 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009572 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009573 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009574 } else {
9575 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9576 if (session->hostname == NULL) {
9577 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9578 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009579
Gilles Peskine449bd832023-01-11 14:50:10 +01009580 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009581 }
9582
Gilles Peskine449bd832023-01-11 14:50:10 +01009583 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009584}
Xiaokang Qian03409292022-10-12 02:49:52 +00009585#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9586 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009587 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009588 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009589
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009590#endif /* MBEDTLS_SSL_TLS_C */