blob: 24a103f827fce47cb4e470bb6f6f43a675aaa69e [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"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020045#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050046#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);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100330 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500331
332 *buffer = resized_buffer;
333 *len_old = len_new;
334
335 return 0;
336}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200337
Gilles Peskine449bd832023-01-11 14:50:10 +0100338static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
339 size_t in_buf_new_len,
340 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200341{
342 int modified = 0;
343 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
344 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200346 written_in = ssl->in_msg - ssl->in_buf;
347 iv_offset_in = ssl->in_iv - ssl->in_buf;
348 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200350 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 ssl->in_buf_len < in_buf_new_len) {
352 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
353 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
354 } else {
355 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
356 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200357 modified = 1;
358 }
359 }
360 }
361
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200363 written_out = ssl->out_msg - ssl->out_buf;
364 iv_offset_out = ssl->out_iv - ssl->out_buf;
365 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 ssl->out_buf_len < out_buf_new_len) {
369 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
370 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
371 } else {
372 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
373 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200374 modified = 1;
375 }
376 }
377 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200379 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100380 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200381 /* Fields below might not be properly updated with record
382 * splitting or with CID, so they are manually updated here. */
383 ssl->out_msg = ssl->out_buf + written_out;
384 ssl->out_len = ssl->out_buf + len_offset_out;
385 ssl->out_iv = ssl->out_buf + iv_offset_out;
386
387 ssl->in_msg = ssl->in_buf + written_in;
388 ssl->in_len = ssl->in_buf + len_offset_in;
389 ssl->in_iv = ssl->in_buf + iv_offset_in;
390 }
391}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500392#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
393
Jerry Yudb8c48a2022-01-27 14:54:54 +0800394#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800395
396#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100397typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
398 const char *label,
399 const unsigned char *random, size_t rlen,
400 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800401
Gilles Peskine449bd832023-01-11 14:50:10 +0100402static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800403
404#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
405
406/* Type for the TLS PRF */
407typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
408 const unsigned char *, size_t,
409 unsigned char *, size_t);
410
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200411MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100412static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
413 int ciphersuite,
414 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200415#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200417#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 ssl_tls_prf_t tls_prf,
419 const unsigned char randbytes[64],
420 mbedtls_ssl_protocol_version tls_version,
421 unsigned endpoint,
422 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800423
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100424#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200425MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100426static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300427 const char *label,
428 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100429 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100430static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
431static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100432
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100433#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100434
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100435#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100436MBEDTLS_CHECK_RETURN_CRITICAL
437static int tls_prf_sha384(const unsigned char *secret, size_t slen,
438 const char *label,
439 const unsigned char *random, size_t rlen,
440 unsigned char *dstbuf, size_t dlen);
441
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100442static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
443static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100444#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100445
446static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
447 unsigned char *buf,
448 size_t buf_len);
449
450MBEDTLS_CHECK_RETURN_CRITICAL
451static int ssl_tls12_session_load(mbedtls_ssl_session *session,
452 const unsigned char *buf,
453 size_t len);
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
455
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100456static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100457
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100458#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100459static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100460#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100461
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100462#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100463static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100464#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100465
466int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
467 const unsigned char *secret, size_t slen,
468 const char *label,
469 const unsigned char *random, size_t rlen,
470 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300471{
472 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
473
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300475#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100476#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 case MBEDTLS_SSL_TLS_PRF_SHA384:
478 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100480#endif /* MBEDTLS_MD_CAN_SHA384*/
481#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300482 case MBEDTLS_SSL_TLS_PRF_SHA256:
483 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100485#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300486#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 default:
488 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300489 }
490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300492}
493
Jerry Yuc73c6182022-02-08 20:29:25 +0800494#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100495static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800496{
497#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 if (session->peer_cert != NULL) {
499 mbedtls_x509_crt_free(session->peer_cert);
500 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800501 session->peer_cert = NULL;
502 }
503#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800505 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800507 session->peer_cert_digest = NULL;
508 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
509 session->peer_cert_digest_len = 0;
510 }
511#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
512}
513#endif /* MBEDTLS_X509_CRT_PARSE_C */
514
Gilles Peskine449bd832023-01-11 14:50:10 +0100515uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800516{
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800518 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
584 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800592
593 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800595
Jan Bruckner151f6422023-02-10 12:45:19 +0100596 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
597 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
598
Jerry Yu7a485c12022-10-31 13:08:18 +0800599 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800601
602 }
603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800605}
606
Gilles Peskine449bd832023-01-11 14:50:10 +0100607uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800608{
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800610}
611
Jerry Yud25cab02022-10-31 12:48:30 +0800612#if defined(MBEDTLS_DEBUG_C)
613static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800614 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800615 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
616 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
617 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
618 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
619 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
620 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
621 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
622 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
623 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
624 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
625 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
626 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
627 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
628 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
629 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
630 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
631 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
632 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
633 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
634 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
635 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
636 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
637 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
639 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
640 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100641 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
642 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800643};
644
Gilles Peskine449bd832023-01-11 14:50:10 +0100645static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800646 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
647 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
648 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
649 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
650 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
651 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
652 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
653 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
654 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
655 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
656 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
657 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
658 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
659 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
660 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
661 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
662 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
663 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
664 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
665 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
666 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
667 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
668 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
669 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
670 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
671 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
672 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100673 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
674 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800675};
676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800678{
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return extension_name_table[
680 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800681}
682
Gilles Peskine449bd832023-01-11 14:50:10 +0100683static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800684{
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800690 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800692 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800694 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800696 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800698 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800700 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800702}
703
Gilles Peskine449bd832023-01-11 14:50:10 +0100704void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
705 int level, const char *file, int line,
706 int hs_msg_type, unsigned int extension_type,
707 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800708{
709 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
713 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 ssl_tls13_get_hs_msg_name(hs_msg_type),
715 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800716 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800718 return;
719 }
720
721 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800723 mbedtls_debug_print_msg(
724 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
726 mbedtls_ssl_get_extension_name(extension_type), extension_type,
727 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800728 return;
729 }
730
731 mbedtls_debug_print_msg(
732 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
734 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800735}
736
Gilles Peskine449bd832023-01-11 14:50:10 +0100737void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
738 int level, const char *file, int line,
739 int hs_msg_type, uint32_t extensions_mask,
740 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800741{
742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 for (unsigned i = 0;
744 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
745 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800746 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800747 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800749 }
750}
751
Pengyu Lvee455c02023-01-12 14:37:24 +0800752#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800753static const char *ticket_flag_name_table[] =
754{
755 [0] = "ALLOW_PSK_RESUMPTION",
756 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
757 [3] = "ALLOW_EARLY_DATA",
758};
759
Pengyu Lv4938a562023-01-16 11:28:49 +0800760void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
761 int level, const char *file, int line,
762 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800763{
764 size_t i;
765
766 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 "print ticket_flags (0x%02x)", flags);
768
769 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800770
771 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800772 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800773 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
774 ticket_flag_name_table[i]);
775 }
776 }
777}
778#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
779
Jerry Yud25cab02022-10-31 12:48:30 +0800780#endif /* MBEDTLS_DEBUG_C */
781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
783 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800784{
785 ((void) ciphersuite_info);
786
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100787#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800789 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100792#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800796#endif
797 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800799 return;
800 }
801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100806{
807 unsigned char hs_hdr[4];
808
809 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
811 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
812 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
813 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100815 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100816}
817
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100819 unsigned hs_type,
820 unsigned char const *msg,
821 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100822{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 int ret;
824 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100825 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100826 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100827 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100828 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100829}
830
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100831int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100833#if defined(MBEDTLS_MD_CAN_SHA256) || \
834 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835#if defined(MBEDTLS_USE_PSA_CRYPTO)
836 psa_status_t status;
837#else
838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
839#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100840#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800841 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100842#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100843#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800844#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100845 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
846 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200847 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 }
849 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
850 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200851 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100852 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800853#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100854 mbedtls_md_free(&ssl->handshake->fin_sha256);
855 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100856 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
857 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
858 0);
859 if (ret != 0) {
860 return ret;
861 }
862 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100863 if (ret != 0) {
864 return ret;
865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#endif
867#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100868#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800869#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100870 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
871 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200872 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100873 }
874 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
875 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200876 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100879 mbedtls_md_free(&ssl->handshake->fin_sha384);
880 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100881 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
882 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
883 if (ret != 0) {
884 return ret;
885 }
886 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100887 if (ret != 0) {
888 return ret;
889 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800890#endif
891#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100892 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800893}
894
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100895static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100896 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800897{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256) || \
899 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900#if defined(MBEDTLS_USE_PSA_CRYPTO)
901 psa_status_t status;
902#else
903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
904#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100905#else /* SHA-256 or SHA-384 */
906 ((void) ssl);
907 (void) buf;
908 (void) len;
909#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100910#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800911#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100912 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
913 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200914 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100915 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800916#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100917 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100918 if (ret != 0) {
919 return ret;
920 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800921#endif
922#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100923#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800924#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100925 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
926 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200927 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100928 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800929#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100930 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100931 if (ret != 0) {
932 return ret;
933 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#endif
935#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100936 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800937}
938
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100939#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100940static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100941 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800942{
943#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200944 return mbedtls_md_error_from_psa(psa_hash_update(
945 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800946#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100947 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800948#endif
949}
950#endif
951
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100952#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100953static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100954 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800955{
956#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200957 return mbedtls_md_error_from_psa(psa_hash_update(
958 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800959#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100960 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800961#endif
962}
963#endif
964
Gilles Peskine449bd832023-01-11 14:50:10 +0100965static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200966{
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200968
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100969#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#if defined(MBEDTLS_USE_PSA_CRYPTO)
971 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500972#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100973 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200974#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500975#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100976#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500977#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500978 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500979#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100980 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200981#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500982#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200983
984 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200988#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200989#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200991#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200992#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200993#if defined(MBEDTLS_USE_PSA_CRYPTO)
994 handshake->psa_pake_ctx = psa_pake_operation_init();
995 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
996#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200998#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200999#if defined(MBEDTLS_SSL_CLI_C)
1000 handshake->ecjpake_cache = NULL;
1001 handshake->ecjpake_cache_len = 0;
1002#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001003#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001004
Gilles Peskineeccd8882020-03-10 12:19:08 +01001005#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001007#endif
1008
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001009#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1010 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1011#endif
Hanno Becker75173122019-02-06 16:18:31 +00001012
1013#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1014 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001016#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001017}
1018
Gilles Peskine449bd832023-01-11 14:50:10 +01001019void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001020{
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001022
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001023#if defined(MBEDTLS_USE_PSA_CRYPTO)
1024 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1025 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001026#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001027 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1028 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001029#endif
1030
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001031#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001032#if defined(MBEDTLS_USE_PSA_CRYPTO)
1033 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1034 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001035#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 mbedtls_md_init(&transform->md_ctx_enc);
1037 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001038#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001039#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001040}
1041
Gilles Peskine449bd832023-01-11 14:50:10 +01001042void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001043{
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001045}
1046
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001047MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001048static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001049{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001050 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1051
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001052 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001053#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001054 if (ssl->transform_negotiate) {
1055 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1056 }
Jerry Yu2e199812022-12-01 18:57:19 +08001057#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 if (ssl->session_negotiate) {
1059 mbedtls_ssl_session_free(ssl->session_negotiate);
1060 }
1061 if (ssl->handshake) {
1062 mbedtls_ssl_handshake_free(ssl);
1063 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001064
Jerry Yu2e199812022-12-01 18:57:19 +08001065#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001066 /*
1067 * Either the pointers are now NULL or cleared properly and can be freed.
1068 * Now allocate missing structures.
1069 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 if (ssl->transform_negotiate == NULL) {
1071 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001072 }
Jerry Yu2e199812022-12-01 18:57:19 +08001073#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001074
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 if (ssl->session_negotiate == NULL) {
1076 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001077 }
Paul Bakker48916f92012-09-16 19:57:18 +00001078
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 if (ssl->handshake == NULL) {
1080 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001081 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001082#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1083 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001084
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1086 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001087#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001088
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001089 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001091#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001092 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001093#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 ssl->session_negotiate == NULL) {
1095 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001098 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001099
1100#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001102 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001103#endif
1104
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001106 ssl->session_negotiate = NULL;
1107
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001109 }
1110
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001111 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 mbedtls_ssl_session_init(ssl->session_negotiate);
1113 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001114
Jerry Yu2e199812022-12-01 18:57:19 +08001115#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001117#endif
1118
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001119 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001120 ret = mbedtls_ssl_reset_checksum(ssl);
1121 if (ret != 0) {
1122 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1123 return ret;
1124 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001125
Jerry Yud0766ec2022-09-22 10:46:57 +08001126#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1127 defined(MBEDTLS_SSL_SRV_C) && \
1128 defined(MBEDTLS_SSL_SESSION_TICKETS)
1129 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001131#endif
1132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001133#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001135 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001136
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001138 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001140 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001142
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001144 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001145#endif
1146
Brett Warrene0edc842021-08-17 09:53:13 +01001147/*
1148 * curve_list is translated to IANA TLS group identifiers here because
1149 * mbedtls_ssl_conf_curves returns void and so can't return
1150 * any error codes.
1151 */
Valerio Setti6c496a12023-04-07 15:53:51 +02001152#if defined(MBEDTLS_ECP_LIGHT)
Brett Warrene0edc842021-08-17 09:53:13 +01001153#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1154 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001156 size_t length;
1157 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1158
Thomas Daubney850a0792023-05-22 12:05:03 +01001159 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 }
Brett Warrene0edc842021-08-17 09:53:13 +01001161
1162 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001163 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1164 if (group_list == NULL) {
1165 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1166 }
Brett Warrene0edc842021-08-17 09:53:13 +01001167
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001169 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 curve_list[i]);
1171 if (tls_id == 0) {
1172 mbedtls_free(group_list);
1173 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001174 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001175 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001176 }
1177
1178 group_list[length] = 0;
1179
1180 ssl->handshake->group_list = group_list;
1181 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001183 ssl->handshake->group_list = ssl->conf->group_list;
1184 ssl->handshake->group_list_heap_allocated = 0;
1185 }
1186#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6c496a12023-04-07 15:53:51 +02001187#endif /* MBEDTLS_ECP_LIGHT */
Brett Warrene0edc842021-08-17 09:53:13 +01001188
Ronald Crone68ab4f2022-10-05 12:46:29 +02001189#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001190#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001191#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001192 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1193 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1195 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001196 const int *md;
1197 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001198 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001199 uint16_t *p;
1200
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001201 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1202 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1203 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001204
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1206 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001207 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 }
Valerio Setti75fba322023-02-23 17:35:09 +01001209#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001211#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001212
Jerry Yub476a442022-01-21 18:14:45 +08001213#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001215#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1217 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1218 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001219 }
1220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1222 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1223 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001224
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1226 sizeof(uint16_t));
1227 if (ssl->handshake->sig_algs == NULL) {
1228 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1229 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001230
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 p = (uint16_t *) ssl->handshake->sig_algs;
1232 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1233 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1234 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001235 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 }
Valerio Setti75fba322023-02-23 17:35:09 +01001237#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001240#endif
1241#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001243 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001244#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001245 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001246 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001247 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001249#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001250 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001251 ssl->handshake->sig_algs_heap_allocated = 0;
1252 }
Jerry Yucc539102022-06-27 16:27:35 +08001253#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001254#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001255 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001256}
1257
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001258#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001259/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001260MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001261static int ssl_cookie_write_dummy(void *ctx,
1262 unsigned char **p, unsigned char *end,
1263 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001264{
1265 ((void) ctx);
1266 ((void) p);
1267 ((void) end);
1268 ((void) cli_id);
1269 ((void) cli_id_len);
1270
Gilles Peskine449bd832023-01-11 14:50:10 +01001271 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001272}
1273
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001274MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001275static int ssl_cookie_check_dummy(void *ctx,
1276 const unsigned char *cookie, size_t cookie_len,
1277 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001278{
1279 ((void) ctx);
1280 ((void) cookie);
1281 ((void) cookie_len);
1282 ((void) cli_id);
1283 ((void) cli_id_len);
1284
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001286}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001287#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001288
Paul Bakker5121ce52009-01-03 21:22:43 +00001289/*
1290 * Initialize an SSL context
1291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001292void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001293{
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001295}
1296
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001297MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001298static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001299{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001300 const mbedtls_ssl_config *conf = ssl->conf;
1301
Ronald Cron6f135e12021-12-08 16:57:54 +01001302#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1304 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1305 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1306 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001307 }
1308
Gilles Peskine449bd832023-01-11 14:50:10 +01001309 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1310 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001311 }
1312#endif
1313
1314#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1316 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1317 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001318 }
1319#endif
1320
Ronald Cron6f135e12021-12-08 16:57:54 +01001321#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1323 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1324 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1325 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001326 }
1327
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1329 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001330 }
1331#endif
1332
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1334 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001335}
1336
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001337MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001338static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1339{
1340 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 ret = ssl_conf_version_check(ssl);
1342 if (ret != 0) {
1343 return ret;
1344 }
Jerry Yu60835a82021-08-04 10:13:52 +08001345
Jerry Yudef7ae42022-10-30 14:13:19 +08001346#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1347 /* RFC 8446 section 4.4.3
1348 *
1349 * If the verification fails, the receiver MUST terminate the handshake with
1350 * a "decrypt_error" alert.
1351 *
1352 * If the client is configured as TLS 1.3 only with optional verify, return
1353 * bad config.
1354 *
1355 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1357 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001358 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1359 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1360 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001362 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 1, ("Optional verify auth mode "
1364 "is not available for TLS 1.3 client"));
1365 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001366 }
1367#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1368
Jerry Yu60835a82021-08-04 10:13:52 +08001369 /* Space for further checks */
1370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001372}
1373
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001374/*
1375 * Setup an SSL context
1376 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001377
Gilles Peskine449bd832023-01-11 14:50:10 +01001378int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1379 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001380{
Janos Follath865b3eb2019-12-16 11:46:15 +00001381 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001382 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1383 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001384
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001385 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001386
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 if ((ret = ssl_conf_check(ssl)) != 0) {
1388 return ret;
1389 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001390 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001391
Paul Bakker62f2dee2012-09-28 07:31:51 +00001392 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001393 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001394 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001395
1396 /* Set to NULL in case of an error condition */
1397 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001398
Darryl Greenb33cc762019-11-28 14:29:44 +00001399#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1400 ssl->in_buf_len = in_buf_len;
1401#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1403 if (ssl->in_buf == NULL) {
1404 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001405 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001406 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001407 }
1408
Darryl Greenb33cc762019-11-28 14:29:44 +00001409#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1410 ssl->out_buf_len = out_buf_len;
1411#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1413 if (ssl->out_buf == NULL) {
1414 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001415 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001416 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001417 }
1418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001420
Johan Pascalb62bb512015-12-03 21:56:45 +01001421#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001423#endif
1424
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001426 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001428
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001430
1431error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 mbedtls_free(ssl->in_buf);
1433 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001434
1435 ssl->conf = NULL;
1436
Darryl Greenb33cc762019-11-28 14:29:44 +00001437#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1438 ssl->in_buf_len = 0;
1439 ssl->out_buf_len = 0;
1440#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001441 ssl->in_buf = NULL;
1442 ssl->out_buf = NULL;
1443
1444 ssl->in_hdr = NULL;
1445 ssl->in_ctr = NULL;
1446 ssl->in_len = NULL;
1447 ssl->in_iv = NULL;
1448 ssl->in_msg = NULL;
1449
1450 ssl->out_hdr = NULL;
1451 ssl->out_ctr = NULL;
1452 ssl->out_len = NULL;
1453 ssl->out_iv = NULL;
1454 ssl->out_msg = NULL;
1455
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001457}
1458
1459/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001460 * Reset an initialized and used SSL context for re-use while retaining
1461 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001462 *
1463 * If partial is non-zero, keep data in the input buffer and client ID.
1464 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001465 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001466void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1467 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001468{
Darryl Greenb33cc762019-11-28 14:29:44 +00001469#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1470 size_t in_buf_len = ssl->in_buf_len;
1471 size_t out_buf_len = ssl->out_buf_len;
1472#else
1473 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1474 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1475#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001476
Hanno Beckerb0302c42021-08-03 09:39:42 +01001477#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1478 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001479#endif
1480
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001481 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001482 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001483
Gilles Peskine449bd832023-01-11 14:50:10 +01001484 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001485
1486 /* Reset incoming message parsing */
1487 ssl->in_offt = NULL;
1488 ssl->nb_zero = 0;
1489 ssl->in_msgtype = 0;
1490 ssl->in_msglen = 0;
1491 ssl->in_hslen = 0;
1492 ssl->keep_current_message = 0;
1493 ssl->transform_in = NULL;
1494
1495#if defined(MBEDTLS_SSL_PROTO_DTLS)
1496 ssl->next_record_offset = 0;
1497 ssl->in_epoch = 0;
1498#endif
1499
1500 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001502 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001504 }
1505
Ronald Cronad8c17b2022-06-10 17:18:09 +02001506 ssl->send_alert = 0;
1507
Hanno Beckerb0302c42021-08-03 09:39:42 +01001508 /* Reset outgoing message writing */
1509 ssl->out_msgtype = 0;
1510 ssl->out_msglen = 0;
1511 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 memset(ssl->out_buf, 0, out_buf_len);
1513 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001514 ssl->transform_out = NULL;
1515
1516#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001518#endif
1519
XiaokangQian2b01dc32022-01-21 02:53:13 +00001520#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 if (ssl->transform) {
1522 mbedtls_ssl_transform_free(ssl->transform);
1523 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001524 ssl->transform = NULL;
1525 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001526#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1527
XiaokangQian2b01dc32022-01-21 02:53:13 +00001528#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 mbedtls_ssl_transform_free(ssl->transform_application);
1530 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531 ssl->transform_application = NULL;
1532
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001534#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1536 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001537 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001538#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001539
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1541 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001542 ssl->handshake->transform_handshake = NULL;
1543 }
1544
XiaokangQian2b01dc32022-01-21 02:53:13 +00001545#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001546}
1547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001549{
1550 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1551
1552 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1553
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001555
1556 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557#if defined(MBEDTLS_SSL_RENEGOTIATION)
1558 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001559 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001560
1561 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001562 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1563 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001564#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001565 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001566
Hanno Beckerb0302c42021-08-03 09:39:42 +01001567 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001568 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 if (ssl->session) {
1570 mbedtls_ssl_session_free(ssl->session);
1571 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001572 ssl->session = NULL;
1573 }
1574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001575#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001576 ssl->alpn_chosen = NULL;
1577#endif
1578
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001579#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001580 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001581#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001583#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 if (free_cli_id) {
1585 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001586 ssl->cli_id = NULL;
1587 ssl->cli_id_len = 0;
1588 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001589#endif
1590
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 if ((ret = ssl_handshake_init(ssl)) != 0) {
1592 return ret;
1593 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001594
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001596}
1597
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001598/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001599 * Reset an initialized and used SSL context for re-use while retaining
1600 * all application-set variables, function pointers and data.
1601 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001602int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001603{
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001605}
1606
1607/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001608 * SSL set accessors
1609 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001610void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001611{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001612 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001613}
1614
Gilles Peskine449bd832023-01-11 14:50:10 +01001615void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001616{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001617 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001618}
1619
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001620#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001621void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001622{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001623 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001624}
1625#endif
1626
Gilles Peskine449bd832023-01-11 14:50:10 +01001627void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001628{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001629 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001630}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001631
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001632#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1635 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001636{
1637 ssl->disable_datagram_packing = !allow_packing;
1638}
1639
Gilles Peskine449bd832023-01-11 14:50:10 +01001640void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1641 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001642{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001643 conf->hs_timeout_min = min;
1644 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001645}
1646#endif
1647
Gilles Peskine449bd832023-01-11 14:50:10 +01001648void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001649{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001650 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001651}
1652
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001653#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001654void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1655 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1656 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001657{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001658 conf->f_vrfy = f_vrfy;
1659 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001660}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001661#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001662
Gilles Peskine449bd832023-01-11 14:50:10 +01001663void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1664 int (*f_rng)(void *, unsigned char *, size_t),
1665 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001666{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001667 conf->f_rng = f_rng;
1668 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001669}
1670
Gilles Peskine449bd832023-01-11 14:50:10 +01001671void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1672 void (*f_dbg)(void *, int, const char *, int, const char *),
1673 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001674{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001675 conf->f_dbg = f_dbg;
1676 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001677}
1678
Gilles Peskine449bd832023-01-11 14:50:10 +01001679void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1680 void *p_bio,
1681 mbedtls_ssl_send_t *f_send,
1682 mbedtls_ssl_recv_t *f_recv,
1683 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001684{
1685 ssl->p_bio = p_bio;
1686 ssl->f_send = f_send;
1687 ssl->f_recv = f_recv;
1688 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001689}
1690
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001691#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001692void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001693{
1694 ssl->mtu = mtu;
1695}
1696#endif
1697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001699{
1700 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001701}
1702
Gilles Peskine449bd832023-01-11 14:50:10 +01001703void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1704 void *p_timer,
1705 mbedtls_ssl_set_timer_t *f_set_timer,
1706 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001707{
1708 ssl->p_timer = p_timer;
1709 ssl->f_set_timer = f_set_timer;
1710 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001711
1712 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001713 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001714}
1715
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001717void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1718 void *p_cache,
1719 mbedtls_ssl_cache_get_t *f_get_cache,
1720 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001721{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001722 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001723 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001724 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001725}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001726#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001729int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001730{
Janos Follath865b3eb2019-12-16 11:46:15 +00001731 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001732
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001734 session == NULL ||
1735 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001738 }
1739
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 if (ssl->handshake->resume == 1) {
1741 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1742 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001743
Jerry Yu21092062022-10-10 21:21:31 +08001744#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001746 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001748
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001750 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1752 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1753 session->ciphersuite));
1754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001755 }
Jerry Yu40afab62022-10-08 10:42:13 +08001756 }
Jerry Yu21092062022-10-10 21:21:31 +08001757#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001758
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1760 session)) != 0) {
1761 return ret;
1762 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001763
Paul Bakker0a597072012-09-25 21:55:46 +00001764 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001765
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001767}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001768#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001769
Gilles Peskine449bd832023-01-11 14:50:10 +01001770void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1771 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001772{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001773 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001774}
1775
Ronald Cron6f135e12021-12-08 16:57:54 +01001776#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001777void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1778 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001779{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001780 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001781}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001782
1783#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001784void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
1785 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001786{
1787 conf->early_data_enabled = early_data_enabled;
1788}
Jerry Yucc4e0072022-11-22 17:22:22 +08001789
1790#if defined(MBEDTLS_SSL_SRV_C)
1791void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001793{
Jerry Yu39da9852022-12-06 16:58:36 +08001794 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001795}
1796#endif /* MBEDTLS_SSL_SRV_C */
1797
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001798#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001799#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001800
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001802void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1803 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001804{
1805 conf->cert_profile = profile;
1806}
1807
Gilles Peskine449bd832023-01-11 14:50:10 +01001808static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001809{
1810 mbedtls_ssl_key_cert *cur = key_cert, *next;
1811
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001813 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001815 cur = next;
1816 }
1817}
1818
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001819/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001820MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001821static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1822 mbedtls_x509_crt *cert,
1823 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001824{
niisato8ee24222018-06-25 19:05:48 +09001825 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001826
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001828 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001830 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001832 }
1833
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1835 if (new_cert == NULL) {
1836 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1837 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001838
niisato8ee24222018-06-25 19:05:48 +09001839 new_cert->cert = cert;
1840 new_cert->key = key;
1841 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001842
Glenn Strauss36872db2022-01-22 05:06:31 -05001843 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001845 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001847 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001849 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 }
niisato8ee24222018-06-25 19:05:48 +09001851 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001852 }
1853
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001855}
1856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001858 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001860{
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001862}
1863
Gilles Peskine449bd832023-01-11 14:50:10 +01001864void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001865 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001867{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001868 conf->ca_chain = ca_chain;
1869 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001870
1871#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1872 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1873 * cannot be used together. */
1874 conf->f_ca_cb = NULL;
1875 conf->p_ca_cb = NULL;
1876#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001877}
Hanno Becker5adaad92019-03-27 16:54:37 +00001878
1879#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001880void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1881 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1882 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001883{
1884 conf->f_ca_cb = f_ca_cb;
1885 conf->p_ca_cb = p_ca_cb;
1886
1887 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1888 * cannot be used together. */
1889 conf->ca_chain = NULL;
1890 conf->ca_crl = NULL;
1891}
1892#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001893#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001894
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001895#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001896const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1897 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001898{
1899 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001901}
1902
Gilles Peskine449bd832023-01-11 14:50:10 +01001903int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1904 mbedtls_x509_crt *own_cert,
1905 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001906{
Gilles Peskine449bd832023-01-11 14:50:10 +01001907 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1908 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001909}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001910
Gilles Peskine449bd832023-01-11 14:50:10 +01001911void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1912 mbedtls_x509_crt *ca_chain,
1913 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001914{
1915 ssl->handshake->sni_ca_chain = ca_chain;
1916 ssl->handshake->sni_ca_crl = ca_crl;
1917}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001918
Glenn Strauss999ef702022-03-11 01:37:23 -05001919#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001920void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1921 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001922{
1923 ssl->handshake->dn_hints = crt;
1924}
1925#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1926
Gilles Peskine449bd832023-01-11 14:50:10 +01001927void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1928 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001929{
1930 ssl->handshake->sni_authmode = authmode;
1931}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001932#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1933
Hanno Becker8927c832019-04-03 12:52:50 +01001934#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001935void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1936 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1937 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001938{
1939 ssl->f_vrfy = f_vrfy;
1940 ssl->p_vrfy = p_vrfy;
1941}
1942#endif
1943
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001944#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001945
Valerio Setti016f6822022-12-09 14:17:50 +01001946#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001947static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1948static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1949
Valerio Setti016f6822022-12-09 14:17:50 +01001950static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 mbedtls_ssl_context *ssl,
1952 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001953{
1954 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001955 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001956 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001957 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001958 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001959 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1961 psa_pake_cs_set_primitive(&cipher_suite,
1962 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1963 PSA_ECC_FAMILY_SECP_R1,
1964 256));
1965 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1968 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001969 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001971
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001973 user = jpake_server_id;
1974 user_len = sizeof(jpake_server_id);
1975 peer = jpake_client_id;
1976 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001978 user = jpake_client_id;
1979 user_len = sizeof(jpake_client_id);
1980 peer = jpake_server_id;
1981 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001983
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001984 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1985 if (status != PSA_SUCCESS) {
1986 return status;
1987 }
1988
1989 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001991 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 }
Valerio Setti016f6822022-12-09 14:17:50 +01001993
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1995 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001996 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 }
Valerio Setti016f6822022-12-09 14:17:50 +01001998
1999 ssl->handshake->psa_pake_ctx_is_ok = 1;
2000
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002002}
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2005 const unsigned char *pw,
2006 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002007{
2008 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2009 psa_status_t status;
2010
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 if (ssl->handshake == NULL || ssl->conf == NULL) {
2012 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002013 }
2014
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 /* Empty password is not valid */
2016 if ((pw == NULL) || (pw_len == 0)) {
2017 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2018 }
2019
2020 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2021 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2022 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2023
2024 status = psa_import_key(&attributes, pw, pw_len,
2025 &ssl->handshake->psa_pake_password);
2026 if (status != PSA_SUCCESS) {
2027 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2028 }
2029
2030 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2031 ssl->handshake->psa_pake_password);
2032 if (status != PSA_SUCCESS) {
2033 psa_destroy_key(ssl->handshake->psa_pake_password);
2034 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2035 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2036 }
2037
2038 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002039}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2042 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002043{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002044 psa_status_t status;
2045
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 if (ssl->handshake == NULL || ssl->conf == NULL) {
2047 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002048 }
2049
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 if (mbedtls_svc_key_id_is_null(pwd)) {
2051 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2052 }
2053
2054 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2055 if (status != PSA_SUCCESS) {
2056 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2057 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2058 }
2059
2060 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002061}
2062#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002063int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2064 const unsigned char *pw,
2065 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002066{
2067 mbedtls_ecjpake_role role;
2068
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if (ssl->handshake == NULL || ssl->conf == NULL) {
2070 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2071 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002072
Valerio Settic689ed82022-12-07 14:40:38 +01002073 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 if ((pw == NULL) || (pw_len == 0)) {
2075 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2076 }
Valerio Settic689ed82022-12-07 14:40:38 +01002077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002079 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002083
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2085 role,
2086 MBEDTLS_MD_SHA256,
2087 MBEDTLS_ECP_DP_SECP256R1,
2088 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002089}
Valerio Setti02c25b52022-11-15 14:08:42 +01002090#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002091#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002092
Ronald Cron73fe8df2022-10-05 14:31:43 +02002093#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002094int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002095{
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 if (conf->psk_identity == NULL ||
2097 conf->psk_identity_len == 0) {
2098 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002099 }
2100
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002101#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2103 return 1;
2104 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002105#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002106
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (conf->psk != NULL && conf->psk_len != 0) {
2108 return 1;
2109 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002110
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002112}
2113
Gilles Peskine449bd832023-01-11 14:50:10 +01002114static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002115{
2116 /* Remove reference to existing PSK, if any. */
2117#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002119 /* The maintenance of the PSK key slot is the
2120 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002121 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002123#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002125 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002126 conf->psk = NULL;
2127 conf->psk_len = 0;
2128 }
2129
2130 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 if (conf->psk_identity != NULL) {
2132 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002133 conf->psk_identity = NULL;
2134 conf->psk_identity_len = 0;
2135 }
2136}
2137
Hanno Becker7390c712018-11-15 13:33:04 +00002138/* This function assumes that PSK identity in the SSL config is unset.
2139 * It checks that the provided identity is well-formed and attempts
2140 * to make a copy of it in the SSL config.
2141 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002142MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002143static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2144 unsigned char const *psk_identity,
2145 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002146{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002147 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002149 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 (psk_identity_len >> 16) != 0 ||
2151 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2152 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002153 }
2154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2156 if (conf->psk_identity == NULL) {
2157 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2158 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002159
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002160 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002162
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002164}
2165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2167 const unsigned char *psk, size_t psk_len,
2168 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002169{
Janos Follath865b3eb2019-12-16 11:46:15 +00002170 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002171
2172 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2174 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2175 }
Hanno Becker7390c712018-11-15 13:33:04 +00002176
2177 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 if (psk == NULL) {
2179 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2180 }
2181 if (psk_len == 0) {
2182 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2183 }
2184 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2185 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2186 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002187
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2189 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2190 }
Hanno Becker7390c712018-11-15 13:33:04 +00002191 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002193
2194 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2196 if (ret != 0) {
2197 ssl_conf_remove_psk(conf);
2198 }
Hanno Becker7390c712018-11-15 13:33:04 +00002199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002201}
2202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002204{
2205#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002207 /* The maintenance of the external PSK key slot is the
2208 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 if (ssl->handshake->psk_opaque_is_internal) {
2210 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002211 ssl->handshake->psk_opaque_is_internal = 0;
2212 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002213 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002214 }
Neil Armstronge952a302022-05-03 10:22:14 +02002215#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002217 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002219 ssl->handshake->psk_len = 0;
2220 }
Neil Armstronge952a302022-05-03 10:22:14 +02002221#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002222}
2223
Gilles Peskine449bd832023-01-11 14:50:10 +01002224int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2225 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002226{
Neil Armstrong501c9322022-05-03 09:35:09 +02002227#if defined(MBEDTLS_USE_PSA_CRYPTO)
2228 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002229 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002230 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002231 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002232#endif /* MBEDTLS_USE_PSA_CRYPTO */
2233
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 if (psk == NULL || ssl->handshake == NULL) {
2235 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2236 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002237
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
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 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002243
Neil Armstrong501c9322022-05-03 09:35:09 +02002244#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002245#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2247 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2248 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2249 } else {
2250 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2251 }
2252 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002253 }
2254#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002255
Jerry Yu568ec252022-07-22 21:27:34 +08002256#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2258 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2259 psa_set_key_usage_flags(&key_attributes,
2260 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002261 }
2262#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2263
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 psa_set_key_algorithm(&key_attributes, alg);
2265 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2268 if (status != PSA_SUCCESS) {
2269 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2270 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002271
2272 /* Allow calling psa_destroy_key() on psk remove */
2273 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002275#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2277 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2278 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002279
2280 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002282
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002284#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002285}
2286
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002287#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002288int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2289 mbedtls_svc_key_id_t psk,
2290 const unsigned char *psk_identity,
2291 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002292{
Janos Follath865b3eb2019-12-16 11:46:15 +00002293 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002294
2295 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2297 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2298 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002299
Hanno Becker7390c712018-11-15 13:33:04 +00002300 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 if (mbedtls_svc_key_id_is_null(psk)) {
2302 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2303 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002304 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002305
2306 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2308 psk_identity_len);
2309 if (ret != 0) {
2310 ssl_conf_remove_psk(conf);
2311 }
Hanno Becker7390c712018-11-15 13:33:04 +00002312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002314}
2315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2317 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002318{
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 if ((mbedtls_svc_key_id_is_null(psk)) ||
2320 (ssl->handshake == NULL)) {
2321 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2322 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002323
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002325 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002327}
2328#endif /* MBEDTLS_USE_PSA_CRYPTO */
2329
Jerry Yu8897c072022-08-12 13:56:53 +08002330#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002331void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2332 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2333 size_t),
2334 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002335{
2336 conf->f_psk = f_psk;
2337 conf->p_psk = p_psk;
2338}
Jerry Yu8897c072022-08-12 13:56:53 +08002339#endif /* MBEDTLS_SSL_SRV_C */
2340
Ronald Cron73fe8df2022-10-05 14:31:43 +02002341#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002342
2343#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002344static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002346{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002347#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 if (alg == PSA_ALG_CBC_NO_PADDING) {
2349 return MBEDTLS_SSL_MODE_CBC;
2350 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002351#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 if (PSA_ALG_IS_AEAD(alg)) {
2353 return MBEDTLS_SSL_MODE_AEAD;
2354 }
2355 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002356}
2357
2358#else /* MBEDTLS_USE_PSA_CRYPTO */
2359
2360static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002362{
2363#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 if (mode == MBEDTLS_MODE_CBC) {
2365 return MBEDTLS_SSL_MODE_CBC;
2366 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002367#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2368
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002369#if defined(MBEDTLS_GCM_C) || \
2370 defined(MBEDTLS_CCM_C) || \
2371 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002373 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 mode == MBEDTLS_MODE_CHACHAPOLY) {
2375 return MBEDTLS_SSL_MODE_AEAD;
2376 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002377#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002378
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002380}
Gilles Peskine301711e2022-04-26 16:57:05 +02002381#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002382
Gilles Peskinee108d982022-04-26 16:50:40 +02002383static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2384 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002386{
2387#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2389 base_mode == MBEDTLS_SSL_MODE_CBC) {
2390 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002391 }
2392#else
2393 (void) encrypt_then_mac;
2394#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002396}
2397
Neil Armstrongab555e02022-04-04 11:07:59 +02002398mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002400{
Gilles Peskinee108d982022-04-26 16:50:40 +02002401 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002402#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002404#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002406#endif
2407 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002408
Gilles Peskinee108d982022-04-26 16:50:40 +02002409 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002410#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002411 encrypt_then_mac = transform->encrypt_then_mac;
2412#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002414}
2415
Neil Armstrongab555e02022-04-04 11:07:59 +02002416mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002417#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002419#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002421{
Gilles Peskinee108d982022-04-26 16:50:40 +02002422 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2423
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002424#if defined(MBEDTLS_USE_PSA_CRYPTO)
2425 psa_status_t status;
2426 psa_algorithm_t alg;
2427 psa_key_type_t type;
2428 size_t size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 status = mbedtls_ssl_cipher_to_psa(suite->cipher, 0, &alg, &type, &size);
2430 if (status == PSA_SUCCESS) {
2431 base_mode = mbedtls_ssl_get_base_mode(alg);
2432 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002433#else
2434 const mbedtls_cipher_info_t *cipher =
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 mbedtls_cipher_info_from_type(suite->cipher);
2436 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002437 base_mode =
2438 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002440 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002441#endif /* MBEDTLS_USE_PSA_CRYPTO */
2442
Gilles Peskinee108d982022-04-26 16:50:40 +02002443#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2444 int encrypt_then_mac = 0;
2445#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002447}
2448
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002449#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002450
2451#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002452/* Serialization of TLS 1.3 sessions:
2453 *
2454 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002455 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002456 * uint64 ticket_received;
2457 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002458 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002459 * } ClientOnlyData;
2460 *
2461 * struct {
2462 * uint8 endpoint;
2463 * uint8 ciphersuite[2];
2464 * uint32 ticket_age_add;
2465 * uint8 ticket_flags;
2466 * opaque resumption_key<0..255>;
2467 * select ( endpoint ) {
2468 * case client: ClientOnlyData;
2469 * case server: uint64 start_time;
2470 * };
2471 * } serialized_session_tls13;
2472 *
2473 */
2474#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002475MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002476static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2477 unsigned char *buf,
2478 size_t buf_len,
2479 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002480{
2481 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002482#if defined(MBEDTLS_SSL_CLI_C) && \
2483 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 size_t hostname_len = (session->hostname == NULL) ?
2485 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002486#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002487 size_t needed = 1 /* endpoint */
2488 + 2 /* ciphersuite */
2489 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002490 + 1 /* ticket_flags */
2491 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002492 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002493
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2495 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2496 }
Jerry Yu34191072022-08-18 10:32:09 +08002497 needed += session->resumption_key_len; /* resumption_key */
2498
Jerry Yu438ddd82022-07-07 06:55:50 +00002499#if defined(MBEDTLS_HAVE_TIME)
2500 needed += 8; /* start_time or ticket_received */
2501#endif
2502
2503#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002505#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002506 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002508#endif
2509
Jerry Yu438ddd82022-07-07 06:55:50 +00002510 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002511 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002512
2513 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 if (session->ticket_len > SIZE_MAX - needed) {
2515 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2516 }
Jerry Yu34191072022-08-18 10:32:09 +08002517
Jerry Yue28d9742022-08-18 15:44:03 +08002518 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002519 }
2520#endif /* MBEDTLS_SSL_CLI_C */
2521
Jerry Yue36fdd62022-08-17 21:31:36 +08002522 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 if (needed > buf_len) {
2524 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2525 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002526
2527 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2529 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002530 p[7] = session->ticket_flags;
2531
2532 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002533 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002534 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002536 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002537
2538#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2540 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002541 p += 8;
2542 }
2543#endif /* MBEDTLS_HAVE_TIME */
2544
2545#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002547#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002549 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002551 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002553 p += hostname_len;
2554 }
2555#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2556
Jerry Yu438ddd82022-07-07 06:55:50 +00002557#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002559 p += 8;
2560#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002562 p += 4;
2563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002565 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 if (session->ticket != NULL && session->ticket_len > 0) {
2568 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002569 p += session->ticket_len;
2570 }
2571 }
2572#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002574}
2575
2576MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002577static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2578 const unsigned char *buf,
2579 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002580{
2581 const unsigned char *p = buf;
2582 const unsigned char *end = buf + len;
2583
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (end - p < 9) {
2585 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2586 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002587 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2589 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002590 session->ticket_flags = p[7];
2591
2592 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002593 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002594 p += 9;
2595
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 if (end - p < session->resumption_key_len) {
2597 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2598 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2601 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2602 }
2603 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002604 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002605
2606#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2608 if (end - p < 8) {
2609 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2610 }
2611 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002612 p += 8;
2613 }
2614#endif /* MBEDTLS_HAVE_TIME */
2615
2616#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002618#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002620 size_t hostname_len;
2621 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 if (end - p < 2) {
2623 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2624 }
2625 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002626 p += 2;
2627
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 if (end - p < (long int) hostname_len) {
2629 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2630 }
2631 if (hostname_len > 0) {
2632 session->hostname = mbedtls_calloc(1, hostname_len);
2633 if (session->hostname == NULL) {
2634 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2635 }
2636 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002637 p += hostname_len;
2638 }
2639#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2640 MBEDTLS_SSL_SESSION_TICKETS */
2641
Jerry Yu438ddd82022-07-07 06:55:50 +00002642#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 if (end - p < 8) {
2644 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2645 }
2646 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002647 p += 8;
2648#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 if (end - p < 4) {
2650 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2651 }
2652 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002653 p += 4;
2654
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 if (end - p < 2) {
2656 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2657 }
2658 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002659 p += 2;
2660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if (end - p < (long int) session->ticket_len) {
2662 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2663 }
2664 if (session->ticket_len > 0) {
2665 session->ticket = mbedtls_calloc(1, session->ticket_len);
2666 if (session->ticket == NULL) {
2667 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2668 }
2669 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002670 p += session->ticket_len;
2671 }
2672 }
2673#endif /* MBEDTLS_SSL_CLI_C */
2674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002676
2677}
2678#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002679MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002680static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2681 unsigned char *buf,
2682 size_t buf_len,
2683 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002684{
2685 ((void) session);
2686 ((void) buf);
2687 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002688 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002690}
Jerry Yu438ddd82022-07-07 06:55:50 +00002691
Gilles Peskine449bd832023-01-11 14:50:10 +01002692static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2693 unsigned char *buf,
2694 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002695{
2696 ((void) session);
2697 ((void) buf);
2698 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002700}
2701#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002702#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2703
Gilles Peskine449bd832023-01-11 14:50:10 +01002704psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2705 size_t taglen,
2706 psa_algorithm_t *alg,
2707 psa_key_type_t *key_type,
2708 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002709{
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002711 case MBEDTLS_CIPHER_AES_128_CBC:
2712 *alg = PSA_ALG_CBC_NO_PADDING;
2713 *key_type = PSA_KEY_TYPE_AES;
2714 *key_size = 128;
2715 break;
2716 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002718 *key_type = PSA_KEY_TYPE_AES;
2719 *key_size = 128;
2720 break;
2721 case MBEDTLS_CIPHER_AES_128_GCM:
2722 *alg = PSA_ALG_GCM;
2723 *key_type = PSA_KEY_TYPE_AES;
2724 *key_size = 128;
2725 break;
2726 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002728 *key_type = PSA_KEY_TYPE_AES;
2729 *key_size = 192;
2730 break;
2731 case MBEDTLS_CIPHER_AES_192_GCM:
2732 *alg = PSA_ALG_GCM;
2733 *key_type = PSA_KEY_TYPE_AES;
2734 *key_size = 192;
2735 break;
2736 case MBEDTLS_CIPHER_AES_256_CBC:
2737 *alg = PSA_ALG_CBC_NO_PADDING;
2738 *key_type = PSA_KEY_TYPE_AES;
2739 *key_size = 256;
2740 break;
2741 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002743 *key_type = PSA_KEY_TYPE_AES;
2744 *key_size = 256;
2745 break;
2746 case MBEDTLS_CIPHER_AES_256_GCM:
2747 *alg = PSA_ALG_GCM;
2748 *key_type = PSA_KEY_TYPE_AES;
2749 *key_size = 256;
2750 break;
2751 case MBEDTLS_CIPHER_ARIA_128_CBC:
2752 *alg = PSA_ALG_CBC_NO_PADDING;
2753 *key_type = PSA_KEY_TYPE_ARIA;
2754 *key_size = 128;
2755 break;
2756 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002758 *key_type = PSA_KEY_TYPE_ARIA;
2759 *key_size = 128;
2760 break;
2761 case MBEDTLS_CIPHER_ARIA_128_GCM:
2762 *alg = PSA_ALG_GCM;
2763 *key_type = PSA_KEY_TYPE_ARIA;
2764 *key_size = 128;
2765 break;
2766 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002768 *key_type = PSA_KEY_TYPE_ARIA;
2769 *key_size = 192;
2770 break;
2771 case MBEDTLS_CIPHER_ARIA_192_GCM:
2772 *alg = PSA_ALG_GCM;
2773 *key_type = PSA_KEY_TYPE_ARIA;
2774 *key_size = 192;
2775 break;
2776 case MBEDTLS_CIPHER_ARIA_256_CBC:
2777 *alg = PSA_ALG_CBC_NO_PADDING;
2778 *key_type = PSA_KEY_TYPE_ARIA;
2779 *key_size = 256;
2780 break;
2781 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002783 *key_type = PSA_KEY_TYPE_ARIA;
2784 *key_size = 256;
2785 break;
2786 case MBEDTLS_CIPHER_ARIA_256_GCM:
2787 *alg = PSA_ALG_GCM;
2788 *key_type = PSA_KEY_TYPE_ARIA;
2789 *key_size = 256;
2790 break;
2791 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2792 *alg = PSA_ALG_CBC_NO_PADDING;
2793 *key_type = PSA_KEY_TYPE_CAMELLIA;
2794 *key_size = 128;
2795 break;
2796 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002798 *key_type = PSA_KEY_TYPE_CAMELLIA;
2799 *key_size = 128;
2800 break;
2801 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2802 *alg = PSA_ALG_GCM;
2803 *key_type = PSA_KEY_TYPE_CAMELLIA;
2804 *key_size = 128;
2805 break;
2806 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002808 *key_type = PSA_KEY_TYPE_CAMELLIA;
2809 *key_size = 192;
2810 break;
2811 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2812 *alg = PSA_ALG_GCM;
2813 *key_type = PSA_KEY_TYPE_CAMELLIA;
2814 *key_size = 192;
2815 break;
2816 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2817 *alg = PSA_ALG_CBC_NO_PADDING;
2818 *key_type = PSA_KEY_TYPE_CAMELLIA;
2819 *key_size = 256;
2820 break;
2821 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002823 *key_type = PSA_KEY_TYPE_CAMELLIA;
2824 *key_size = 256;
2825 break;
2826 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2827 *alg = PSA_ALG_GCM;
2828 *key_type = PSA_KEY_TYPE_CAMELLIA;
2829 *key_size = 256;
2830 break;
2831 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2832 *alg = PSA_ALG_CHACHA20_POLY1305;
2833 *key_type = PSA_KEY_TYPE_CHACHA20;
2834 *key_size = 256;
2835 break;
2836 case MBEDTLS_CIPHER_NULL:
2837 *alg = MBEDTLS_SSL_NULL_CIPHER;
2838 *key_type = 0;
2839 *key_size = 0;
2840 break;
2841 default:
2842 return PSA_ERROR_NOT_SUPPORTED;
2843 }
2844
2845 return PSA_SUCCESS;
2846}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002847#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002848
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002849#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002850int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2851 const unsigned char *dhm_P, size_t P_len,
2852 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002853{
Janos Follath865b3eb2019-12-16 11:46:15 +00002854 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 mbedtls_mpi_free(&conf->dhm_P);
2857 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002858
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2860 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2861 mbedtls_mpi_free(&conf->dhm_P);
2862 mbedtls_mpi_free(&conf->dhm_G);
2863 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002864 }
2865
Gilles Peskine449bd832023-01-11 14:50:10 +01002866 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002867}
Paul Bakker5121ce52009-01-03 21:22:43 +00002868
Gilles Peskine449bd832023-01-11 14:50:10 +01002869int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002870{
Janos Follath865b3eb2019-12-16 11:46:15 +00002871 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002872
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 mbedtls_mpi_free(&conf->dhm_P);
2874 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2877 &conf->dhm_P)) != 0 ||
2878 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2879 &conf->dhm_G)) != 0) {
2880 mbedtls_mpi_free(&conf->dhm_P);
2881 mbedtls_mpi_free(&conf->dhm_G);
2882 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002883 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002884
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002886}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002887#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002888
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002889#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2890/*
2891 * Set the minimum length for Diffie-Hellman parameters
2892 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002893void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2894 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002895{
2896 conf->dhm_min_bitlen = bitlen;
2897}
2898#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2899
Ronald Crone68ab4f2022-10-05 12:46:29 +02002900#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002901#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002902/*
2903 * Set allowed/preferred hashes for handshake signatures
2904 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002905void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2906 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002907{
2908 conf->sig_hashes = hashes;
2909}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002910#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002911
Jerry Yuf017ee42022-01-12 15:49:48 +08002912/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002913void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2914 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002915{
Jerry Yuf017ee42022-01-12 15:49:48 +08002916#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2917 conf->sig_hashes = NULL;
2918#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2919 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002920}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002921#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002922
Valerio Setti6c496a12023-04-07 15:53:51 +02002923#if defined(MBEDTLS_ECP_LIGHT)
Brett Warrene0edc842021-08-17 09:53:13 +01002924#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002925/*
2926 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002927 *
2928 * mbedtls_ssl_setup() takes the provided list
2929 * and translates it to a list of IANA TLS group identifiers,
2930 * stored in ssl->handshake->group_list.
2931 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002932 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002933void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2934 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002935{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002936 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002937 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002938}
Brett Warrene0edc842021-08-17 09:53:13 +01002939#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6c496a12023-04-07 15:53:51 +02002940#endif /* MBEDTLS_ECP_LIGHT */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002941
Brett Warrene0edc842021-08-17 09:53:13 +01002942/*
2943 * Set the allowed groups
2944 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002945void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2946 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002947{
2948#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2949 conf->curve_list = NULL;
2950#endif
2951 conf->group_list = group_list;
2952}
2953
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002954#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002955int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002956{
Hanno Becker947194e2017-04-07 13:25:49 +01002957 /* Initialize to suppress unnecessary compiler warning */
2958 size_t hostname_len = 0;
2959
2960 /* Check if new hostname is valid before
2961 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 if (hostname != NULL) {
2963 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002964
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2966 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2967 }
Hanno Becker947194e2017-04-07 13:25:49 +01002968 }
2969
2970 /* Now it's clear that we will overwrite the old hostname,
2971 * so we can free it safely */
2972
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002974 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002975 }
2976
2977 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002978
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002980 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 } else {
2982 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2983 if (ssl->hostname == NULL) {
2984 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2985 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002986
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002988
Hanno Becker947194e2017-04-07 13:25:49 +01002989 ssl->hostname[hostname_len] = '\0';
2990 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002993}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002994#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002995
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002996#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002997void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2998 int (*f_sni)(void *, mbedtls_ssl_context *,
2999 const unsigned char *, size_t),
3000 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003001{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003002 conf->f_sni = f_sni;
3003 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003004}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003008int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003009{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003010 size_t cur_len, tot_len;
3011 const char **p;
3012
3013 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003014 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3015 * MUST NOT be truncated."
3016 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003017 */
3018 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 for (p = protos; *p != NULL; p++) {
3020 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003021 tot_len += cur_len;
3022
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 if ((cur_len == 0) ||
3024 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3025 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3026 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3027 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003028 }
3029
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003030 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003033}
3034
Gilles Peskine449bd832023-01-11 14:50:10 +01003035const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003036{
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003038}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003040
Johan Pascalb62bb512015-12-03 21:56:45 +01003041#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003042void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3043 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003044{
3045 conf->dtls_srtp_mki_support = support_mki_value;
3046}
3047
Gilles Peskine449bd832023-01-11 14:50:10 +01003048int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3049 unsigned char *mki_value,
3050 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003051{
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3053 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003054 }
Ron Eldor591f1622018-01-22 12:30:04 +02003055
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3057 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003058 }
Ron Eldor591f1622018-01-22 12:30:04 +02003059
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003061 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003063}
3064
Gilles Peskine449bd832023-01-11 14:50:10 +01003065int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3066 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003067{
Johan Pascal253d0262020-09-22 13:04:45 +02003068 const mbedtls_ssl_srtp_profile *p;
3069 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003070
Johan Pascal253d0262020-09-22 13:04:45 +02003071 /* check the profiles list: all entry must be valid,
3072 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3074 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3075 p++) {
3076 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003077 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003079 /* unsupported value, stop parsing and set the size to an error value */
3080 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003081 }
3082 }
3083
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3085 conf->dtls_srtp_profile_list = NULL;
3086 conf->dtls_srtp_profile_list_len = 0;
3087 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003088 }
3089
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003090 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003091 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003092
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003094}
3095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3097 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003098{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003099 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3100 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003102 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003104 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3106 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003107 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003108}
Johan Pascalb62bb512015-12-03 21:56:45 +01003109#endif /* MBEDTLS_SSL_DTLS_SRTP */
3110
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303111#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003112void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003113{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003114 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00003115}
3116
Gilles Peskine449bd832023-01-11 14:50:10 +01003117void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003118{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003119 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00003120}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303121#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003122
Janos Follath088ce432017-04-10 12:42:31 +01003123#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003124void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3125 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003126{
3127 conf->cert_req_ca_list = cert_req_ca_list;
3128}
3129#endif
3130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003131#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003132void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003133{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003134 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003135}
3136#endif
3137
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003138#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003139void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003140{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003141 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003142}
3143#endif
3144
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003145#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003146int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003147{
Gilles Peskine449bd832023-01-11 14:50:10 +01003148 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3149 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3150 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003151 }
3152
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003153 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003154
Gilles Peskine449bd832023-01-11 14:50:10 +01003155 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003156}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003157#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003160{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003161 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003162}
3163
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003165void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003166{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003167 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003168}
3169
Gilles Peskine449bd832023-01-11 14:50:10 +01003170void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003171{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003172 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003173}
3174
Gilles Peskine449bd832023-01-11 14:50:10 +01003175void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3176 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003177{
Gilles Peskine449bd832023-01-11 14:50:10 +01003178 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003179}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003180#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003181
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003182#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003183#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003184void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003185{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003186 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003187}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003188#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003189
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003190#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003191
Jerry Yud0766ec2022-09-22 10:46:57 +08003192#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003193void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3194 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003195{
Jerry Yud0766ec2022-09-22 10:46:57 +08003196 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003197}
3198#endif
3199
Gilles Peskine449bd832023-01-11 14:50:10 +01003200void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3201 mbedtls_ssl_ticket_write_t *f_ticket_write,
3202 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3203 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003204{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003205 conf->f_ticket_write = f_ticket_write;
3206 conf->f_ticket_parse = f_ticket_parse;
3207 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003208}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003209#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003210#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003211
Gilles Peskine449bd832023-01-11 14:50:10 +01003212void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3213 mbedtls_ssl_export_keys_t *f_export_keys,
3214 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003215{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003216 ssl->f_export_keys = f_export_keys;
3217 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003218}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003219
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003220#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003221void mbedtls_ssl_conf_async_private_cb(
3222 mbedtls_ssl_config *conf,
3223 mbedtls_ssl_async_sign_t *f_async_sign,
3224 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3225 mbedtls_ssl_async_resume_t *f_async_resume,
3226 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003227 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003228{
3229 conf->f_async_sign_start = f_async_sign;
3230 conf->f_async_decrypt_start = f_async_decrypt;
3231 conf->f_async_resume = f_async_resume;
3232 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003233 conf->p_async_config_data = async_config_data;
3234}
3235
Gilles Peskine449bd832023-01-11 14:50:10 +01003236void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003237{
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003239}
3240
Gilles Peskine449bd832023-01-11 14:50:10 +01003241void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003242{
Gilles Peskine449bd832023-01-11 14:50:10 +01003243 if (ssl->handshake == NULL) {
3244 return NULL;
3245 } else {
3246 return ssl->handshake->user_async_ctx;
3247 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003248}
3249
Gilles Peskine449bd832023-01-11 14:50:10 +01003250void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3251 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003252{
Gilles Peskine449bd832023-01-11 14:50:10 +01003253 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003254 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003255 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003256}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003257#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003258
Paul Bakker5121ce52009-01-03 21:22:43 +00003259/*
3260 * SSL get accessors
3261 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003262uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003263{
Gilles Peskine449bd832023-01-11 14:50:10 +01003264 if (ssl->session != NULL) {
3265 return ssl->session->verify_result;
3266 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003267
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 if (ssl->session_negotiate != NULL) {
3269 return ssl->session_negotiate->verify_result;
3270 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003271
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003273}
3274
Gilles Peskine449bd832023-01-11 14:50:10 +01003275int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003276{
Gilles Peskine449bd832023-01-11 14:50:10 +01003277 if (ssl == NULL || ssl->session == NULL) {
3278 return 0;
3279 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003280
Gilles Peskine449bd832023-01-11 14:50:10 +01003281 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003282}
3283
Gilles Peskine449bd832023-01-11 14:50:10 +01003284const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003285{
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 if (ssl == NULL || ssl->session == NULL) {
3287 return NULL;
3288 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003289
Gilles Peskine449bd832023-01-11 14:50:10 +01003290 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003291}
3292
Gilles Peskine449bd832023-01-11 14:50:10 +01003293const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003294{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003295#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3297 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003298 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003300 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003302 }
3303 }
3304#endif
3305
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003307 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003309 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003311 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003313 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003314}
3315
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003316#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003317size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003318{
David Horstmann95d516f2021-05-04 18:36:56 +01003319 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003320 size_t read_mfl;
3321
Jerry Yuddda0502022-12-01 19:43:12 +08003322#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003323 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003324 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3325 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3326 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003327 }
Jerry Yuddda0502022-12-01 19:43:12 +08003328#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003329
3330 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003331 if (ssl->session_out != NULL) {
3332 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3333 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003334 max_len = read_mfl;
3335 }
3336 }
3337
Jerry Yuddda0502022-12-01 19:43:12 +08003338 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 if (ssl->session_negotiate != NULL) {
3340 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3341 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003342 max_len = read_mfl;
3343 }
3344 }
3345
Gilles Peskine449bd832023-01-11 14:50:10 +01003346 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003347}
3348
Gilles Peskine449bd832023-01-11 14:50:10 +01003349size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003350{
3351 size_t max_len;
3352
3353 /*
3354 * Assume mfl_code is correct since it was checked when set
3355 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003356 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003357
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003358 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 if (ssl->session_out != NULL &&
3360 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3361 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003362 }
3363
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003364 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 if (ssl->session_negotiate != NULL &&
3366 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3367 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003368 }
3369
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003371}
3372#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3373
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003374#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003375size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003376{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003377 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3379 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3380 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3381 return 0;
3382 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003383
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3385 return ssl->mtu;
3386 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003387
Gilles Peskine449bd832023-01-11 14:50:10 +01003388 if (ssl->mtu == 0) {
3389 return ssl->handshake->mtu;
3390 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003391
Gilles Peskine449bd832023-01-11 14:50:10 +01003392 return ssl->mtu < ssl->handshake->mtu ?
3393 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003394}
3395#endif /* MBEDTLS_SSL_PROTO_DTLS */
3396
Gilles Peskine449bd832023-01-11 14:50:10 +01003397int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003398{
3399 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3400
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003401#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3402 !defined(MBEDTLS_SSL_PROTO_DTLS)
3403 (void) ssl;
3404#endif
3405
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003406#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003407 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003408
Gilles Peskine449bd832023-01-11 14:50:10 +01003409 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003410 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003411 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003412#endif
3413
3414#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003415 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3416 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3417 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003418 const size_t overhead = (size_t) ret;
3419
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 if (ret < 0) {
3421 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003422 }
3423
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 if (mtu <= overhead) {
3425 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3426 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3427 }
3428
3429 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003430 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003432 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003433#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003434
Hanno Becker0defedb2018-08-10 12:35:02 +01003435#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3436 !defined(MBEDTLS_SSL_PROTO_DTLS)
3437 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003438#endif
3439
Gilles Peskine449bd832023-01-11 14:50:10 +01003440 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003441}
3442
Gilles Peskine449bd832023-01-11 14:50:10 +01003443int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003444{
3445 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3446
3447#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3448 (void) ssl;
3449#endif
3450
3451#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003452 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003453
Gilles Peskine449bd832023-01-11 14:50:10 +01003454 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003455 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003456 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003457#endif
3458
Gilles Peskine449bd832023-01-11 14:50:10 +01003459 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003460}
3461
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003463const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003464{
Gilles Peskine449bd832023-01-11 14:50:10 +01003465 if (ssl == NULL || ssl->session == NULL) {
3466 return NULL;
3467 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003468
Hanno Beckere6824572019-02-07 13:18:46 +00003469#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003470 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003471#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003472 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003473#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003474}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003475#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003476
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003477#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003478int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3479 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003480{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003481 int ret;
3482
Gilles Peskine449bd832023-01-11 14:50:10 +01003483 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003484 dst == NULL ||
3485 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003486 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3487 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003488 }
3489
Hanno Beckere810bbc2021-05-14 16:01:05 +01003490 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3491 * idempotent: Each session can only be exported once.
3492 *
3493 * (This is in preparation for TLS 1.3 support where we will
3494 * need the ability to export multiple sessions (aka tickets),
3495 * which will be achieved by calling mbedtls_ssl_get_session()
3496 * multiple times until it fails.)
3497 *
3498 * Check whether we have already exported the current session,
3499 * and fail if so.
3500 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003501 if (ssl->session->exported == 1) {
3502 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3503 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003504
Gilles Peskine449bd832023-01-11 14:50:10 +01003505 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3506 if (ret != 0) {
3507 return ret;
3508 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003509
3510 /* Remember that we've exported the session. */
3511 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003512 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003513}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003514#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003515
Paul Bakker5121ce52009-01-03 21:22:43 +00003516/*
Hanno Beckera835da52019-05-16 12:39:07 +01003517 * Define ticket header determining Mbed TLS version
3518 * and structure of the ticket.
3519 */
3520
Hanno Becker94ef3b32019-05-16 12:50:45 +01003521/*
Hanno Becker50b59662019-05-28 14:30:45 +01003522 * Define bitflag determining compile-time settings influencing
3523 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003524 */
3525
Hanno Becker50b59662019-05-28 14:30:45 +01003526#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003527#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003528#else
Hanno Becker3e088662019-05-29 11:10:18 +01003529#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003530#endif /* MBEDTLS_HAVE_TIME */
3531
3532#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003533#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003534#else
Hanno Becker3e088662019-05-29 11:10:18 +01003535#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003536#endif /* MBEDTLS_X509_CRT_PARSE_C */
3537
3538#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003539#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003540#else
Hanno Becker3e088662019-05-29 11:10:18 +01003541#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003542#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3543
3544#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003545#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003546#else
Hanno Becker3e088662019-05-29 11:10:18 +01003547#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003548#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3549
Hanno Becker94ef3b32019-05-16 12:50:45 +01003550#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003551#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003552#else
Hanno Becker3e088662019-05-29 11:10:18 +01003553#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003554#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3555
Hanno Becker94ef3b32019-05-16 12:50:45 +01003556#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3557#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3558#else
3559#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3560#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3561
Hanno Becker3e088662019-05-29 11:10:18 +01003562#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3563#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3564#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3565#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003566#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3567#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003568
Hanno Becker50b59662019-05-28 14:30:45 +01003569#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003570 ((uint16_t) ( \
3571 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3572 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3573 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3574 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3575 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3576 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3577 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003578
Hanno Beckerf8787072019-05-16 12:41:07 +01003579static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003580 MBEDTLS_VERSION_MAJOR,
3581 MBEDTLS_VERSION_MINOR,
3582 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003583 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3584 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003585};
Hanno Beckera835da52019-05-16 12:39:07 +01003586
3587/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003588 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003589 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003590 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003591 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003592 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003593 * opaque mbedtls_version[3]; // library version: major, minor, patch
3594 * opaque session_format[2]; // library-version specific 16-bit field
3595 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003596 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003597 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003598 * Note: When updating the format, remember to keep
3599 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003600 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003601 * // In this version, `session_format` determines
3602 * // the setting of those compile-time
3603 * // configuration options which influence
3604 * // the structure of mbedtls_ssl_session.
3605 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003606 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003607 * // - TLS 1.2 (0x0303)
3608 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003609 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003610 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003611 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003612 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003613 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003614 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003615 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003616 *
3617 * };
3618 *
3619 * } serialized_session;
3620 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003621 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003622
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003623MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003624static int ssl_session_save(const mbedtls_ssl_session *session,
3625 unsigned char omit_header,
3626 unsigned char *buf,
3627 size_t buf_len,
3628 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003629{
3630 unsigned char *p = buf;
3631 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003632 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003633#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3634 size_t out_len;
3635 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3636#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003637 if (session == NULL) {
3638 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3639 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003640
Gilles Peskine449bd832023-01-11 14:50:10 +01003641 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003642 /*
3643 * Add Mbed TLS version identifier
3644 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003645 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003646
Gilles Peskine449bd832023-01-11 14:50:10 +01003647 if (used <= buf_len) {
3648 memcpy(p, ssl_serialized_session_header,
3649 sizeof(ssl_serialized_session_header));
3650 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003651 }
3652 }
3653
3654 /*
3655 * TLS version identifier
3656 */
3657 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003658 if (used <= buf_len) {
3659 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003660 }
3661
3662 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003663 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003664 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003665#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003666 case MBEDTLS_SSL_VERSION_TLS1_2:
3667 used += ssl_tls12_session_save(session, p, remaining_len);
3668 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003669#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3670
Jerry Yu251a12e2022-07-13 15:15:48 +08003671#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003672 case MBEDTLS_SSL_VERSION_TLS1_3:
3673 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3674 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3675 return ret;
3676 }
3677 used += out_len;
3678 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003679#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3680
Gilles Peskine449bd832023-01-11 14:50:10 +01003681 default:
3682 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003683 }
3684
3685 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003686 if (used > buf_len) {
3687 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3688 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003689
Gilles Peskine449bd832023-01-11 14:50:10 +01003690 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003691}
3692
3693/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003694 * Public wrapper for ssl_session_save()
3695 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003696int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3697 unsigned char *buf,
3698 size_t buf_len,
3699 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003700{
Gilles Peskine449bd832023-01-11 14:50:10 +01003701 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003702}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003703
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003704/*
3705 * Deserialize session, see mbedtls_ssl_session_save() for format.
3706 *
3707 * This internal version is wrapped by a public function that cleans up in
3708 * case of error, and has an extra option omit_header.
3709 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003710MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003711static int ssl_session_load(mbedtls_ssl_session *session,
3712 unsigned char omit_header,
3713 const unsigned char *buf,
3714 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003715{
3716 const unsigned char *p = buf;
3717 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003718 size_t remaining_len;
3719
3720
Gilles Peskine449bd832023-01-11 14:50:10 +01003721 if (session == NULL) {
3722 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3723 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003724
Gilles Peskine449bd832023-01-11 14:50:10 +01003725 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003726 /*
3727 * Check Mbed TLS version identifier
3728 */
3729
Gilles Peskine449bd832023-01-11 14:50:10 +01003730 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003732 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003733
3734 if (memcmp(p, ssl_serialized_session_header,
3735 sizeof(ssl_serialized_session_header)) != 0) {
3736 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3737 }
3738 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003739 }
3740
3741 /*
3742 * TLS version identifier
3743 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003744 if (1 > (size_t) (end - p)) {
3745 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3746 }
Glenn Straussda7851c2022-03-14 13:29:48 -04003747 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003748
3749 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003750 remaining_len = (end - p);
3751 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003752#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003753 case MBEDTLS_SSL_VERSION_TLS1_2:
3754 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003755#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3756
Jerry Yu438ddd82022-07-07 06:55:50 +00003757#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003758 case MBEDTLS_SSL_VERSION_TLS1_3:
3759 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003760#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3761
Gilles Peskine449bd832023-01-11 14:50:10 +01003762 default:
3763 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003764 }
3765}
3766
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003767/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003768 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003769 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003770int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3771 const unsigned char *buf,
3772 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003773{
Gilles Peskine449bd832023-01-11 14:50:10 +01003774 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003775
Gilles Peskine449bd832023-01-11 14:50:10 +01003776 if (ret != 0) {
3777 mbedtls_ssl_session_free(session);
3778 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003779
Gilles Peskine449bd832023-01-11 14:50:10 +01003780 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003781}
3782
3783/*
Paul Bakker1961b702013-01-25 14:49:24 +01003784 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003785 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003786MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003787static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003788{
3789 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3790
Ronald Cron66dbf912022-02-02 15:33:46 +01003791 /*
3792 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003793 * that were written into the output buffer by the previous handshake step,
3794 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003795 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3796 * We proceed to the next handshake step only when all data from the
3797 * previous one have been sent to the peer, thus we make sure that this is
3798 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3799 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3800 * we have to wait before to go ahead.
3801 * In the case of TLS 1.3, handshake step handlers do not send data to the
3802 * peer. Data are only sent here and through
3803 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003804 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003805 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003806 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3807 return ret;
3808 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003809
3810#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003811 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3812 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3813 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3814 return ret;
3815 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003816 }
3817#endif /* MBEDTLS_SSL_PROTO_DTLS */
3818
Gilles Peskine449bd832023-01-11 14:50:10 +01003819 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003820}
3821
Gilles Peskine449bd832023-01-11 14:50:10 +01003822int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003823{
Hanno Becker41934dd2021-08-07 19:13:43 +01003824 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003825
Gilles Peskine449bd832023-01-11 14:50:10 +01003826 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003827 ssl->conf == NULL ||
3828 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003829 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3830 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003831 }
3832
Gilles Peskine449bd832023-01-11 14:50:10 +01003833 ret = ssl_prepare_handshake_step(ssl);
3834 if (ret != 0) {
3835 return ret;
3836 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003837
Gilles Peskine449bd832023-01-11 14:50:10 +01003838 ret = mbedtls_ssl_handle_pending_alert(ssl);
3839 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003840 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003841 }
Jerry Yue7047812021-09-13 19:26:39 +08003842
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003843 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3844 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3845 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3846
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003847#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003848 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3849 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
3850 mbedtls_ssl_states_str(ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003851
Gilles Peskine449bd832023-01-11 14:50:10 +01003852 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003853 case MBEDTLS_SSL_HELLO_REQUEST:
3854 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003855 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003856 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003857
Ronald Cron9f0fba32022-02-10 16:45:15 +01003858 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003859 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003860 break;
3861
3862 default:
3863#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003864 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3865 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3866 } else {
3867 ret = mbedtls_ssl_handshake_client_step(ssl);
3868 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003869#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003870 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003871#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003872 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003873#endif
3874 }
Jerry Yub9930e72021-08-06 17:11:51 +08003875 }
Ronald Cron6291b232023-03-08 15:51:25 +01003876#endif /* MBEDTLS_SSL_CLI_C */
3877
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003878#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003879 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003880#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3881 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003882 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003883 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003884 ret = mbedtls_ssl_handshake_server_step(ssl);
3885 }
Ronald Cron6291b232023-03-08 15:51:25 +01003886#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3887 ret = mbedtls_ssl_handshake_server_step(ssl);
3888#else
3889 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003890#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003891 }
3892#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003893
Gilles Peskine449bd832023-01-11 14:50:10 +01003894 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003895 /* handshake_step return error. And it is same
3896 * with alert_reason.
3897 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003898 if (ssl->send_alert) {
3899 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003900 goto cleanup;
3901 }
3902 }
3903
3904cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003905 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003906}
3907
3908/*
3909 * Perform the SSL handshake
3910 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003911int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003912{
3913 int ret = 0;
3914
Hanno Beckera817ea42020-10-20 15:20:23 +01003915 /* Sanity checks */
3916
Gilles Peskine449bd832023-01-11 14:50:10 +01003917 if (ssl == NULL || ssl->conf == NULL) {
3918 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3919 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003920
Hanno Beckera817ea42020-10-20 15:20:23 +01003921#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003922 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3923 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3924 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3925 "mbedtls_ssl_set_timer_cb() for DTLS"));
3926 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003927 }
3928#endif /* MBEDTLS_SSL_PROTO_DTLS */
3929
Gilles Peskine449bd832023-01-11 14:50:10 +01003930 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003931
Hanno Beckera817ea42020-10-20 15:20:23 +01003932 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003933 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3934 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003935
Gilles Peskine449bd832023-01-11 14:50:10 +01003936 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003937 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 }
Paul Bakker1961b702013-01-25 14:49:24 +01003939 }
3940
Gilles Peskine449bd832023-01-11 14:50:10 +01003941 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003942
Gilles Peskine449bd832023-01-11 14:50:10 +01003943 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003944}
3945
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003946#if defined(MBEDTLS_SSL_RENEGOTIATION)
3947#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003948/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003949 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003950 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003951MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003952static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003953{
Janos Follath865b3eb2019-12-16 11:46:15 +00003954 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003955
Gilles Peskine449bd832023-01-11 14:50:10 +01003956 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003957
3958 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003959 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3960 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003961
Gilles Peskine449bd832023-01-11 14:50:10 +01003962 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3963 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3964 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003965 }
3966
Gilles Peskine449bd832023-01-11 14:50:10 +01003967 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003968
Gilles Peskine449bd832023-01-11 14:50:10 +01003969 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003970}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003971#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003972
3973/*
3974 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003975 * - any side: calling mbedtls_ssl_renegotiate(),
3976 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3977 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003978 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003979 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003980 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003981 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003982int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003983{
Janos Follath865b3eb2019-12-16 11:46:15 +00003984 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003985
Gilles Peskine449bd832023-01-11 14:50:10 +01003986 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00003987
Gilles Peskine449bd832023-01-11 14:50:10 +01003988 if ((ret = ssl_handshake_init(ssl)) != 0) {
3989 return ret;
3990 }
Paul Bakker48916f92012-09-16 19:57:18 +00003991
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003992 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3993 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003994#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003995 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3996 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
3997 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003998 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003999 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004000 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004001 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004002 }
4003#endif
4004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004005 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4006 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004007
Gilles Peskine449bd832023-01-11 14:50:10 +01004008 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4009 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4010 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004011 }
4012
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004014
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004016}
4017
4018/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004019 * Renegotiate current connection on client,
4020 * or request renegotiation on server
4021 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004022int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004023{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004024 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004025
Gilles Peskine449bd832023-01-11 14:50:10 +01004026 if (ssl == NULL || ssl->conf == NULL) {
4027 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4028 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004029
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004030#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004031 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4033 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4034 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4035 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004036
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004037 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004038
4039 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004040 if (ssl->out_left != 0) {
4041 return mbedtls_ssl_flush_output(ssl);
4042 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004043
Gilles Peskine449bd832023-01-11 14:50:10 +01004044 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004045 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004046#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004047
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004048#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004049 /*
4050 * On client, either start the renegotiation process or,
4051 * if already in progress, continue the handshake
4052 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4054 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4055 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004056 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004057
4058 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4059 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4060 return ret;
4061 }
4062 } else {
4063 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4064 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4065 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004066 }
4067 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004068#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004069
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004071}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004072#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004073
Gilles Peskine449bd832023-01-11 14:50:10 +01004074void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004075{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004076 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4077
Gilles Peskine449bd832023-01-11 14:50:10 +01004078 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004079 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004080 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004081
Valerio Setti6c496a12023-04-07 15:53:51 +02004082#if defined(MBEDTLS_ECP_LIGHT)
Brett Warrene0edc842021-08-17 09:53:13 +01004083#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 if (ssl->handshake->group_list_heap_allocated) {
4085 mbedtls_free((void *) handshake->group_list);
4086 }
Brett Warrene0edc842021-08-17 09:53:13 +01004087 handshake->group_list = NULL;
4088#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6c496a12023-04-07 15:53:51 +02004089#endif /* MBEDTLS_ECP_LIGHT */
Brett Warrene0edc842021-08-17 09:53:13 +01004090
Ronald Crone68ab4f2022-10-05 12:46:29 +02004091#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004092#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004093 if (ssl->handshake->sig_algs_heap_allocated) {
4094 mbedtls_free((void *) handshake->sig_algs);
4095 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004096 handshake->sig_algs = NULL;
4097#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004098#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 if (ssl->handshake->certificate_request_context) {
4100 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004101 }
4102#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004103#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004104
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004105#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4107 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004108 handshake->async_in_progress = 0;
4109 }
4110#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4111
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004112#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004113#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004115#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004116 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004117#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004118#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004119#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004120#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004121 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004122#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004123 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004124#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004125#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004126
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004127#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004129#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02004130#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004131 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004132#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004133
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004134#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004135#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004137 /*
4138 * Opaque keys are not stored in the handshake's data and it's the user
4139 * responsibility to destroy them. Clear ones, instead, are created by
4140 * the TLS library and should be destroyed at the same level
4141 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004142 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4143 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004144 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004145 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4146#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004148#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004149#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004151 handshake->ecjpake_cache = NULL;
4152 handshake->ecjpake_cache_len = 0;
4153#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004154#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004155
Janos Follath4ae5c292016-02-10 11:27:43 +00004156#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4157 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004158 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004160#endif
4161
Ronald Cron73fe8df2022-10-05 14:31:43 +02004162#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004163#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004165 /* The maintenance of the external PSK key slot is the
4166 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 if (ssl->handshake->psk_opaque_is_internal) {
4168 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004169 ssl->handshake->psk_opaque_is_internal = 0;
4170 }
4171 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4172 }
Neil Armstronge952a302022-05-03 10:22:14 +02004173#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004174 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004175 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004176 }
Neil Armstronge952a302022-05-03 10:22:14 +02004177#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004178#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004180#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4181 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004182 /*
4183 * Free only the linked list wrapper, not the keys themselves
4184 * since the belong to the SNI callback
4185 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004186 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004187#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004188
Gilles Peskineeccd8882020-03-10 12:19:08 +01004189#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004190 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4191 if (handshake->ecrs_peer_cert != NULL) {
4192 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4193 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004194 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004195#endif
4196
Hanno Becker75173122019-02-06 16:18:31 +00004197#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4198 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004199 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004200#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4201
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004202#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4204 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004205#endif /* MBEDTLS_SSL_CLI_C &&
4206 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004207
4208#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 mbedtls_ssl_flight_free(handshake->flight);
4210 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004211#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004212
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02004213#if (defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 (defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004215 if (handshake->xxdh_psa_privkey_is_external == 0) {
4216 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 }
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02004218#endif /* (PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH) &&
4219 (MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3) */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004220
Ronald Cron6f135e12021-12-08 16:57:54 +01004221#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 mbedtls_ssl_transform_free(handshake->transform_handshake);
4223 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004224#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4226 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004227#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004228#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004229
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004230
4231#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4232 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4233 * processes datagrams and the fact that a datagram is allowed to have
4234 * several records in it, it is possible that the I/O buffers are not
4235 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004236 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4237 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004238#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004239
Jerry Yuba9c7272021-10-30 11:54:10 +08004240 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 mbedtls_platform_zeroize(handshake,
4242 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004243}
4244
Gilles Peskine449bd832023-01-11 14:50:10 +01004245void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004246{
Gilles Peskine449bd832023-01-11 14:50:10 +01004247 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004248 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004250
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004251#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004252 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004253#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004254
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004255#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004256#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4257 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004259#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004261#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004262
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004264}
4265
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004266#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004267
4268#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4269#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4270#else
4271#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4272#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4273
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004274#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004275
4276#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4277#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4278#else
4279#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4280#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4281
4282#if defined(MBEDTLS_SSL_ALPN)
4283#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4284#else
4285#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4286#endif /* MBEDTLS_SSL_ALPN */
4287
4288#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4289#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4290#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4291#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4292
4293#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 ((uint32_t) ( \
4295 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4296 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4297 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4298 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4299 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4300 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4301 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4302 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004303
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004304static unsigned char ssl_serialized_context_header[] = {
4305 MBEDTLS_VERSION_MAJOR,
4306 MBEDTLS_VERSION_MINOR,
4307 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4309 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4310 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4311 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4312 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004313};
4314
Paul Bakker5121ce52009-01-03 21:22:43 +00004315/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004316 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004317 *
4318 * The format of the serialized data is:
4319 * (in the presentation language of TLS, RFC 8446 section 3)
4320 *
4321 * // header
4322 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004323 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004324 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004325 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004326 * Note: When updating the format, remember to keep these
4327 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004328 *
4329 * // session sub-structure
4330 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4331 * // transform sub-structure
4332 * uint8 random[64]; // ServerHello.random+ClientHello.random
4333 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4334 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4335 * // fields from ssl_context
4336 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4337 * uint64 in_window_top; // DTLS: last validated record seq_num
4338 * uint64 in_window; // DTLS: bitmask for replay protection
4339 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4340 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4341 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4342 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4343 *
4344 * Note that many fields of the ssl_context or sub-structures are not
4345 * serialized, as they fall in one of the following categories:
4346 *
4347 * 1. forced value (eg in_left must be 0)
4348 * 2. pointer to dynamically-allocated memory (eg session, transform)
4349 * 3. value can be re-derived from other data (eg session keys from MS)
4350 * 4. value was temporary (eg content of input buffer)
4351 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004352 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004353int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4354 unsigned char *buf,
4355 size_t buf_len,
4356 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004357{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004358 unsigned char *p = buf;
4359 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004360 size_t session_len;
4361 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004362
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004363 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004364 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4365 * this function's documentation.
4366 *
4367 * These are due to assumptions/limitations in the implementation. Some of
4368 * them are likely to stay (no handshake in progress) some might go away
4369 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004370 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004371 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4373 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4374 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004375 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 if (ssl->handshake != NULL) {
4377 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4378 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004379 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004380 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 if (ssl->transform == NULL || ssl->session == NULL) {
4382 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4383 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004384 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004385 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 if (mbedtls_ssl_check_pending(ssl) != 0) {
4387 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4388 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004389 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 if (ssl->out_left != 0) {
4391 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4392 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004393 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004394 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4396 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4397 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004398 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004399 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4401 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4402 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004403 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004404 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4406 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4407 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004408 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004409 /* Renegotiation must not be enabled */
4410#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4412 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
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#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004416
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004417 /*
4418 * Version and format identifier
4419 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004421
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 if (used <= buf_len) {
4423 memcpy(p, ssl_serialized_context_header,
4424 sizeof(ssl_serialized_context_header));
4425 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004426 }
4427
4428 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004429 * Session (length + data)
4430 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4432 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4433 return ret;
4434 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004435
4436 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 if (used <= buf_len) {
4438 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004439 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004440
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 ret = ssl_session_save(ssl->session, 1,
4442 p, session_len, &session_len);
4443 if (ret != 0) {
4444 return ret;
4445 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004446
4447 p += session_len;
4448 }
4449
4450 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004451 * Transform
4452 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 used += sizeof(ssl->transform->randbytes);
4454 if (used <= buf_len) {
4455 memcpy(p, ssl->transform->randbytes,
4456 sizeof(ssl->transform->randbytes));
4457 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004458 }
4459
4460#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4461 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004463 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004465 p += ssl->transform->in_cid_len;
4466
4467 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004469 p += ssl->transform->out_cid_len;
4470 }
4471#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4472
4473 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004474 * Saved fields from top-level ssl_context structure
4475 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004476 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 if (used <= buf_len) {
4478 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004479 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004480 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004481
4482#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4483 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 if (used <= buf_len) {
4485 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004486 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004487
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004489 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004490 }
4491#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4492
4493#if defined(MBEDTLS_SSL_PROTO_DTLS)
4494 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004496 *p++ = ssl->disable_datagram_packing;
4497 }
4498#endif /* MBEDTLS_SSL_PROTO_DTLS */
4499
Jerry Yuae0b2e22021-10-08 15:21:19 +08004500 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 if (used <= buf_len) {
4502 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004503 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004504 }
4505
4506#if defined(MBEDTLS_SSL_PROTO_DTLS)
4507 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (used <= buf_len) {
4509 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004510 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004511 }
4512#endif /* MBEDTLS_SSL_PROTO_DTLS */
4513
4514#if defined(MBEDTLS_SSL_ALPN)
4515 {
4516 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004518 : 0;
4519
4520 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004522 *p++ = alpn_len;
4523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 if (ssl->alpn_chosen != NULL) {
4525 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004526 p += alpn_len;
4527 }
4528 }
4529 }
4530#endif /* MBEDTLS_SSL_ALPN */
4531
4532 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004533 * Done
4534 */
4535 *olen = used;
4536
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 if (used > buf_len) {
4538 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4539 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004540
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004542
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004544}
4545
4546/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004547 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004548 *
4549 * This internal version is wrapped by a public function that cleans up in
4550 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004551 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004552MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004553static int ssl_context_load(mbedtls_ssl_context *ssl,
4554 const unsigned char *buf,
4555 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004556{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004557 const unsigned char *p = buf;
4558 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004559 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004560 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004561#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004562 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004563#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004564
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004565 /*
4566 * The context should have been freshly setup or reset.
4567 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004568 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004569 * renegotiating, or if the user mistakenly loaded a session first.)
4570 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4572 ssl->session != NULL) {
4573 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004574 }
4575
4576 /*
4577 * We can't check that the config matches the initial one, but we can at
4578 * least check it matches the requirements for serializing.
4579 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004581 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4582 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004583#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004584 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004585#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 0) {
4587 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004588 }
4589
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004591
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004592 /*
4593 * Check version identifier
4594 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4596 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004597 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004598
4599 if (memcmp(p, ssl_serialized_context_header,
4600 sizeof(ssl_serialized_context_header)) != 0) {
4601 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4602 }
4603 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004604
4605 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004606 * Session
4607 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 if ((size_t) (end - p) < 4) {
4609 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4610 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004611
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004612 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004613 p += 4;
4614
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004615 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004616 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004617 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004618 ssl->session_in = ssl->session;
4619 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004620 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004621
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 if ((size_t) (end - p) < session_len) {
4623 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4624 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004625
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 ret = ssl_session_load(ssl->session, 1, p, session_len);
4627 if (ret != 0) {
4628 mbedtls_ssl_session_free(ssl->session);
4629 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004630 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004631
4632 p += session_len;
4633
4634 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004635 * Transform
4636 */
4637
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004638 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004639 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004640#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004641 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004642 ssl->transform_in = ssl->transform;
4643 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004644 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004645#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004646
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004647#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4649 if (prf_func == NULL) {
4650 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4651 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004652
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004653 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4655 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4656 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004657
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 ret = ssl_tls12_populate_transform(ssl->transform,
4659 ssl->session->ciphersuite,
4660 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004661#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004663#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 prf_func,
4665 p, /* currently pointing to randbytes */
4666 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4667 ssl->conf->endpoint,
4668 ssl);
4669 if (ret != 0) {
4670 return ret;
4671 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004672#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004674
4675#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4676 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 if ((size_t) (end - p) < 1) {
4678 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4679 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004680
4681 ssl->transform->in_cid_len = *p++;
4682
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4684 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4685 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004688 p += ssl->transform->in_cid_len;
4689
4690 ssl->transform->out_cid_len = *p++;
4691
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4693 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4694 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004695
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004697 p += ssl->transform->out_cid_len;
4698#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4699
4700 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004701 * Saved fields from top-level ssl_context structure
4702 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 if ((size_t) (end - p) < 4) {
4704 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4705 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004706
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004707 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004708 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004709
4710#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 if ((size_t) (end - p) < 16) {
4712 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4713 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004714
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004715 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004716 p += 8;
4717
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004718 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004719 p += 8;
4720#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4721
4722#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 if ((size_t) (end - p) < 1) {
4724 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4725 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004726
4727 ssl->disable_datagram_packing = *p++;
4728#endif /* MBEDTLS_SSL_PROTO_DTLS */
4729
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4732 }
4733 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4734 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004735
4736#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 if ((size_t) (end - p) < 2) {
4738 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4739 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004740
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004742 p += 2;
4743#endif /* MBEDTLS_SSL_PROTO_DTLS */
4744
4745#if defined(MBEDTLS_SSL_ALPN)
4746 {
4747 uint8_t alpn_len;
4748 const char **cur;
4749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 if ((size_t) (end - p) < 1) {
4751 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4752 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004753
4754 alpn_len = *p++;
4755
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004757 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4759 if (strlen(*cur) == alpn_len &&
4760 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004761 ssl->alpn_chosen = *cur;
4762 break;
4763 }
4764 }
4765 }
4766
4767 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4769 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4770 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004771
4772 p += alpn_len;
4773 }
4774#endif /* MBEDTLS_SSL_ALPN */
4775
4776 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004777 * Forced fields from top-level ssl_context structure
4778 *
4779 * Most of them already set to the correct value by mbedtls_ssl_init() and
4780 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4781 */
4782 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004783 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004784
Hanno Becker361b10d2019-08-30 10:42:49 +01004785 /* Adjust pointers for header fields of outgoing records to
4786 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004788
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004789#if defined(MBEDTLS_SSL_PROTO_DTLS)
4790 ssl->in_epoch = 1;
4791#endif
4792
4793 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4794 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004795 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4796 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if (ssl->handshake != NULL) {
4798 mbedtls_ssl_handshake_free(ssl);
4799 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004800 ssl->handshake = NULL;
4801 }
4802
4803 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004804 * Done - should have consumed entire buffer
4805 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 if (p != end) {
4807 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4808 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004809
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004811}
4812
4813/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004814 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004815 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004816int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4817 const unsigned char *buf,
4818 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004819{
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004821
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 if (ret != 0) {
4823 mbedtls_ssl_free(context);
4824 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004825
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004827}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004828#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004829
4830/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004831 * Free an SSL context
4832 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004833void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004834{
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004836 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004838
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004840
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004842#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4843 size_t out_buf_len = ssl->out_buf_len;
4844#else
4845 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4846#endif
4847
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004848 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004849 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004850 }
4851
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004853#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4854 size_t in_buf_len = ssl->in_buf_len;
4855#else
4856 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4857#endif
4858
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004859 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004860 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004861 }
4862
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 if (ssl->transform) {
4864 mbedtls_ssl_transform_free(ssl->transform);
4865 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004866 }
4867
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 if (ssl->handshake) {
4869 mbedtls_ssl_handshake_free(ssl);
4870 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004871
4872#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4874 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004875#endif
4876
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 mbedtls_ssl_session_free(ssl->session_negotiate);
4878 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004879 }
4880
Ronald Cron6f135e12021-12-08 16:57:54 +01004881#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 mbedtls_ssl_transform_free(ssl->transform_application);
4883 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004884#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004885
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 if (ssl->session) {
4887 mbedtls_ssl_session_free(ssl->session);
4888 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004889 }
4890
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004891#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004893 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00004894 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004895#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004896
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004897#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004899#endif
4900
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004902
Paul Bakker86f04f42013-02-14 11:20:09 +01004903 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004905}
4906
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004907/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004908 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004909 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004910void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004911{
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004913}
4914
Gilles Peskineae270bf2021-06-02 00:05:29 +02004915/* The selection should be the same as mbedtls_x509_crt_profile_default in
4916 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004917 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004918 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004919 * about this list.
4920 */
Brett Warrene0edc842021-08-17 09:53:13 +01004921static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004922#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004923 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004924#endif
4925#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004926 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004927#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004928#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004929 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004930#endif
4931#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004932 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004933#endif
4934#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004935 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004936#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004937#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004938 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004939#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004940#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004941 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004942#endif
4943#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004944 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004945#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02004946#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01004947 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
4948 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
4949 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
4950 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
4951 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
4952#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004953 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004954};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004955
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03004956static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004957 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4958 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4959 0
4960};
4961
Ronald Crone68ab4f2022-10-05 12:46:29 +02004962#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004963
Jerry Yu909df7b2022-01-22 11:56:27 +08004964/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004965 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004966 * rules SHOULD be upheld.
4967 * - No duplicate entries.
4968 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004969 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004970 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004971 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004972static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004973
Valerio Setti75fba322023-02-23 17:35:09 +01004974#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004975 defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004976 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4977 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004978#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA256 &&
Jerry Yued5e9f42022-01-26 11:21:34 +08004979 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004980
Valerio Setti75fba322023-02-23 17:35:09 +01004981#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004982 defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08004983 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4984 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004985#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004986 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4987
Valerio Setti75fba322023-02-23 17:35:09 +01004988#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004989 defined(MBEDTLS_MD_CAN_SHA512) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004990 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4991 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004992#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yued5e9f42022-01-26 11:21:34 +08004993 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004994
Gilles Peskine449bd832023-01-11 14:50:10 +01004995#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004996 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004997 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01004998#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004999 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005000
Gilles Peskine449bd832023-01-11 14:50:10 +01005001#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005002 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005003 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005004#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005005 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005006
Gilles Peskine449bd832023-01-11 14:50:10 +01005007#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005008 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005009 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005010#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005011 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005012
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005013#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005014 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005015#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005016
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005017#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005018 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005019#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005020
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005021#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005022 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005023#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005024
Gabor Mezei15b95a62022-05-09 16:37:58 +02005025 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005026};
5027
5028/* NOTICE: see above */
5029#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5030static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005031#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Setti75fba322023-02-23 17:35:09 +01005032#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005033 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005034#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005035#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5036 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5037#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005038#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005040#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005041#endif /* MBEDTLS_MD_CAN_SHA512*/
5042#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Setti75fba322023-02-23 17:35:09 +01005043#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005045#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005046#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5047 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5048#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005049#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005051#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005052#endif /* MBEDTLS_MD_CAN_SHA384*/
5053#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Setti75fba322023-02-23 17:35:09 +01005054#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005056#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005057#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5058 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5059#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005060#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005062#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005063#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005064 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005065};
5066#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5067/* NOTICE: see above */
5068static uint16_t ssl_preset_suiteb_sig_algs[] = {
5069
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005070#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08005071 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5072 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005073#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA256&&
Jerry Yu909df7b2022-01-22 11:56:27 +08005074 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
5075
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005076#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu53037892022-01-25 11:02:06 +08005077 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5078 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005079#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu53037892022-01-25 11:02:06 +08005080 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005081
Gilles Peskine449bd832023-01-11 14:50:10 +01005082#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005083 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005084 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005085#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005086 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005087
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005088#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005089 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005090#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005091
Gabor Mezei15b95a62022-05-09 16:37:58 +02005092 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005093};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005094
Jerry Yu909df7b2022-01-22 11:56:27 +08005095/* NOTICE: see above */
5096#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5097static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005098#if defined(MBEDTLS_MD_CAN_SHA256)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005099#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005101#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005102#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005104#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005105#endif /* MBEDTLS_MD_CAN_SHA256*/
5106#if defined(MBEDTLS_MD_CAN_SHA384)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005107#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005109#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005110#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005112#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005113#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005114 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005115};
Jerry Yu909df7b2022-01-22 11:56:27 +08005116#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5117
Ronald Crone68ab4f2022-10-05 12:46:29 +02005118#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005119
Brett Warrene0edc842021-08-17 09:53:13 +01005120static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01005121#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005122 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005123#endif
5124#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005125 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005126#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005127 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005128};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005129
Ronald Crone68ab4f2022-10-05 12:46:29 +02005130#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005131/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005132 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005133MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005134static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005135{
5136 size_t i, j;
5137 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005138
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5140 for (j = 0; j < i; j++) {
5141 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005142 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 }
5144 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5145 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5146 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005147 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005148 }
5149 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005150 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005151}
5152
Ronald Crone68ab4f2022-10-05 12:46:29 +02005153#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005154
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005155/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005156 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005157 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005158int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5159 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005160{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005161#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005162 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005163#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005164
Ronald Crone68ab4f2022-10-05 12:46:29 +02005165#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5167 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5168 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005169 }
5170
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5172 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5173 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005174 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005175
5176#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5178 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5179 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005180 }
5181
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5183 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5184 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005185 }
5186#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005187#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005188
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005189 /* Use the functions here so that they are covered in tests,
5190 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 mbedtls_ssl_conf_endpoint(conf, endpoint);
5192 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005193
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005194 /*
5195 * Things that are common to all presets
5196 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005197#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005199 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5200#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5201 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5202#endif
5203 }
5204#endif
5205
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005206#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5207 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5208#endif
5209
5210#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5211 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5212#endif
5213
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005214#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005215 conf->f_cookie_write = ssl_cookie_write_dummy;
5216 conf->f_cookie_check = ssl_cookie_check_dummy;
5217#endif
5218
5219#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5220 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5221#endif
5222
Janos Follath088ce432017-04-10 12:42:31 +01005223#if defined(MBEDTLS_SSL_SRV_C)
5224 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005225 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005226#endif
5227
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005228#if defined(MBEDTLS_SSL_PROTO_DTLS)
5229 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5230 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5231#endif
5232
5233#if defined(MBEDTLS_SSL_RENEGOTIATION)
5234 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 memset(conf->renego_period, 0x00, 2);
5236 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005237#endif
5238
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005239#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005241 const unsigned char dhm_p[] =
5242 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5243 const unsigned char dhm_g[] =
5244 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005245
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5247 dhm_p, sizeof(dhm_p),
5248 dhm_g, sizeof(dhm_g))) != 0) {
5249 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005250 }
5251 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005252#endif
5253
Ronald Cron6f135e12021-12-08 16:57:54 +01005254#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005255
5256#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 mbedtls_ssl_tls13_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005258#if defined(MBEDTLS_SSL_SRV_C)
5259 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005261#endif
5262#endif /* MBEDTLS_SSL_EARLY_DATA */
5263
Jerry Yud0766ec2022-09-22 10:46:57 +08005264#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005265 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005267#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005268 /*
5269 * Allow all TLS 1.3 key exchange modes by default.
5270 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005271 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005272#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005273
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005275#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005276 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005277 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005278#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005280#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005282#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005283 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5284 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005285#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5286 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5287 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5288#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5289 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5290 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5291#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005293#endif
5294 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005295
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005296 /*
5297 * Preset-specific defaults
5298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005300 /*
5301 * NSA Suite B
5302 */
5303 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005304
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005305 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005306
5307#if defined(MBEDTLS_X509_CRT_PARSE_C)
5308 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005309#endif
5310
Ronald Crone68ab4f2022-10-05 12:46:29 +02005311#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005312#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005314 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005316#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005318#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005319
Brett Warrene0edc842021-08-17 09:53:13 +01005320#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5321 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005322#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005323 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005324 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005325
5326 /*
5327 * Default
5328 */
5329 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005330
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005331 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005332
5333#if defined(MBEDTLS_X509_CRT_PARSE_C)
5334 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5335#endif
5336
Ronald Crone68ab4f2022-10-05 12:46:29 +02005337#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005338#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005340 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005342#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005344#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005345
Brett Warrene0edc842021-08-17 09:53:13 +01005346#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5347 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005348#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005349 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005350
5351#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5352 conf->dhm_min_bitlen = 1024;
5353#endif
5354 }
5355
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005357}
5358
5359/*
5360 * Free mbedtls_ssl_config
5361 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005362void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005363{
5364#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 mbedtls_mpi_free(&conf->dhm_P);
5366 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005367#endif
5368
Ronald Cron73fe8df2022-10-05 14:31:43 +02005369#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005370#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005372 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5373 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005374#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005376 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005377 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005378 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005379 }
5380
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005382 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005383 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005384 conf->psk_identity_len = 0;
5385 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005386#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005387
5388#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005390#endif
5391
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005393}
5394
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005395#if defined(MBEDTLS_PK_C) && \
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005396 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_CAN_ECDSA_SOME))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005397/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005398 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005399 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005400unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005401{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005402#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5404 return MBEDTLS_SSL_SIG_RSA;
5405 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005406#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005407#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5409 return MBEDTLS_SSL_SIG_ECDSA;
5410 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005411#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005413}
5414
Gilles Peskine449bd832023-01-11 14:50:10 +01005415unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005416{
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005418 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005420 case MBEDTLS_PK_ECDSA:
5421 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005423 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005425 }
5426}
5427
Gilles Peskine449bd832023-01-11 14:50:10 +01005428mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005429{
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005431#if defined(MBEDTLS_RSA_C)
5432 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005434#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005435#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005436 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005438#endif
5439 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005441 }
5442}
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005443#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_PK_CAN_ECDSA_SOME ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005444
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005445/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005446 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005447 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005448mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005449{
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005451#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005452 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005454#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005455#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005456 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005458#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005459#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005460 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005462#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005463#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005464 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005466#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005467#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005468 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005470#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005471#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005472 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005474#endif
5475 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005477 }
5478}
5479
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005480/*
5481 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5482 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005483unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005484{
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005486#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005487 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005489#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005490#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005491 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005493#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005494#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005495 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005497#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005498#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005499 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005501#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005502#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005503 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005505#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005506#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005507 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005509#endif
5510 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005512 }
5513}
5514
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005515/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005516 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005517 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005518 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005519int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005520{
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005522
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 if (group_list == NULL) {
5524 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005525 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005526
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 for (; *group_list != 0; group_list++) {
5528 if (*group_list == tls_id) {
5529 return 0;
5530 }
5531 }
5532
5533 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005534}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005535
Valerio Settid4a5d462023-04-05 18:19:01 +02005536#if defined(MBEDTLS_ECP_LIGHT)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005537/*
5538 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5539 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005540int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005541{
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005543
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005545 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005546 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005547
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005549}
Valerio Settid4a5d462023-04-05 18:19:01 +02005550#endif /* MBEDTLS_ECP_LIGHT */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005551
Gilles Peskine449bd832023-01-11 14:50:10 +01005552#if defined(MBEDTLS_DEBUG_C)
Valerio Setti67419f02023-01-04 16:12:42 +01005553#define EC_NAME(_name_) _name_
5554#else
5555#define EC_NAME(_name_) NULL
5556#endif
5557
Valerio Setti18c9fed2022-12-30 17:44:24 +01005558static const struct {
5559 uint16_t tls_id;
5560 mbedtls_ecp_group_id ecp_group_id;
5561 psa_ecc_family_t psa_family;
5562 uint16_t bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 const char *name;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005564} tls_id_match_table[] =
5565{
5566#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521, EC_NAME("secp521r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005568#endif
5569#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512, EC_NAME("brainpoolP512r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005571#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005572#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384, EC_NAME("secp384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005574#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005575#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384, EC_NAME("brainpoolP384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005577#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005578#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005579 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256, EC_NAME("secp256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005580#endif
5581#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256, EC_NAME("secp256k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005583#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005584#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256, EC_NAME("brainpoolP256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005586#endif
5587#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224, EC_NAME("secp224r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005589#endif
5590#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224, EC_NAME("secp224k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005592#endif
5593#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192, EC_NAME("secp192r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005595#endif
5596#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192, EC_NAME("secp192k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005598#endif
5599#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255, EC_NAME("x25519") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005601#endif
5602#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448, EC_NAME("x448") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005604#endif
5605 { 0, MBEDTLS_ECP_DP_NONE, 0, 0, NULL },
5606};
5607
Gilles Peskine449bd832023-01-11 14:50:10 +01005608int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005609 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005611{
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5613 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005614 if (type != NULL) {
5615 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005616 }
5617 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005618 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005620 return PSA_SUCCESS;
5621 }
5622 }
5623
5624 return PSA_ERROR_NOT_SUPPORTED;
5625}
5626
Gilles Peskine449bd832023-01-11 14:50:10 +01005627mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005628{
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5630 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005631 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005633 }
5634
5635 return MBEDTLS_ECP_DP_NONE;
5636}
5637
Gilles Peskine449bd832023-01-11 14:50:10 +01005638uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005639{
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5641 i++) {
5642 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005643 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005645 }
5646
5647 return 0;
5648}
5649
Valerio Setti67419f02023-01-04 16:12:42 +01005650#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005651const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005652{
Gilles Peskine449bd832023-01-11 14:50:10 +01005653 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5654 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005655 return tls_id_match_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005657 }
5658
5659 return NULL;
5660}
Valerio Setti67419f02023-01-04 16:12:42 +01005661#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005662
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005663#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005664int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5665 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5666 int cert_endpoint,
5667 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005668{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005669 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005670 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005671 const char *ext_oid;
5672 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005673
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005675 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005677 case MBEDTLS_KEY_EXCHANGE_RSA:
5678 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005679 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005680 break;
5681
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005682 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5683 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5684 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5685 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005686 break;
5687
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005688 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5689 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005690 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005691 break;
5692
5693 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005694 case MBEDTLS_KEY_EXCHANGE_NONE:
5695 case MBEDTLS_KEY_EXCHANGE_PSK:
5696 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5697 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005698 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005699 usage = 0;
5700 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005701 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005702 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5703 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005704 }
5705
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005707 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005708 ret = -1;
5709 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005710
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005712 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005713 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5714 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005715 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005716 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005717 }
5718
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005720 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005721 ret = -1;
5722 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005723
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005725}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005726#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005727
Jerry Yu148165c2021-09-24 23:20:59 +08005728#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005729int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5730 const mbedtls_md_type_t md,
5731 unsigned char *dst,
5732 size_t dst_len,
5733 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005734{
Ronald Cronf6893e12022-01-07 22:09:01 +01005735 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5736 psa_hash_operation_t *hash_operation_to_clone;
5737 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5738
Jerry Yu148165c2021-09-24 23:20:59 +08005739 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005740
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005742#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 case MBEDTLS_MD_SHA384:
5744 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5745 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005746#endif
5747
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005748#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 case MBEDTLS_MD_SHA256:
5750 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5751 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005752#endif
5753
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 default:
5755 goto exit;
5756 }
5757
5758 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5759 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005760 goto exit;
5761 }
5762
Gilles Peskine449bd832023-01-11 14:50:10 +01005763 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5764 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005765 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005767
5768exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005769#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5770 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005771 (void) ssl;
5772#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005773 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005774}
5775#else /* MBEDTLS_USE_PSA_CRYPTO */
5776
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005777#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005778MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005779static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5780 unsigned char *dst,
5781 size_t dst_len,
5782 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005783{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005784 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005785 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005786
Gilles Peskine449bd832023-01-11 14:50:10 +01005787 if (dst_len < 48) {
5788 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5789 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005790
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005791 mbedtls_md_init(&sha384);
5792 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005793 if (ret != 0) {
5794 goto exit;
5795 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005796 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005797 if (ret != 0) {
5798 goto exit;
5799 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005800
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005801 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005802 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005803 goto exit;
5804 }
5805
5806 *olen = 48;
5807
5808exit:
5809
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005810 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005811 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005812}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005813#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005814
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005815#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005816MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005817static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5818 unsigned char *dst,
5819 size_t dst_len,
5820 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005821{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005822 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005823 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005824
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 if (dst_len < 32) {
5826 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5827 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005828
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005829 mbedtls_md_init(&sha256);
5830 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5831 if (ret != 0) {
5832 goto exit;
5833 }
5834 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5835 if (ret != 0) {
5836 goto exit;
5837 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005838
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005839 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5840 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005841 goto exit;
5842 }
5843
5844 *olen = 32;
5845
5846exit:
5847
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005848 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005850}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005851#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005852
Gilles Peskine449bd832023-01-11 14:50:10 +01005853int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5854 const mbedtls_md_type_t md,
5855 unsigned char *dst,
5856 size_t dst_len,
5857 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005858{
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005860
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005861#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 case MBEDTLS_MD_SHA384:
5863 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005864#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005865
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005866#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 case MBEDTLS_MD_SHA256:
5868 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005869#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005870
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005872#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5873 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 (void) ssl;
5875 (void) dst;
5876 (void) dst_len;
5877 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005878#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005880 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005881 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005882}
XiaokangQian647719a2021-12-07 09:16:29 +00005883
Jerry Yu148165c2021-09-24 23:20:59 +08005884#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005885
Ronald Crone68ab4f2022-10-05 12:46:29 +02005886#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005887/* mbedtls_ssl_parse_sig_alg_ext()
5888 *
5889 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5890 * value (TLS 1.3 RFC8446):
5891 * enum {
5892 * ....
5893 * ecdsa_secp256r1_sha256( 0x0403 ),
5894 * ecdsa_secp384r1_sha384( 0x0503 ),
5895 * ecdsa_secp521r1_sha512( 0x0603 ),
5896 * ....
5897 * } SignatureScheme;
5898 *
5899 * struct {
5900 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5901 * } SignatureSchemeList;
5902 *
5903 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5904 * value (TLS 1.2 RFC5246):
5905 * enum {
5906 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5907 * sha512(6), (255)
5908 * } HashAlgorithm;
5909 *
5910 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5911 * SignatureAlgorithm;
5912 *
5913 * struct {
5914 * HashAlgorithm hash;
5915 * SignatureAlgorithm signature;
5916 * } SignatureAndHashAlgorithm;
5917 *
5918 * SignatureAndHashAlgorithm
5919 * supported_signature_algorithms<2..2^16-2>;
5920 *
5921 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5922 * generalization of the TLS 1.2 signature algorithm extension.
5923 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5924 * `SignatureScheme` field of TLS 1.3
5925 *
5926 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005927int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5928 const unsigned char *buf,
5929 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005930{
5931 const unsigned char *p = buf;
5932 size_t supported_sig_algs_len = 0;
5933 const unsigned char *supported_sig_algs_end;
5934 uint16_t sig_alg;
5935 uint32_t common_idx = 0;
5936
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5938 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005939 p += 2;
5940
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 memset(ssl->handshake->received_sig_algs, 0,
5942 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005943
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005945 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 while (p < supported_sig_algs_end) {
5947 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5948 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005949 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5951 sig_alg,
5952 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005953#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5955 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5956 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005957 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005958 }
5959#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005960
Gilles Peskine449bd832023-01-11 14:50:10 +01005961 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5962 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005963
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005965 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5966 common_idx += 1;
5967 }
5968 }
5969 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 if (p != end) {
5971 MBEDTLS_SSL_DEBUG_MSG(1,
5972 ("Signature algorithms extension length misaligned"));
5973 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5974 MBEDTLS_ERR_SSL_DECODE_ERROR);
5975 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02005976 }
5977
Gilles Peskine449bd832023-01-11 14:50:10 +01005978 if (common_idx == 0) {
5979 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
5980 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5981 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
5982 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005983 }
5984
Gabor Mezei15b95a62022-05-09 16:37:58 +02005985 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02005987}
5988
Ronald Crone68ab4f2022-10-05 12:46:29 +02005989#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02005990
Jerry Yudc7bd172022-02-17 13:44:15 +08005991#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5992
5993#if defined(MBEDTLS_USE_PSA_CRYPTO)
5994
Gilles Peskine449bd832023-01-11 14:50:10 +01005995static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
5996 mbedtls_svc_key_id_t key,
5997 psa_algorithm_t alg,
5998 const unsigned char *raw_psk, size_t raw_psk_length,
5999 const unsigned char *seed, size_t seed_length,
6000 const unsigned char *label, size_t label_length,
6001 const unsigned char *other_secret,
6002 size_t other_secret_length,
6003 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006004{
6005 psa_status_t status;
6006
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 status = psa_key_derivation_setup(derivation, alg);
6008 if (status != PSA_SUCCESS) {
6009 return status;
6010 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006011
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6013 status = psa_key_derivation_input_bytes(derivation,
6014 PSA_KEY_DERIVATION_INPUT_SEED,
6015 seed, seed_length);
6016 if (status != PSA_SUCCESS) {
6017 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006018 }
6019
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 if (other_secret != NULL) {
6021 status = psa_key_derivation_input_bytes(derivation,
6022 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6023 other_secret, other_secret_length);
6024 if (status != PSA_SUCCESS) {
6025 return status;
6026 }
6027 }
6028
6029 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006030 status = psa_key_derivation_input_bytes(
6031 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 raw_psk, raw_psk_length);
6033 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006034 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006036 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006037 if (status != PSA_SUCCESS) {
6038 return status;
6039 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006040
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 status = psa_key_derivation_input_bytes(derivation,
6042 PSA_KEY_DERIVATION_INPUT_LABEL,
6043 label, label_length);
6044 if (status != PSA_SUCCESS) {
6045 return status;
6046 }
6047 } else {
6048 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006049 }
6050
Gilles Peskine449bd832023-01-11 14:50:10 +01006051 status = psa_key_derivation_set_capacity(derivation, capacity);
6052 if (status != PSA_SUCCESS) {
6053 return status;
6054 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006055
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006057}
6058
Andrzej Kurek57d10632022-10-24 10:32:01 -04006059#if defined(PSA_WANT_ALG_SHA_384) || \
6060 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006061MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006062static int tls_prf_generic(mbedtls_md_type_t md_type,
6063 const unsigned char *secret, size_t slen,
6064 const char *label,
6065 const unsigned char *random, size_t rlen,
6066 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006067{
6068 psa_status_t status;
6069 psa_algorithm_t alg;
6070 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6071 psa_key_derivation_operation_t derivation =
6072 PSA_KEY_DERIVATION_OPERATION_INIT;
6073
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006075 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006077 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006079
6080 /* Normally a "secret" should be long enough to be impossible to
6081 * find by brute force, and in particular should not be empty. But
6082 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6083 * and for this use case it makes sense to have a 0-length "secret".
6084 * Since the key API doesn't allow importing a key of length 0,
6085 * keep master_key=0, which setup_psa_key_derivation() understands
6086 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006088 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6090 psa_set_key_algorithm(&key_attributes, alg);
6091 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006092
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6094 if (status != PSA_SUCCESS) {
6095 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6096 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006097 }
6098
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 status = setup_psa_key_derivation(&derivation,
6100 master_key, alg,
6101 NULL, 0,
6102 random, rlen,
6103 (unsigned char const *) label,
6104 (size_t) strlen(label),
6105 NULL, 0,
6106 dlen);
6107 if (status != PSA_SUCCESS) {
6108 psa_key_derivation_abort(&derivation);
6109 psa_destroy_key(master_key);
6110 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006111 }
6112
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6114 if (status != PSA_SUCCESS) {
6115 psa_key_derivation_abort(&derivation);
6116 psa_destroy_key(master_key);
6117 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006118 }
6119
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 status = psa_key_derivation_abort(&derivation);
6121 if (status != PSA_SUCCESS) {
6122 psa_destroy_key(master_key);
6123 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006124 }
6125
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 if (!mbedtls_svc_key_id_is_null(master_key)) {
6127 status = psa_destroy_key(master_key);
6128 }
6129 if (status != PSA_SUCCESS) {
6130 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6131 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006132
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006134}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006135#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006136#else /* MBEDTLS_USE_PSA_CRYPTO */
6137
Andrzej Kurek57d10632022-10-24 10:32:01 -04006138#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006139 (defined(MBEDTLS_MD_CAN_SHA256) || \
6140 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006141MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006142static int tls_prf_generic(mbedtls_md_type_t md_type,
6143 const unsigned char *secret, size_t slen,
6144 const char *label,
6145 const unsigned char *random, size_t rlen,
6146 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006147{
6148 size_t nb;
6149 size_t i, j, k, md_len;
6150 unsigned char *tmp;
6151 size_t tmp_len = 0;
6152 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6153 const mbedtls_md_info_t *md_info;
6154 mbedtls_md_context_t md_ctx;
6155 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6156
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006158
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6160 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6161 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006162
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006164
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 tmp_len = md_len + strlen(label) + rlen;
6166 tmp = mbedtls_calloc(1, tmp_len);
6167 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006168 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6169 goto exit;
6170 }
6171
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 nb = strlen(label);
6173 memcpy(tmp + md_len, label, nb);
6174 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006175 nb += rlen;
6176
6177 /*
6178 * Compute P_<hash>(secret, label + random)[0..dlen]
6179 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006181 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6185 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006186 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 }
6188 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6189 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006190 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006191 }
6192 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6193 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006194 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006196
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 for (i = 0; i < dlen; i += md_len) {
6198 ret = mbedtls_md_hmac_reset(&md_ctx);
6199 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006200 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 }
6202 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6203 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006204 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 }
6206 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6207 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006208 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006210
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 ret = mbedtls_md_hmac_reset(&md_ctx);
6212 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006213 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 }
6215 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6216 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006217 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 }
6219 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6220 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006221 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006223
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006225
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006227 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006228 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006229 }
6230
6231exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006233
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 if (tmp != NULL) {
6235 mbedtls_platform_zeroize(tmp, tmp_len);
6236 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006237
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006239
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006241
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006243}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006244#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006245#endif /* MBEDTLS_USE_PSA_CRYPTO */
6246
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006247#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006248MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006249static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6250 const char *label,
6251 const unsigned char *random, size_t rlen,
6252 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006253{
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6255 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006256}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006257#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006258
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006259#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006260MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006261static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6262 const char *label,
6263 const unsigned char *random, size_t rlen,
6264 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006265{
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6267 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006268}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006269#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006270
Jerry Yuf009d862022-02-17 14:01:37 +08006271/*
6272 * Set appropriate PRF function and other SSL / TLS1.2 functions
6273 *
6274 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006275 * - hash associated with the ciphersuite (only used by TLS 1.2)
6276 *
6277 * Outputs:
6278 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6279 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006280MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006281static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6282 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006283{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006284#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006285 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006286 handshake->tls_prf = tls_prf_sha384;
6287 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6288 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006290#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006291#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006292 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006293 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006294 handshake->tls_prf = tls_prf_sha256;
6295 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6296 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6297 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006298#else
Jerry Yuf009d862022-02-17 14:01:37 +08006299 {
Jerry Yuf009d862022-02-17 14:01:37 +08006300 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006301 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006303 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006304#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006305
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006307}
Jerry Yud6ab2352022-02-17 14:03:43 +08006308
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006309/*
6310 * Compute master secret if needed
6311 *
6312 * Parameters:
6313 * [in/out] handshake
6314 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6315 * (PSA-PSK) ciphersuite_info, psk_opaque
6316 * [out] premaster (cleared)
6317 * [out] master
6318 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6319 * debug: conf->f_dbg, conf->p_dbg
6320 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006321 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006322 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006323MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006324static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6325 unsigned char *master,
6326 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006327{
6328 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6329
6330 /* cf. RFC 5246, Section 8.1:
6331 * "The master secret is always exactly 48 bytes in length." */
6332 size_t const master_secret_len = 48;
6333
6334#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6335 unsigned char session_hash[48];
6336#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6337
6338 /* The label for the KDF used for key expansion.
6339 * This is either "master secret" or "extended master secret"
6340 * depending on whether the Extended Master Secret extension
6341 * is used. */
6342 char const *lbl = "master secret";
6343
Przemek Stekielae4ed302022-04-05 17:15:55 +02006344 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006345 * - If the Extended Master Secret extension is not used,
6346 * this is ClientHello.Random + ServerHello.Random
6347 * (see Sect. 8.1 in RFC 5246).
6348 * - If the Extended Master Secret extension is used,
6349 * this is the transcript of the handshake so far.
6350 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006351 unsigned char const *seed = handshake->randbytes;
6352 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006353
6354#if !defined(MBEDTLS_DEBUG_C) && \
6355 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6356 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006358 ssl = NULL; /* make sure we don't use it except for those cases */
6359 (void) ssl;
6360#endif
6361
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 if (handshake->resume != 0) {
6363 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6364 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006365 }
6366
6367#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006369 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006370 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006371 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6372 if (ret != 0) {
6373 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6374 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006375
Gilles Peskine449bd832023-01-11 14:50:10 +01006376 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6377 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006378 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006379#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006380
Przemek Stekiel99114f32022-04-22 11:20:09 +02006381#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006382 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006384 /* Perform PSK-to-MS expansion in a single step. */
6385 psa_status_t status;
6386 psa_algorithm_t alg;
6387 mbedtls_svc_key_id_t psk;
6388 psa_key_derivation_operation_t derivation =
6389 PSA_KEY_DERIVATION_OPERATION_INIT;
6390 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6391
Gilles Peskine449bd832023-01-11 14:50:10 +01006392 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006393
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006395
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006397 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006398 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006399 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006401
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006402 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006403 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006404
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006406 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006407 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006408 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006409 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006410 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006411 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006412 other_secret_len = 48;
6413 other_secret = handshake->premaster + 2;
6414 break;
6415 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006416 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006417 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6418 other_secret = handshake->premaster + 2;
6419 break;
6420 default:
6421 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006422 }
6423
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 status = setup_psa_key_derivation(&derivation, psk, alg,
6425 ssl->conf->psk, ssl->conf->psk_len,
6426 seed, seed_len,
6427 (unsigned char const *) lbl,
6428 (size_t) strlen(lbl),
6429 other_secret, other_secret_len,
6430 master_secret_len);
6431 if (status != PSA_SUCCESS) {
6432 psa_key_derivation_abort(&derivation);
6433 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006434 }
6435
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 status = psa_key_derivation_output_bytes(&derivation,
6437 master,
6438 master_secret_len);
6439 if (status != PSA_SUCCESS) {
6440 psa_key_derivation_abort(&derivation);
6441 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006442 }
6443
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 status = psa_key_derivation_abort(&derivation);
6445 if (status != PSA_SUCCESS) {
6446 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6447 }
6448 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006449#endif
6450 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006451#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006452 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6453 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006454 psa_status_t status;
6455 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6456 psa_key_derivation_operation_t derivation =
6457 PSA_KEY_DERIVATION_OPERATION_INIT;
6458
Gilles Peskine449bd832023-01-11 14:50:10 +01006459 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006460
6461 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6462
Gilles Peskine449bd832023-01-11 14:50:10 +01006463 status = psa_key_derivation_setup(&derivation, alg);
6464 if (status != PSA_SUCCESS) {
6465 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006466 }
6467
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 status = psa_key_derivation_set_capacity(&derivation,
6469 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6470 if (status != PSA_SUCCESS) {
6471 psa_key_derivation_abort(&derivation);
6472 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006473 }
6474
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6476 &derivation);
6477 if (status != PSA_SUCCESS) {
6478 psa_key_derivation_abort(&derivation);
6479 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006480 }
6481
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 status = psa_key_derivation_output_bytes(&derivation,
6483 handshake->premaster,
6484 handshake->pmslen);
6485 if (status != PSA_SUCCESS) {
6486 psa_key_derivation_abort(&derivation);
6487 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6488 }
6489
6490 status = psa_key_derivation_abort(&derivation);
6491 if (status != PSA_SUCCESS) {
6492 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006493 }
6494 }
6495#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6497 lbl, seed, seed_len,
6498 master,
6499 master_secret_len);
6500 if (ret != 0) {
6501 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6502 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006503 }
6504
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6506 handshake->premaster,
6507 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006508
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 mbedtls_platform_zeroize(handshake->premaster,
6510 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006511 }
6512
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006514}
6515
Gilles Peskine449bd832023-01-11 14:50:10 +01006516int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006517{
6518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6519 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6520 ssl->handshake->ciphersuite_info;
6521
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006523
6524 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006525 ret = ssl_set_handshake_prfs(ssl->handshake,
6526 ciphersuite_info->mac);
6527 if (ret != 0) {
6528 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6529 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006530 }
6531
6532 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 ret = ssl_compute_master(ssl->handshake,
6534 ssl->session_negotiate->master,
6535 ssl);
6536 if (ret != 0) {
6537 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6538 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006539 }
6540
6541 /* Swap the client and server random values:
6542 * - MS derivation wanted client+server (RFC 5246 8.1)
6543 * - key derivation wants server+client (RFC 5246 6.3) */
6544 {
6545 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 memcpy(tmp, ssl->handshake->randbytes, 64);
6547 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6548 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6549 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006550 }
6551
6552 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6554 ssl->session_negotiate->ciphersuite,
6555 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006556#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006558#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 ssl->handshake->tls_prf,
6560 ssl->handshake->randbytes,
6561 ssl->tls_version,
6562 ssl->conf->endpoint,
6563 ssl);
6564 if (ret != 0) {
6565 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6566 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006567 }
6568
6569 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6571 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006572
Gilles Peskine449bd832023-01-11 14:50:10 +01006573 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006574
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006576}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006577
Gilles Peskine449bd832023-01-11 14:50:10 +01006578int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006579{
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006581#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006582 case MBEDTLS_SSL_HASH_SHA384:
6583 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6584 break;
6585#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006586#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006587 case MBEDTLS_SSL_HASH_SHA256:
6588 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6589 break;
6590#endif
6591 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006592 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006593 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006594#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6595 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006596 (void) ssl;
6597#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006599}
6600
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006601#if defined(MBEDTLS_USE_PSA_CRYPTO)
6602static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6603 const psa_hash_operation_t *hs_op,
6604 size_t buffer_size,
6605 unsigned char *hash,
6606 size_t *hlen)
6607{
6608 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006609 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006610
6611#if !defined(MBEDTLS_DEBUG_C)
6612 (void) ssl;
6613#endif
6614 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006615 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006616 if (status != PSA_SUCCESS) {
6617 goto exit;
6618 }
6619
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006620 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006621 if (status != PSA_SUCCESS) {
6622 goto exit;
6623 }
6624
6625 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6626 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6627
6628exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006629 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006630 return mbedtls_md_error_from_psa(status);
6631}
6632#else
6633static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6634 const mbedtls_md_context_t *hs_ctx,
6635 unsigned char *hash,
6636 size_t *hlen)
6637{
6638 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006639 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006640
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006641 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006642
6643#if !defined(MBEDTLS_DEBUG_C)
6644 (void) ssl;
6645#endif
6646 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6647
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006648 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006649 if (ret != 0) {
6650 goto exit;
6651 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006652 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006653 if (ret != 0) {
6654 goto exit;
6655 }
6656
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006657 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006658 if (ret != 0) {
6659 goto exit;
6660 }
6661
6662 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6663
6664 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6665 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6666
6667exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006668 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006669 return ret;
6670}
6671#endif /* MBEDTLS_USE_PSA_CRYPTO */
6672
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006673#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006674int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6675 unsigned char *hash,
6676 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006677{
6678#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006679 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6680 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006681#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006682 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6683 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006684#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006685}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006686#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006687
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006688#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006689int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6690 unsigned char *hash,
6691 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006692{
6693#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006694 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6695 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006696#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006697 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6698 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006699#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006700}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006701#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006702
Neil Armstrong80f6f322022-05-03 17:56:38 +02006703#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6704 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006705int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006706{
6707 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006709 const unsigned char *psk = NULL;
6710 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006711 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006712
Gilles Peskine449bd832023-01-11 14:50:10 +01006713 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006714 /*
6715 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006716 * checked before calling this function.
6717 *
6718 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006719 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006720 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006721 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6722 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6723 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006724 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006725 }
6726
6727 /*
6728 * PMS = struct {
6729 * opaque other_secret<0..2^16-1>;
6730 * opaque psk<0..2^16-1>;
6731 * };
6732 * with "other_secret" depending on the particular key exchange
6733 */
6734#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006735 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6736 if (end - p < 2) {
6737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6738 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006739
Gilles Peskine449bd832023-01-11 14:50:10 +01006740 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006741 p += 2;
6742
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 if (end < p || (size_t) (end - p) < psk_len) {
6744 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6745 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006746
Gilles Peskine449bd832023-01-11 14:50:10 +01006747 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006748 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006750#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6751#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006753 /*
6754 * other_secret already set by the ClientKeyExchange message,
6755 * and is 48 bytes long
6756 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006757 if (end - p < 2) {
6758 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6759 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006760
6761 *p++ = 0;
6762 *p++ = 48;
6763 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006765#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6766#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006768 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6769 size_t len;
6770
6771 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6773 p + 2, end - (p + 2), &len,
6774 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6775 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6776 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006777 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006779 p += 2 + len;
6780
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6782 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006783#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006784#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006786 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6787 size_t zlen;
6788
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6790 p + 2, end - (p + 2),
6791 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6792 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6793 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006794 }
6795
Gilles Peskine449bd832023-01-11 14:50:10 +01006796 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006797 p += 2 + zlen;
6798
Gilles Peskine449bd832023-01-11 14:50:10 +01006799 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6800 MBEDTLS_DEBUG_ECDH_Z);
6801 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006802#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006803 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6805 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006806 }
6807
6808 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 if (end - p < 2) {
6810 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6811 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006812
Gilles Peskine449bd832023-01-11 14:50:10 +01006813 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006814 p += 2;
6815
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 if (end < p || (size_t) (end - p) < psk_len) {
6817 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6818 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006819
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006821 p += psk_len;
6822
6823 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6824
Gilles Peskine449bd832023-01-11 14:50:10 +01006825 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006826}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006827#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006828
6829#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006830MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006831static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006832
6833#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006834int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006835{
6836 /* If renegotiation is not enforced, retransmit until we would reach max
6837 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006839 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6840 unsigned char doublings = 1;
6841
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006843 ++doublings;
6844 ratio >>= 1;
6845 }
6846
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 if (++ssl->renego_records_seen > doublings) {
6848 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6849 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006850 }
6851 }
6852
Gilles Peskine449bd832023-01-11 14:50:10 +01006853 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006854}
6855#endif
6856#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006857
Jerry Yud9526692022-02-17 14:23:47 +08006858/*
6859 * Handshake functions
6860 */
6861#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6862/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006863int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006864{
6865 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6866 ssl->handshake->ciphersuite_info;
6867
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006869
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6871 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006872 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006874 }
6875
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6877 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006878}
6879
Gilles Peskine449bd832023-01-11 14:50:10 +01006880int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006881{
6882 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6883 ssl->handshake->ciphersuite_info;
6884
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006886
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6888 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006889 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006891 }
6892
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6894 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006895}
6896
6897#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6898/* Some certificate support -> implement write and parse */
6899
Gilles Peskine449bd832023-01-11 14:50:10 +01006900int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006901{
6902 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6903 size_t i, n;
6904 const mbedtls_x509_crt *crt;
6905 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6906 ssl->handshake->ciphersuite_info;
6907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6911 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006912 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006914 }
6915
6916#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6918 if (ssl->handshake->client_auth == 0) {
6919 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006920 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006922 }
6923 }
6924#endif /* MBEDTLS_SSL_CLI_C */
6925#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6927 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006928 /* Should never happen because we shouldn't have picked the
6929 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006931 }
6932 }
6933#endif
6934
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006936
6937 /*
6938 * 0 . 0 handshake type
6939 * 1 . 3 handshake length
6940 * 4 . 6 length of all certs
6941 * 7 . 9 length of cert. 1
6942 * 10 . n-1 peer certificate
6943 * n . n+2 length of cert. 2
6944 * n+3 . ... upper level cert, etc.
6945 */
6946 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006947 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006948
Gilles Peskine449bd832023-01-11 14:50:10 +01006949 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006950 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6952 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6953 " > %" MBEDTLS_PRINTF_SIZET,
6954 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6955 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006956 }
6957
Gilles Peskine449bd832023-01-11 14:50:10 +01006958 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6959 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6960 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006961
Gilles Peskine449bd832023-01-11 14:50:10 +01006962 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006963 i += n; crt = crt->next;
6964 }
6965
Gilles Peskine449bd832023-01-11 14:50:10 +01006966 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6967 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6968 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006969
6970 ssl->out_msglen = i;
6971 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6972 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6973
6974 ssl->state++;
6975
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6977 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6978 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006979 }
6980
Gilles Peskine449bd832023-01-11 14:50:10 +01006981 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006982
Gilles Peskine449bd832023-01-11 14:50:10 +01006983 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006984}
6985
6986#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6987
6988#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006989MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006990static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6991 unsigned char *crt_buf,
6992 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006993{
6994 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6995
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 if (peer_crt == NULL) {
6997 return -1;
6998 }
Jerry Yud9526692022-02-17 14:23:47 +08006999
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 if (peer_crt->raw.len != crt_buf_len) {
7001 return -1;
7002 }
Jerry Yud9526692022-02-17 14:23:47 +08007003
Gilles Peskine449bd832023-01-11 14:50:10 +01007004 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007005}
7006#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007007MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007008static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7009 unsigned char *crt_buf,
7010 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007011{
7012 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7013 unsigned char const * const peer_cert_digest =
7014 ssl->session->peer_cert_digest;
7015 mbedtls_md_type_t const peer_cert_digest_type =
7016 ssl->session->peer_cert_digest_type;
7017 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007019 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7020 size_t digest_len;
7021
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 if (peer_cert_digest == NULL || digest_info == NULL) {
7023 return -1;
7024 }
Jerry Yud9526692022-02-17 14:23:47 +08007025
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 digest_len = mbedtls_md_get_size(digest_info);
7027 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7028 return -1;
7029 }
Jerry Yud9526692022-02-17 14:23:47 +08007030
Gilles Peskine449bd832023-01-11 14:50:10 +01007031 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7032 if (ret != 0) {
7033 return -1;
7034 }
Jerry Yud9526692022-02-17 14:23:47 +08007035
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007037}
7038#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7039#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7040
7041/*
7042 * Once the certificate message is read, parse it into a cert chain and
7043 * perform basic checks, but leave actual verification to the caller
7044 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007045MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007046static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7047 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007048{
7049 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7050#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007052#endif
7053 size_t i, n;
7054 uint8_t alert;
7055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7057 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7058 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7059 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7060 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007061 }
7062
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7064 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7065 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7066 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007067 }
7068
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7070 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7071 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7072 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7073 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007074 }
7075
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007077
7078 /*
7079 * Same message structure as in mbedtls_ssl_write_certificate()
7080 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007082
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 if (ssl->in_msg[i] != 0 ||
7084 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7085 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7086 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7087 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7088 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007089 }
7090
7091 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7092 i += 3;
7093
7094 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007096 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 if (i + 3 > ssl->in_hslen) {
7098 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7099 mbedtls_ssl_send_alert_message(ssl,
7100 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7101 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7102 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007103 }
7104 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7105 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 if (ssl->in_msg[i] != 0) {
7107 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7108 mbedtls_ssl_send_alert_message(ssl,
7109 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7110 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7111 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007112 }
7113
7114 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007116 | (unsigned int) ssl->in_msg[i + 2];
7117 i += 3;
7118
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 if (n < 128 || i + n > ssl->in_hslen) {
7120 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7121 mbedtls_ssl_send_alert_message(ssl,
7122 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7123 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7124 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007125 }
7126
7127 /* Check if we're handling the first CRT in the chain. */
7128#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007130 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007132 /* During client-side renegotiation, check that the server's
7133 * end-CRTs hasn't changed compared to the initial handshake,
7134 * mitigating the triple handshake attack. On success, reuse
7135 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7137 if (ssl_check_peer_crt_unchanged(ssl,
7138 &ssl->in_msg[i],
7139 n) != 0) {
7140 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7141 mbedtls_ssl_send_alert_message(ssl,
7142 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7143 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7144 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007145 }
7146
7147 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007149 }
7150#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7151
7152 /* Parse the next certificate in the chain. */
7153#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007155#else
7156 /* If we don't need to store the CRT chain permanently, parse
7157 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007159#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007161 case 0: /*ok*/
7162 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7163 /* Ignore certificate with an unknown algorithm: maybe a
7164 prior certificate was already trusted. */
7165 break;
7166
7167 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7168 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7169 goto crt_parse_der_failed;
7170
7171 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7172 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7173 goto crt_parse_der_failed;
7174
7175 default:
7176 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007177crt_parse_der_failed:
7178 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7179 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7180 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007181 }
7182
7183 i += n;
7184 }
7185
Gilles Peskine449bd832023-01-11 14:50:10 +01007186 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7187 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007188}
7189
7190#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007191MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007192static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007193{
Gilles Peskine449bd832023-01-11 14:50:10 +01007194 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7195 return -1;
7196 }
Jerry Yud9526692022-02-17 14:23:47 +08007197
Gilles Peskine449bd832023-01-11 14:50:10 +01007198 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007199 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7200 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7202 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7203 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007204 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007206}
7207#endif /* MBEDTLS_SSL_SRV_C */
7208
7209/* Check if a certificate message is expected.
7210 * Return either
7211 * - SSL_CERTIFICATE_EXPECTED, or
7212 * - SSL_CERTIFICATE_SKIP
7213 * indicating whether a Certificate message is expected or not.
7214 */
7215#define SSL_CERTIFICATE_EXPECTED 0
7216#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007217MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007218static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7219 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007220{
7221 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7222 ssl->handshake->ciphersuite_info;
7223
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7225 return SSL_CERTIFICATE_SKIP;
7226 }
Jerry Yud9526692022-02-17 14:23:47 +08007227
7228#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7230 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7231 return SSL_CERTIFICATE_SKIP;
7232 }
Jerry Yud9526692022-02-17 14:23:47 +08007233
Gilles Peskine449bd832023-01-11 14:50:10 +01007234 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007235 ssl->session_negotiate->verify_result =
7236 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007238 }
7239 }
7240#else
7241 ((void) authmode);
7242#endif /* MBEDTLS_SSL_SRV_C */
7243
Gilles Peskine449bd832023-01-11 14:50:10 +01007244 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007245}
7246
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007247MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007248static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7249 int authmode,
7250 mbedtls_x509_crt *chain,
7251 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007252{
7253 int ret = 0;
7254 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7255 ssl->handshake->ciphersuite_info;
7256 int have_ca_chain = 0;
7257
7258 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7259 void *p_vrfy;
7260
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7262 return 0;
7263 }
Jerry Yud9526692022-02-17 14:23:47 +08007264
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 if (ssl->f_vrfy != NULL) {
7266 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007267 f_vrfy = ssl->f_vrfy;
7268 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007269 } else {
7270 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007271 f_vrfy = ssl->conf->f_vrfy;
7272 p_vrfy = ssl->conf->p_vrfy;
7273 }
7274
7275 /*
7276 * Main check: verify certificate
7277 */
7278#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007279 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007280 ((void) rs_ctx);
7281 have_ca_chain = 1;
7282
Gilles Peskine449bd832023-01-11 14:50:10 +01007283 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007284 ret = mbedtls_x509_crt_verify_with_ca_cb(
7285 chain,
7286 ssl->conf->f_ca_cb,
7287 ssl->conf->p_ca_cb,
7288 ssl->conf->cert_profile,
7289 ssl->hostname,
7290 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007291 f_vrfy, p_vrfy);
7292 } else
Jerry Yud9526692022-02-17 14:23:47 +08007293#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7294 {
7295 mbedtls_x509_crt *ca_chain;
7296 mbedtls_x509_crl *ca_crl;
7297
7298#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007300 ca_chain = ssl->handshake->sni_ca_chain;
7301 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 } else
Jerry Yud9526692022-02-17 14:23:47 +08007303#endif
7304 {
7305 ca_chain = ssl->conf->ca_chain;
7306 ca_crl = ssl->conf->ca_crl;
7307 }
7308
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007310 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007311 }
Jerry Yud9526692022-02-17 14:23:47 +08007312
7313 ret = mbedtls_x509_crt_verify_restartable(
7314 chain,
7315 ca_chain, ca_crl,
7316 ssl->conf->cert_profile,
7317 ssl->hostname,
7318 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007320 }
7321
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 if (ret != 0) {
7323 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007324 }
7325
7326#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007327 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7328 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7329 }
Jerry Yud9526692022-02-17 14:23:47 +08007330#endif
7331
7332 /*
7333 * Secondary checks: always done, but change 'ret' only if it was 0
7334 */
7335
Valerio Setti6c496a12023-04-07 15:53:51 +02007336#if defined(MBEDTLS_ECP_LIGHT)
Jerry Yud9526692022-02-17 14:23:47 +08007337 {
7338 const mbedtls_pk_context *pk = &chain->pk;
7339
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007340 /* If certificate uses an EC key, make sure the curve is OK.
7341 * This is a public key, so it can't be opaque, so can_do() is a good
7342 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007344 /* and in the unlikely case the above assumption no longer holds
7345 * we are making sure that pk_ec() here does not return a NULL
7346 */
Valerio Settid0405092023-05-24 13:16:40 +02007347 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7348 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7349 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007350 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007351 }
Valerio Setti97207782023-05-18 18:59:06 +02007352 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007353 ssl->session_negotiate->verify_result |=
7354 MBEDTLS_X509_BADCERT_BAD_KEY;
7355
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7357 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007358 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007359 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007360 }
Jerry Yud9526692022-02-17 14:23:47 +08007361 }
7362 }
Valerio Setti6c496a12023-04-07 15:53:51 +02007363#endif /* MBEDTLS_ECP_LIGHT */
Jerry Yud9526692022-02-17 14:23:47 +08007364
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 if (mbedtls_ssl_check_cert_usage(chain,
7366 ciphersuite_info,
7367 !ssl->conf->endpoint,
7368 &ssl->session_negotiate->verify_result) != 0) {
7369 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7370 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007371 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 }
Jerry Yud9526692022-02-17 14:23:47 +08007373 }
7374
7375 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7376 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7377 * with details encoded in the verification flags. All other kinds
7378 * of error codes, including those from the user provided f_vrfy
7379 * functions, are treated as fatal and lead to a failure of
7380 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7382 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7383 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007384 ret = 0;
7385 }
7386
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7388 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007389 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7390 }
7391
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007393 uint8_t alert;
7394
7395 /* The certificate may have been rejected for several reasons.
7396 Pick one and send the corresponding alert. Which alert to send
7397 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007399 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007401 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007402 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007403 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007405 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007407 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007409 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007411 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007413 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007415 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007417 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007419 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 }
7421 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7422 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007423 }
7424
7425#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 if (ssl->session_negotiate->verify_result != 0) {
7427 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7428 (unsigned int) ssl->session_negotiate->verify_result));
7429 } else {
7430 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007431 }
7432#endif /* MBEDTLS_DEBUG_C */
7433
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007435}
7436
7437#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007438MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007439static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7440 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007441{
7442 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7443 /* Remember digest of the peer's end-CRT. */
7444 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7446 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7447 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7448 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7449 mbedtls_ssl_send_alert_message(ssl,
7450 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7451 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007452
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007454 }
7455
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 ret = mbedtls_md(mbedtls_md_info_from_type(
7457 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7458 start, len,
7459 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007460
7461 ssl->session_negotiate->peer_cert_digest_type =
7462 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7463 ssl->session_negotiate->peer_cert_digest_len =
7464 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7465
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007467}
7468
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007469MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007470static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7471 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007472{
7473 unsigned char *end = start + len;
7474 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7475
7476 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7478 ret = mbedtls_pk_parse_subpubkey(&start, end,
7479 &ssl->handshake->peer_pubkey);
7480 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007481 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007483 }
7484
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007486}
7487#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007490{
7491 int ret = 0;
7492 int crt_expected;
7493#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7494 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7495 ? ssl->handshake->sni_authmode
7496 : ssl->conf->authmode;
7497#else
7498 const int authmode = ssl->conf->authmode;
7499#endif
7500 void *rs_ctx = NULL;
7501 mbedtls_x509_crt *chain = NULL;
7502
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007504
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7506 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7507 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007508 goto exit;
7509 }
7510
7511#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 if (ssl->handshake->ecrs_enabled &&
7513 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007514 chain = ssl->handshake->ecrs_peer_cert;
7515 ssl->handshake->ecrs_peer_cert = NULL;
7516 goto crt_verify;
7517 }
7518#endif
7519
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007521 /* mbedtls_ssl_read_record may have sent an alert already. We
7522 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007524 goto exit;
7525 }
7526
7527#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007529 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7530
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007532 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 }
Jerry Yud9526692022-02-17 14:23:47 +08007534
7535 goto exit;
7536 }
7537#endif /* MBEDTLS_SSL_SRV_C */
7538
7539 /* Clear existing peer CRT structure in case we tried to
7540 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007542
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7544 if (chain == NULL) {
7545 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7546 sizeof(mbedtls_x509_crt)));
7547 mbedtls_ssl_send_alert_message(ssl,
7548 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7549 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007550
7551 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7552 goto exit;
7553 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007555
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 ret = ssl_parse_certificate_chain(ssl, chain);
7557 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007558 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 }
Jerry Yud9526692022-02-17 14:23:47 +08007560
7561#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007563 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 }
Jerry Yud9526692022-02-17 14:23:47 +08007565
7566crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007567 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007568 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 }
Jerry Yud9526692022-02-17 14:23:47 +08007570#endif
7571
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 ret = ssl_parse_certificate_verify(ssl, authmode,
7573 chain, rs_ctx);
7574 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007575 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 }
Jerry Yud9526692022-02-17 14:23:47 +08007577
7578#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7579 {
7580 unsigned char *crt_start, *pk_start;
7581 size_t crt_len, pk_len;
7582
7583 /* We parse the CRT chain without copying, so
7584 * these pointers point into the input buffer,
7585 * and are hence still valid after freeing the
7586 * CRT chain. */
7587
7588 crt_start = chain->raw.p;
7589 crt_len = chain->raw.len;
7590
7591 pk_start = chain->pk_raw.p;
7592 pk_len = chain->pk_raw.len;
7593
7594 /* Free the CRT structures before computing
7595 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007596 mbedtls_x509_crt_free(chain);
7597 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007598 chain = NULL;
7599
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7601 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007602 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 }
Jerry Yud9526692022-02-17 14:23:47 +08007604
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7606 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007607 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 }
Jerry Yud9526692022-02-17 14:23:47 +08007609 }
7610#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7611 /* Pass ownership to session structure. */
7612 ssl->session_negotiate->peer_cert = chain;
7613 chain = NULL;
7614#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7615
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007617
7618exit:
7619
Gilles Peskine449bd832023-01-11 14:50:10 +01007620 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007621 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 }
Jerry Yud9526692022-02-17 14:23:47 +08007623
7624#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007626 ssl->handshake->ecrs_peer_cert = chain;
7627 chain = NULL;
7628 }
7629#endif
7630
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 if (chain != NULL) {
7632 mbedtls_x509_crt_free(chain);
7633 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007634 }
7635
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007637}
7638#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7639
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007640static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7641 unsigned char *padbuf, size_t hlen,
7642 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007643{
7644 int len = 12;
7645 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007646#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007647 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007648 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007649 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007650 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007651#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007652 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007653 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007654 mbedtls_md_context_t cloned_ctx;
7655 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007656#endif
7657
7658 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007660 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007662
Gilles Peskine449bd832023-01-11 14:50:10 +01007663 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007664 ? "client finished"
7665 : "server finished";
7666
7667#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007668 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007669
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007670 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007672 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007673 }
7674
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007675 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007677 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007678 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007679 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007680#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007681 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007682
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007683 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007684 if (ret != 0) {
7685 goto exit;
7686 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007687 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007688 if (ret != 0) {
7689 goto exit;
7690 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007691
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007692 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007693 if (ret != 0) {
7694 goto exit;
7695 }
7696#endif /* MBEDTLS_USE_PSA_CRYPTO */
7697
7698 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7699
Jerry Yu615bd6f2022-02-17 14:25:15 +08007700 /*
7701 * TLSv1.2:
7702 * hash = PRF( master, finished_label,
7703 * Hash( handshake ) )[0.11]
7704 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007705 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007706 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007707
Gilles Peskine449bd832023-01-11 14:50:10 +01007708 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007709
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007711
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007712 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007713
7714exit:
7715#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007716 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007717 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007718#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007719 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007720 return ret;
7721#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007722}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007723
7724#if defined(MBEDTLS_MD_CAN_SHA256)
7725static int ssl_calc_finished_tls_sha256(
7726 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7727{
7728 unsigned char padbuf[32];
7729 return ssl_calc_finished_tls_generic(ssl,
7730#if defined(MBEDTLS_USE_PSA_CRYPTO)
7731 &ssl->handshake->fin_sha256_psa,
7732#else
7733 &ssl->handshake->fin_sha256,
7734#endif
7735 padbuf, sizeof(padbuf),
7736 buf, from);
7737}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007738#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007739
Jerry Yub7ba49e2022-02-17 14:25:53 +08007740
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007741#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007742static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007744{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007745 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007746 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007747#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007748 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007749#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007750 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007751#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007752 padbuf, sizeof(padbuf),
7753 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007754}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007755#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007756
Gilles Peskine449bd832023-01-11 14:50:10 +01007757void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007758{
Gilles Peskine449bd832023-01-11 14:50:10 +01007759 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007760
7761 /*
7762 * Free our handshake params
7763 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 mbedtls_ssl_handshake_free(ssl);
7765 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007766 ssl->handshake = NULL;
7767
7768 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007769 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 if (ssl->transform) {
7772 mbedtls_ssl_transform_free(ssl->transform);
7773 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007774 }
7775 ssl->transform = ssl->transform_negotiate;
7776 ssl->transform_negotiate = NULL;
7777
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007779}
7780
Gilles Peskine449bd832023-01-11 14:50:10 +01007781void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007782{
7783 int resume = ssl->handshake->resume;
7784
Gilles Peskine449bd832023-01-11 14:50:10 +01007785 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007786
7787#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007789 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7790 ssl->renego_records_seen = 0;
7791 }
7792#endif
7793
7794 /*
7795 * Free the previous session and switch in the current one
7796 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007797 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007798#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7799 /* RFC 7366 3.1: keep the EtM state */
7800 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007802#endif
7803
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 mbedtls_ssl_session_free(ssl->session);
7805 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007806 }
7807 ssl->session = ssl->session_negotiate;
7808 ssl->session_negotiate = NULL;
7809
7810 /*
7811 * Add cache entry
7812 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007814 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 resume == 0) {
7816 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7817 ssl->session->id,
7818 ssl->session->id_len,
7819 ssl->session) != 0) {
7820 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7821 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007822 }
7823
7824#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007825 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7826 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007827 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007828 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007829
7830 /* Keep last flight around in case we need to resend it:
7831 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7833 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007834#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007835 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007836
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007837 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007838
Gilles Peskine449bd832023-01-11 14:50:10 +01007839 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007840}
7841
Gilles Peskine449bd832023-01-11 14:50:10 +01007842int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007843{
7844 int ret, hash_len;
7845
Gilles Peskine449bd832023-01-11 14:50:10 +01007846 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007847
Gilles Peskine449bd832023-01-11 14:50:10 +01007848 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007849
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007850 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7851 if (ret != 0) {
7852 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7853 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007854
7855 /*
7856 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7857 * may define some other value. Currently (early 2016), no defined
7858 * ciphersuite does this (and this is unlikely to change as activity has
7859 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7860 */
7861 hash_len = 12;
7862
7863#if defined(MBEDTLS_SSL_RENEGOTIATION)
7864 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007865 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007866#endif
7867
7868 ssl->out_msglen = 4 + hash_len;
7869 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7870 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7871
7872 /*
7873 * In case of session resuming, invert the client and server
7874 * ChangeCipherSpec messages order.
7875 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007876 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007877#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007878 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007879 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007881#endif
7882#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007883 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007884 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007886#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007888 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007889 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007890
7891 /*
7892 * Switch to our negotiated transform and session parameters for outbound
7893 * data.
7894 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007896
7897#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007899 unsigned char i;
7900
7901 /* Remember current epoch settings for resending */
7902 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7904 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007905
7906 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007908
7909
7910 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007911 for (i = 2; i > 0; i--) {
7912 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007913 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 }
7915 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007916
7917 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 if (i == 0) {
7919 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7920 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007921 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007923#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007925
7926 ssl->transform_out = ssl->transform_negotiate;
7927 ssl->session_out = ssl->session_negotiate;
7928
7929#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7931 mbedtls_ssl_send_flight_completed(ssl);
7932 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007933#endif
7934
Gilles Peskine449bd832023-01-11 14:50:10 +01007935 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7936 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7937 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007938 }
7939
7940#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7942 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7943 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7944 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007945 }
7946#endif
7947
Gilles Peskine449bd832023-01-11 14:50:10 +01007948 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007949
Gilles Peskine449bd832023-01-11 14:50:10 +01007950 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007951}
7952
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007953#define SSL_MAX_HASH_LEN 12
7954
Gilles Peskine449bd832023-01-11 14:50:10 +01007955int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007956{
7957 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7958 unsigned int hash_len = 12;
7959 unsigned char buf[SSL_MAX_HASH_LEN];
7960
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007962
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007963 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7964 if (ret != 0) {
7965 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7966 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007967
Gilles Peskine449bd832023-01-11 14:50:10 +01007968 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7969 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007970 goto exit;
7971 }
7972
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7974 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7975 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7976 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007977 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7978 goto exit;
7979 }
7980
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7982 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7983 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007984 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7985 goto exit;
7986 }
7987
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7989 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7990 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7991 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007992 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7993 goto exit;
7994 }
7995
Gilles Peskine449bd832023-01-11 14:50:10 +01007996 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7997 buf, hash_len) != 0) {
7998 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7999 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8000 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008001 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8002 goto exit;
8003 }
8004
8005#if defined(MBEDTLS_SSL_RENEGOTIATION)
8006 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008008#endif
8009
Gilles Peskine449bd832023-01-11 14:50:10 +01008010 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008011#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008013 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008015#endif
8016#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008018 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008020#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008021 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008022 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008024
8025#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8027 mbedtls_ssl_recv_flight_completed(ssl);
8028 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008029#endif
8030
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008032
8033exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 mbedtls_platform_zeroize(buf, hash_len);
8035 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008036}
8037
Jerry Yu392112c2022-02-17 14:34:10 +08008038#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8039/*
8040 * Helper to get TLS 1.2 PRF from ciphersuite
8041 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008043static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008044{
Jerry Yu392112c2022-02-17 14:34:10 +08008045 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008047#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8049 return tls_prf_sha384;
8050 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008051#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008052#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008053 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8055 return tls_prf_sha256;
8056 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008057 }
8058#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008059#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8060 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008061 (void) ciphersuite_info;
8062#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008063
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008065}
8066#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008067
Gilles Peskine449bd832023-01-11 14:50:10 +01008068static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008069{
8070 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008071#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 if (tls_prf == tls_prf_sha384) {
8073 return MBEDTLS_SSL_TLS_PRF_SHA384;
8074 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008075#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008076#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 if (tls_prf == tls_prf_sha256) {
8078 return MBEDTLS_SSL_TLS_PRF_SHA256;
8079 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008080#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008081 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008082}
8083
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008084/*
8085 * Populate a transform structure with session keys and all the other
8086 * necessary information.
8087 *
8088 * Parameters:
8089 * - [in/out]: transform: structure to populate
8090 * [in] must be just initialised with mbedtls_ssl_transform_init()
8091 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8092 * - [in] ciphersuite
8093 * - [in] master
8094 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008095 * - [in] tls_prf: pointer to PRF to use for key derivation
8096 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008097 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008098 * - [in] endpoint: client or server
8099 * - [in] ssl: used for:
8100 * - ssl->conf->{f,p}_export_keys
8101 * [in] optionally used for:
8102 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8103 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008104MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008105static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8106 int ciphersuite,
8107 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008108#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008110#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 ssl_tls_prf_t tls_prf,
8112 const unsigned char randbytes[64],
8113 mbedtls_ssl_protocol_version tls_version,
8114 unsigned endpoint,
8115 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008116{
8117 int ret = 0;
8118 unsigned char keyblk[256];
8119 unsigned char *key1;
8120 unsigned char *key2;
8121 unsigned char *mac_enc;
8122 unsigned char *mac_dec;
8123 size_t mac_key_len = 0;
8124 size_t iv_copy_len;
8125 size_t keylen;
8126 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008127 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008128#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008129 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008130 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008131#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008132
8133#if defined(MBEDTLS_USE_PSA_CRYPTO)
8134 psa_key_type_t key_type;
8135 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8136 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008137 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008138 size_t key_bits;
8139 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8140#endif
8141
8142#if !defined(MBEDTLS_DEBUG_C) && \
8143 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008144 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008145 ssl = NULL; /* make sure we don't use it except for these cases */
8146 (void) ssl;
8147 }
8148#endif
8149
8150 /*
8151 * Some data just needs copying into the structure
8152 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008153#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008154 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008155#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008156 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008157
8158#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008159 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008160#endif
8161
8162#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008163 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008164 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8165 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008166 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008167 }
8168#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8169
8170 /*
8171 * Get various info structures
8172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008173 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8174 if (ciphersuite_info == NULL) {
8175 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8176 ciphersuite));
8177 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008178 }
8179
Neil Armstrongab555e02022-04-04 11:07:59 +02008180 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008181#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008182 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008183#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008184 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008185
Gilles Peskine449bd832023-01-11 14:50:10 +01008186 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008187 transform->taglen =
8188 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008189 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008190
8191#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 if ((status = mbedtls_ssl_cipher_to_psa(ciphersuite_info->cipher,
8193 transform->taglen,
8194 &alg,
8195 &key_type,
8196 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008197 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008198 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008199 goto end;
8200 }
8201#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008202 cipher_info = mbedtls_cipher_info_from_type(ciphersuite_info->cipher);
8203 if (cipher_info == NULL) {
8204 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8205 ciphersuite_info->cipher));
8206 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008207 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008208#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008209
Neil Armstronge4512952022-03-08 09:08:22 +01008210#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008211 mac_alg = mbedtls_md_psa_alg_from_type(ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008212 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008213 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008214 (unsigned) ciphersuite_info->mac));
8215 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008216 }
8217#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008218 md_info = mbedtls_md_info_from_type(ciphersuite_info->mac);
8219 if (md_info == NULL) {
8220 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8221 (unsigned) ciphersuite_info->mac));
8222 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008223 }
Neil Armstronge4512952022-03-08 09:08:22 +01008224#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008225
8226#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8227 /* Copy own and peer's CID if the use of the CID
8228 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008229 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8230 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008231
8232 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8234 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8235 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008236
8237 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8239 ssl->handshake->peer_cid_len);
8240 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8241 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008242 }
8243#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8244
8245 /*
8246 * Compute key block using the PRF
8247 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8249 if (ret != 0) {
8250 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8251 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008252 }
8253
Gilles Peskine449bd832023-01-11 14:50:10 +01008254 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8255 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8256 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8257 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8258 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008259
8260 /*
8261 * Determine the appropriate key, IV and MAC length.
8262 */
8263
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008264#if defined(MBEDTLS_USE_PSA_CRYPTO)
8265 keylen = PSA_BITS_TO_BYTES(key_bits);
8266#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008268#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008269
8270#if defined(MBEDTLS_GCM_C) || \
8271 defined(MBEDTLS_CCM_C) || \
8272 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008273 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008274 size_t explicit_ivlen;
8275
8276 transform->maclen = 0;
8277 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008278
8279 /* All modes haves 96-bit IVs, but the length of the static parts vary
8280 * with mode and version:
8281 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8282 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8283 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8284 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8285 * sequence number).
8286 */
8287 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008288
8289 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008290#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008291 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008292#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008293 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8294 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008295#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008296
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008298 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008299 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008300 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008301 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008302
8303 /* Minimum length of encrypted record */
8304 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8305 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008306 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008307#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8308#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008309 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008310 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008312#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008313 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008314#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008315 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008316#endif /* MBEDTLS_USE_PSA_CRYPTO */
8317
8318#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008319 /* Get MAC length */
8320 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8321#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008322 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008323 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8324 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8325 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008326 goto end;
8327 }
8328
8329 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008330 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008331#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008332 transform->maclen = mac_key_len;
8333
8334 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008335#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008336 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008337#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008338 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008339#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008340
8341 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008342 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008343 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008344 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008345 /*
8346 * GenericBlockCipher:
8347 * 1. if EtM is in use: one block plus MAC
8348 * otherwise: * first multiple of blocklen greater than maclen
8349 * 2. IV
8350 */
8351#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008352 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008353 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 + block_size;
8355 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008356#endif
8357 {
8358 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008359 + block_size
8360 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008361 }
8362
Gilles Peskine449bd832023-01-11 14:50:10 +01008363 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008364 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008365 } else {
8366 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008367 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8368 goto end;
8369 }
8370 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008371 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008372#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8373 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008374 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8375 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008376 }
8377
Gilles Peskine449bd832023-01-11 14:50:10 +01008378 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8379 (unsigned) keylen,
8380 (unsigned) transform->minlen,
8381 (unsigned) transform->ivlen,
8382 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008383
8384 /*
8385 * Finally setup the cipher contexts, IVs and MAC secrets.
8386 */
8387#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008388 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008389 key1 = keyblk + mac_key_len * 2;
8390 key2 = keyblk + mac_key_len * 2 + keylen;
8391
8392 mac_enc = keyblk;
8393 mac_dec = keyblk + mac_key_len;
8394
Gilles Peskine449bd832023-01-11 14:50:10 +01008395 iv_copy_len = (transform->fixed_ivlen) ?
8396 transform->fixed_ivlen : transform->ivlen;
8397 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8398 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8399 iv_copy_len);
8400 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008401#endif /* MBEDTLS_SSL_CLI_C */
8402#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008403 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008404 key1 = keyblk + mac_key_len * 2 + keylen;
8405 key2 = keyblk + mac_key_len * 2;
8406
8407 mac_enc = keyblk + mac_key_len;
8408 mac_dec = keyblk;
8409
Gilles Peskine449bd832023-01-11 14:50:10 +01008410 iv_copy_len = (transform->fixed_ivlen) ?
8411 transform->fixed_ivlen : transform->ivlen;
8412 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8413 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8414 iv_copy_len);
8415 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008416#endif /* MBEDTLS_SSL_SRV_C */
8417 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008418 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008419 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8420 goto end;
8421 }
8422
Gilles Peskine449bd832023-01-11 14:50:10 +01008423 if (ssl != NULL && ssl->f_export_keys != NULL) {
8424 ssl->f_export_keys(ssl->p_export_keys,
8425 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8426 master, 48,
8427 randbytes + 32,
8428 randbytes,
8429 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008430 }
8431
8432#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008433 transform->psa_alg = alg;
8434
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8436 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8437 psa_set_key_algorithm(&attributes, alg);
8438 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008439
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 if ((status = psa_import_key(&attributes,
8441 key1,
8442 PSA_BITS_TO_BYTES(key_bits),
8443 &transform->psa_key_enc)) != PSA_SUCCESS) {
8444 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008445 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008446 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008447 goto end;
8448 }
8449
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008451
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 if ((status = psa_import_key(&attributes,
8453 key2,
8454 PSA_BITS_TO_BYTES(key_bits),
8455 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008456 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008457 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008458 goto end;
8459 }
8460 }
8461#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008462 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8463 cipher_info)) != 0) {
8464 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008465 goto end;
8466 }
8467
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8469 cipher_info)) != 0) {
8470 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008471 goto end;
8472 }
8473
Gilles Peskine449bd832023-01-11 14:50:10 +01008474 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8475 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8476 MBEDTLS_ENCRYPT)) != 0) {
8477 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008478 goto end;
8479 }
8480
Gilles Peskine449bd832023-01-11 14:50:10 +01008481 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8482 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8483 MBEDTLS_DECRYPT)) != 0) {
8484 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008485 goto end;
8486 }
8487
8488#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008489 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8490 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8491 MBEDTLS_PADDING_NONE)) != 0) {
8492 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008493 goto end;
8494 }
8495
Gilles Peskine449bd832023-01-11 14:50:10 +01008496 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8497 MBEDTLS_PADDING_NONE)) != 0) {
8498 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008499 goto end;
8500 }
8501 }
8502#endif /* MBEDTLS_CIPHER_MODE_CBC */
8503#endif /* MBEDTLS_USE_PSA_CRYPTO */
8504
Neil Armstrong29c0c042022-03-17 17:47:28 +01008505#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8506 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8507 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008508 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008509#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008511
Gilles Peskine449bd832023-01-11 14:50:10 +01008512 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8513 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8514 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008515
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 if ((status = psa_import_key(&attributes,
8517 mac_enc, mac_key_len,
8518 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008519 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008520 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008521 goto end;
8522 }
8523
Gilles Peskine449bd832023-01-11 14:50:10 +01008524 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8525 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008526#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008527 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008528#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008529 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008530 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8532 PSA_KEY_USAGE_VERIFY_HASH);
8533 } else {
8534 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8535 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008536
Gilles Peskine449bd832023-01-11 14:50:10 +01008537 if ((status = psa_import_key(&attributes,
8538 mac_dec, mac_key_len,
8539 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008540 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008541 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008542 goto end;
8543 }
8544#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008545 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8546 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008547 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008548 }
8549 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8550 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008551 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008552 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008553#endif /* MBEDTLS_USE_PSA_CRYPTO */
8554 }
8555#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8556
8557 ((void) mac_dec);
8558 ((void) mac_enc);
8559
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008560end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008561 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8562 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008563}
8564
Valerio Settia08b1a42022-11-17 15:10:02 +01008565#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8566 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008567int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 psa_pake_operation_t *pake_ctx,
8569 const unsigned char *buf,
8570 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008571{
8572 psa_status_t status;
8573 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008574 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008575 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8576 * At round two perform a single cycle
8577 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008578 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008579
Gilles Peskine449bd832023-01-11 14:50:10 +01008580 for (; remaining_steps > 0; remaining_steps--) {
8581 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008582 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008583 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008584 /* Length is stored at the first byte */
8585 size_t length = buf[input_offset];
8586 input_offset += 1;
8587
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008589 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8590 }
8591
Gilles Peskine449bd832023-01-11 14:50:10 +01008592 status = psa_pake_input(pake_ctx, step,
8593 buf + input_offset, length);
8594 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008595 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008596 }
8597
8598 input_offset += length;
8599 }
8600 }
8601
Gilles Peskine449bd832023-01-11 14:50:10 +01008602 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008603 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008605
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008607}
8608
Valerio Setti6b3dab02022-11-17 17:14:54 +01008609int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008610 psa_pake_operation_t *pake_ctx,
8611 unsigned char *buf,
8612 size_t len, size_t *olen,
8613 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008614{
8615 psa_status_t status;
8616 size_t output_offset = 0;
8617 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008618 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008619 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8620 * At round two perform a single cycle
8621 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008623
Gilles Peskine449bd832023-01-11 14:50:10 +01008624 for (; remaining_steps > 0; remaining_steps--) {
8625 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8626 step <= PSA_PAKE_STEP_ZK_PROOF;
8627 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008628 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008629 * For each step, prepend 1 byte with the length of the data as
8630 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008631 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008632 status = psa_pake_output(pake_ctx, step,
8633 buf + output_offset + 1,
8634 len - output_offset - 1,
8635 &output_len);
8636 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008637 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008638 }
8639
Valerio Setti99d88c12022-11-22 16:03:43 +01008640 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008641
8642 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008643 }
8644 }
8645
8646 *olen = output_offset;
8647
Gilles Peskine449bd832023-01-11 14:50:10 +01008648 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008649}
Valerio Settia08b1a42022-11-17 15:10:02 +01008650#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8651
Jerry Yuee40f9d2022-02-17 14:55:16 +08008652#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008653int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8654 unsigned char *hash, size_t *hashlen,
8655 unsigned char *data, size_t data_len,
8656 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008657{
8658 psa_status_t status;
8659 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008660 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008661
Gilles Peskine449bd832023-01-11 14:50:10 +01008662 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008663
Gilles Peskine449bd832023-01-11 14:50:10 +01008664 if ((status = psa_hash_setup(&hash_operation,
8665 hash_alg)) != PSA_SUCCESS) {
8666 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008667 goto exit;
8668 }
8669
Gilles Peskine449bd832023-01-11 14:50:10 +01008670 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8671 64)) != PSA_SUCCESS) {
8672 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008673 goto exit;
8674 }
8675
Gilles Peskine449bd832023-01-11 14:50:10 +01008676 if ((status = psa_hash_update(&hash_operation,
8677 data, data_len)) != PSA_SUCCESS) {
8678 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008679 goto exit;
8680 }
8681
Gilles Peskine449bd832023-01-11 14:50:10 +01008682 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8683 hashlen)) != PSA_SUCCESS) {
8684 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8685 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008686 }
8687
8688exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008689 if (status != PSA_SUCCESS) {
8690 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8691 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8692 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008693 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008694 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008695 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8696 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008698 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008700 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008701 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008702 }
8703 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008705}
8706
8707#else
8708
Gilles Peskine449bd832023-01-11 14:50:10 +01008709int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8710 unsigned char *hash, size_t *hashlen,
8711 unsigned char *data, size_t data_len,
8712 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008713{
8714 int ret = 0;
8715 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008716 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8717 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008718
Gilles Peskine449bd832023-01-11 14:50:10 +01008719 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008720
Gilles Peskine449bd832023-01-11 14:50:10 +01008721 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008722
8723 /*
8724 * digitally-signed struct {
8725 * opaque client_random[32];
8726 * opaque server_random[32];
8727 * ServerDHParams params;
8728 * };
8729 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008730 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8731 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008732 goto exit;
8733 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008734 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8735 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008736 goto exit;
8737 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008738 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8739 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008740 goto exit;
8741 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008742 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8743 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008744 goto exit;
8745 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008746 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8747 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008748 goto exit;
8749 }
8750
8751exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008752 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008753
Gilles Peskine449bd832023-01-11 14:50:10 +01008754 if (ret != 0) {
8755 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8756 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8757 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008758
Gilles Peskine449bd832023-01-11 14:50:10 +01008759 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008760}
8761#endif /* MBEDTLS_USE_PSA_CRYPTO */
8762
Jerry Yud9d91da2022-02-17 14:57:06 +08008763#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8764
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008765/* Find the preferred hash for a given signature algorithm. */
8766unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008767 mbedtls_ssl_context *ssl,
8768 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008769{
Gabor Mezei078e8032022-04-27 21:17:56 +02008770 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008771 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008772
Gilles Peskine449bd832023-01-11 14:50:10 +01008773 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8774 return MBEDTLS_SSL_HASH_NONE;
8775 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008776
Gilles Peskine449bd832023-01-11 14:50:10 +01008777 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008778 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008779 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8780 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008781 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008782 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8783 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008784
Gilles Peskine449bd832023-01-11 14:50:10 +01008785 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008786#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008787 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008788 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008789 mbedtls_md_psa_alg_from_type(hash_alg_received);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008790
Gilles Peskine449bd832023-01-11 14:50:10 +01008791 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8792 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8793 PSA_ALG_ECDSA(psa_hash_alg),
8794 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008795 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008796 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008797
Gilles Peskine449bd832023-01-11 14:50:10 +01008798 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8799 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8800 PSA_ALG_RSA_PKCS1V15_SIGN(
8801 psa_hash_alg),
8802 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008803 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008804 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008805 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008806#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008807
Gilles Peskine449bd832023-01-11 14:50:10 +01008808 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008809 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008810 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008811
Gilles Peskine449bd832023-01-11 14:50:10 +01008812 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008813}
8814
8815#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8816
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008817/* Serialization of TLS 1.2 sessions:
8818 *
8819 * struct {
8820 * uint64 start_time;
8821 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008822 * uint8 session_id_len; // at most 32
8823 * opaque session_id[32];
8824 * opaque master[48]; // fixed length in the standard
8825 * uint32 verify_result;
8826 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8827 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8828 * uint32 ticket_lifetime;
8829 * uint8 mfl_code; // up to 255 according to standard
8830 * uint8 encrypt_then_mac; // 0 or 1
8831 * } serialized_session_tls12;
8832 *
8833 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008834static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8835 unsigned char *buf,
8836 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008837{
8838 unsigned char *p = buf;
8839 size_t used = 0;
8840
8841#if defined(MBEDTLS_HAVE_TIME)
8842 uint64_t start;
8843#endif
8844#if defined(MBEDTLS_X509_CRT_PARSE_C)
8845#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8846 size_t cert_len;
8847#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8848#endif /* MBEDTLS_X509_CRT_PARSE_C */
8849
8850 /*
8851 * Time
8852 */
8853#if defined(MBEDTLS_HAVE_TIME)
8854 used += 8;
8855
Gilles Peskine449bd832023-01-11 14:50:10 +01008856 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008857 start = (uint64_t) session->start;
8858
Gilles Peskine449bd832023-01-11 14:50:10 +01008859 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008860 p += 8;
8861 }
8862#endif /* MBEDTLS_HAVE_TIME */
8863
8864 /*
8865 * Basic mandatory fields
8866 */
8867 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008868 + 1 /* id_len */
8869 + sizeof(session->id)
8870 + sizeof(session->master)
8871 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008872
Gilles Peskine449bd832023-01-11 14:50:10 +01008873 if (used <= buf_len) {
8874 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008875 p += 2;
8876
Gilles Peskine449bd832023-01-11 14:50:10 +01008877 *p++ = MBEDTLS_BYTE_0(session->id_len);
8878 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008879 p += 32;
8880
Gilles Peskine449bd832023-01-11 14:50:10 +01008881 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008882 p += 48;
8883
Gilles Peskine449bd832023-01-11 14:50:10 +01008884 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008885 p += 4;
8886 }
8887
8888 /*
8889 * Peer's end-entity certificate
8890 */
8891#if defined(MBEDTLS_X509_CRT_PARSE_C)
8892#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008893 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008894 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008895 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008896 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008897 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008898
8899 used += 3 + cert_len;
8900
Gilles Peskine449bd832023-01-11 14:50:10 +01008901 if (used <= buf_len) {
8902 *p++ = MBEDTLS_BYTE_2(cert_len);
8903 *p++ = MBEDTLS_BYTE_1(cert_len);
8904 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008905
Gilles Peskine449bd832023-01-11 14:50:10 +01008906 if (session->peer_cert != NULL) {
8907 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008908 p += cert_len;
8909 }
8910 }
8911#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008912 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008913 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008914 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008915 *p++ = (unsigned char) session->peer_cert_digest_type;
8916 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008917 memcpy(p, session->peer_cert_digest,
8918 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008919 p += session->peer_cert_digest_len;
8920 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008921 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008922 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008923 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008924 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8925 *p++ = 0;
8926 }
8927 }
8928#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8929#endif /* MBEDTLS_X509_CRT_PARSE_C */
8930
8931 /*
8932 * Session ticket if any, plus associated data
8933 */
8934#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8935 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8936
Gilles Peskine449bd832023-01-11 14:50:10 +01008937 if (used <= buf_len) {
8938 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
8939 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
8940 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008941
Gilles Peskine449bd832023-01-11 14:50:10 +01008942 if (session->ticket != NULL) {
8943 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008944 p += session->ticket_len;
8945 }
8946
Gilles Peskine449bd832023-01-11 14:50:10 +01008947 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008948 p += 4;
8949 }
8950#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8951
8952 /*
8953 * Misc extension-related info
8954 */
8955#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8956 used += 1;
8957
Gilles Peskine449bd832023-01-11 14:50:10 +01008958 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008959 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01008960 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008961#endif
8962
8963#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8964 used += 1;
8965
Gilles Peskine449bd832023-01-11 14:50:10 +01008966 if (used <= buf_len) {
8967 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
8968 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008969#endif
8970
Gilles Peskine449bd832023-01-11 14:50:10 +01008971 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008972}
8973
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008974MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008975static int ssl_tls12_session_load(mbedtls_ssl_session *session,
8976 const unsigned char *buf,
8977 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008978{
8979#if defined(MBEDTLS_HAVE_TIME)
8980 uint64_t start;
8981#endif
8982#if defined(MBEDTLS_X509_CRT_PARSE_C)
8983#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8984 size_t cert_len;
8985#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8986#endif /* MBEDTLS_X509_CRT_PARSE_C */
8987
8988 const unsigned char *p = buf;
8989 const unsigned char * const end = buf + len;
8990
8991 /*
8992 * Time
8993 */
8994#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01008995 if (8 > (size_t) (end - p)) {
8996 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8997 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008998
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01008999 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009000 p += 8;
9001
9002 session->start = (time_t) start;
9003#endif /* MBEDTLS_HAVE_TIME */
9004
9005 /*
9006 * Basic mandatory fields
9007 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009008 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9009 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9010 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009011
Gilles Peskine449bd832023-01-11 14:50:10 +01009012 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009013 p += 2;
9014
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009015 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009016 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009017 p += 32;
9018
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009020 p += 48;
9021
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009022 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009023 p += 4;
9024
9025 /* Immediately clear invalid pointer values that have been read, in case
9026 * we exit early before we replaced them with valid ones. */
9027#if defined(MBEDTLS_X509_CRT_PARSE_C)
9028#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9029 session->peer_cert = NULL;
9030#else
9031 session->peer_cert_digest = NULL;
9032#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9033#endif /* MBEDTLS_X509_CRT_PARSE_C */
9034#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9035 session->ticket = NULL;
9036#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9037
9038 /*
9039 * Peer certificate
9040 */
9041#if defined(MBEDTLS_X509_CRT_PARSE_C)
9042#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9043 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009044 if (3 > (size_t) (end - p)) {
9045 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9046 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009047
Gilles Peskine449bd832023-01-11 14:50:10 +01009048 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009049 p += 3;
9050
Gilles Peskine449bd832023-01-11 14:50:10 +01009051 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009052 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9053
Gilles Peskine449bd832023-01-11 14:50:10 +01009054 if (cert_len > (size_t) (end - p)) {
9055 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9056 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009057
Gilles Peskine449bd832023-01-11 14:50:10 +01009058 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009059
Gilles Peskine449bd832023-01-11 14:50:10 +01009060 if (session->peer_cert == NULL) {
9061 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9062 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009063
Gilles Peskine449bd832023-01-11 14:50:10 +01009064 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009065
Gilles Peskine449bd832023-01-11 14:50:10 +01009066 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9067 p, cert_len)) != 0) {
9068 mbedtls_x509_crt_free(session->peer_cert);
9069 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009070 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009071 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009072 }
9073
9074 p += cert_len;
9075 }
9076#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9077 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009078 if (2 > (size_t) (end - p)) {
9079 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9080 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009081
9082 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9083 session->peer_cert_digest_len = (size_t) *p++;
9084
Gilles Peskine449bd832023-01-11 14:50:10 +01009085 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009086 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009087 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9088 if (md_info == NULL) {
9089 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9090 }
9091 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9092 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9093 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009094
Gilles Peskine449bd832023-01-11 14:50:10 +01009095 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9097 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009098
9099 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009100 mbedtls_calloc(1, session->peer_cert_digest_len);
9101 if (session->peer_cert_digest == NULL) {
9102 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9103 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009104
Gilles Peskine449bd832023-01-11 14:50:10 +01009105 memcpy(session->peer_cert_digest, p,
9106 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009107 p += session->peer_cert_digest_len;
9108 }
9109#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9110#endif /* MBEDTLS_X509_CRT_PARSE_C */
9111
9112 /*
9113 * Session ticket and associated data
9114 */
9115#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009116 if (3 > (size_t) (end - p)) {
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 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009121 p += 3;
9122
Gilles Peskine449bd832023-01-11 14:50:10 +01009123 if (session->ticket_len != 0) {
9124 if (session->ticket_len > (size_t) (end - p)) {
9125 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9126 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009127
Gilles Peskine449bd832023-01-11 14:50:10 +01009128 session->ticket = mbedtls_calloc(1, session->ticket_len);
9129 if (session->ticket == NULL) {
9130 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9131 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009132
Gilles Peskine449bd832023-01-11 14:50:10 +01009133 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009134 p += session->ticket_len;
9135 }
9136
Gilles Peskine449bd832023-01-11 14:50:10 +01009137 if (4 > (size_t) (end - p)) {
9138 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9139 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009140
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009141 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009142 p += 4;
9143#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9144
9145 /*
9146 * Misc extension-related info
9147 */
9148#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009149 if (1 > (size_t) (end - p)) {
9150 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9151 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009152
9153 session->mfl_code = *p++;
9154#endif
9155
9156#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009157 if (1 > (size_t) (end - p)) {
9158 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9159 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009160
9161 session->encrypt_then_mac = *p++;
9162#endif
9163
9164 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009165 if (p != end) {
9166 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9167 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009168
Gilles Peskine449bd832023-01-11 14:50:10 +01009169 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009170}
Jerry Yudc7bd172022-02-17 13:44:15 +08009171#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9172
XiaokangQian75d40ef2022-04-20 11:05:24 +00009173int mbedtls_ssl_validate_ciphersuite(
9174 const mbedtls_ssl_context *ssl,
9175 const mbedtls_ssl_ciphersuite_t *suite_info,
9176 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009178{
9179 (void) ssl;
9180
Gilles Peskine449bd832023-01-11 14:50:10 +01009181 if (suite_info == NULL) {
9182 return -1;
9183 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009184
Gilles Peskine449bd832023-01-11 14:50:10 +01009185 if ((suite_info->min_tls_version > max_tls_version) ||
9186 (suite_info->max_tls_version < min_tls_version)) {
9187 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009188 }
9189
XiaokangQian060d8672022-04-21 09:24:56 +00009190#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009191#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009192#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009193 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9194 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009195#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009196 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9197 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009198#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009199 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009200 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009201 }
9202#endif
9203
9204 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9205#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009206 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9207 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9208 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009209 }
9210#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9211#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9212
Gilles Peskine449bd832023-01-11 14:50:10 +01009213 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009214}
9215
Ronald Crone68ab4f2022-10-05 12:46:29 +02009216#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009217/*
9218 * Function for writing a signature algorithm extension.
9219 *
9220 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9221 * value (TLS 1.3 RFC8446):
9222 * enum {
9223 * ....
9224 * ecdsa_secp256r1_sha256( 0x0403 ),
9225 * ecdsa_secp384r1_sha384( 0x0503 ),
9226 * ecdsa_secp521r1_sha512( 0x0603 ),
9227 * ....
9228 * } SignatureScheme;
9229 *
9230 * struct {
9231 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9232 * } SignatureSchemeList;
9233 *
9234 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9235 * value (TLS 1.2 RFC5246):
9236 * enum {
9237 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9238 * sha512(6), (255)
9239 * } HashAlgorithm;
9240 *
9241 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9242 * SignatureAlgorithm;
9243 *
9244 * struct {
9245 * HashAlgorithm hash;
9246 * SignatureAlgorithm signature;
9247 * } SignatureAndHashAlgorithm;
9248 *
9249 * SignatureAndHashAlgorithm
9250 * supported_signature_algorithms<2..2^16-2>;
9251 *
9252 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9253 * generalization of the TLS 1.2 signature algorithm extension.
9254 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9255 * `SignatureScheme` field of TLS 1.3
9256 *
9257 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009258int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9259 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009260{
9261 unsigned char *p = buf;
9262 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9263 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9264
9265 *out_len = 0;
9266
Gilles Peskine449bd832023-01-11 14:50:10 +01009267 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009268
9269 /* Check if we have space for header and length field:
9270 * - extension_type (2 bytes)
9271 * - extension_data_length (2 bytes)
9272 * - supported_signature_algorithms_length (2 bytes)
9273 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009274 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009275 p += 6;
9276
9277 /*
9278 * Write supported_signature_algorithms
9279 */
9280 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009281 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9282 if (sig_alg == NULL) {
9283 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9284 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009285
Gilles Peskine449bd832023-01-11 14:50:10 +01009286 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9287 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9288 *sig_alg,
9289 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9290 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009291 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009292 }
9293 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9294 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009295 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009296 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9297 *sig_alg,
9298 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009299 }
9300
9301 /* Length of supported_signature_algorithms */
9302 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009303 if (supported_sig_alg_len == 0) {
9304 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9305 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009306 }
9307
Gilles Peskine449bd832023-01-11 14:50:10 +01009308 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9309 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9310 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009311
XiaokangQianeaf36512022-04-24 09:07:44 +00009312 *out_len = p - buf;
9313
9314#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009315 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009316#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009317
Gilles Peskine449bd832023-01-11 14:50:10 +01009318 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009319}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009320#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009321
XiaokangQian40a35232022-05-07 09:02:40 +00009322#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009323/*
9324 * mbedtls_ssl_parse_server_name_ext
9325 *
9326 * Structure of server_name extension:
9327 *
9328 * enum {
9329 * host_name(0), (255)
9330 * } NameType;
9331 * opaque HostName<1..2^16-1>;
9332 *
9333 * struct {
9334 * NameType name_type;
9335 * select (name_type) {
9336 * case host_name: HostName;
9337 * } name;
9338 * } ServerName;
9339 * struct {
9340 * ServerName server_name_list<1..2^16-1>
9341 * } ServerNameList;
9342 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009343MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009344int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9345 const unsigned char *buf,
9346 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009347{
9348 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9349 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009350 size_t server_name_list_len, hostname_len;
9351 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009352
Gilles Peskine449bd832023-01-11 14:50:10 +01009353 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009354
Gilles Peskine449bd832023-01-11 14:50:10 +01009355 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9356 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009357 p += 2;
9358
Gilles Peskine449bd832023-01-11 14:50:10 +01009359 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009360 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009361 while (p < server_name_list_end) {
9362 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9363 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9364 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9365 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009366
Gilles Peskine449bd832023-01-11 14:50:10 +01009367 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009368 /* sni_name is intended to be used only during the parsing of the
9369 * ClientHello message (it is reset to NULL before the end of
9370 * the message parsing). Thus it is ok to just point to the
9371 * reception buffer and not make a copy of it.
9372 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009373 ssl->handshake->sni_name = p + 3;
9374 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009375 if (ssl->conf->f_sni == NULL) {
9376 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009377 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009378 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9379 ssl, p + 3, hostname_len);
9380 if (ret != 0) {
9381 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9382 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9383 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9384 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9385 }
9386 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009387 }
9388
9389 p += hostname_len + 3;
9390 }
9391
Gilles Peskine449bd832023-01-11 14:50:10 +01009392 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009393}
9394#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9395
XiaokangQianacb39922022-06-17 10:18:48 +00009396#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009397MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009398int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9399 const unsigned char *buf,
9400 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009401{
9402 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009403 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009404 const unsigned char *protocol_name_list;
9405 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009406 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009407
9408 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009409 if (ssl->conf->alpn_list == NULL) {
9410 return 0;
9411 }
XiaokangQianacb39922022-06-17 10:18:48 +00009412
9413 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009414 * RFC7301, section 3.1
9415 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009416 *
XiaokangQianc7403452022-06-23 03:24:12 +00009417 * struct {
9418 * ProtocolName protocol_name_list<2..2^16-1>
9419 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009420 */
9421
XiaokangQianc7403452022-06-23 03:24:12 +00009422 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009423 * protocol_name_list_len 2 bytes
9424 * protocol_name_len 1 bytes
9425 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009426 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009427 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009428
Gilles Peskine449bd832023-01-11 14:50:10 +01009429 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009430 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009431 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009432 protocol_name_list = p;
9433 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009434
9435 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009436 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009437 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009438 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9439 protocol_name_len);
9440 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009441 MBEDTLS_SSL_PEND_FATAL_ALERT(
9442 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009443 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9444 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009445 }
9446
9447 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009448 }
9449
9450 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009451 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9452 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009453 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009454 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009455 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009456 if (protocol_name_len == alpn_len &&
9457 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009458 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009459 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009460 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009461
9462 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009463 }
9464 }
9465
XiaokangQian95d5f542022-06-24 02:29:26 +00009466 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009467 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009468 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9469 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9470 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009471}
9472
Gilles Peskine449bd832023-01-11 14:50:10 +01009473int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9474 unsigned char *buf,
9475 unsigned char *end,
9476 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009477{
9478 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009479 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009480 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009481
Gilles Peskine449bd832023-01-11 14:50:10 +01009482 if (ssl->alpn_chosen == NULL) {
9483 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009484 }
9485
Gilles Peskine449bd832023-01-11 14:50:10 +01009486 protocol_name_len = strlen(ssl->alpn_chosen);
9487 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009488
Gilles Peskine449bd832023-01-11 14:50:10 +01009489 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009490 /*
9491 * 0 . 1 ext identifier
9492 * 2 . 3 ext length
9493 * 4 . 5 protocol list length
9494 * 6 . 6 protocol name length
9495 * 7 . 7+n protocol name
9496 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009497 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009498
XiaokangQian95d5f542022-06-24 02:29:26 +00009499 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009500
Gilles Peskine449bd832023-01-11 14:50:10 +01009501 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9502 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009503 /* Note: the length of the chosen protocol has been checked to be less
9504 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9505 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009506 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009507
Gilles Peskine449bd832023-01-11 14:50:10 +01009508 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009509
9510#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009511 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009512#endif
9513
Gilles Peskine449bd832023-01-11 14:50:10 +01009514 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009515}
9516#endif /* MBEDTLS_SSL_ALPN */
9517
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009518#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009519 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009520 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009521 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009522int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9523 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009524{
9525 /* Initialize to suppress unnecessary compiler warning */
9526 size_t hostname_len = 0;
9527
9528 /* Check if new hostname is valid before
9529 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009530 if (hostname != NULL) {
9531 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009532
Gilles Peskine449bd832023-01-11 14:50:10 +01009533 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9534 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9535 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009536 }
9537
9538 /* Now it's clear that we will overwrite the old hostname,
9539 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009540 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009541 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009542 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009543 }
9544
9545 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009546 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009547 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009548 } else {
9549 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9550 if (session->hostname == NULL) {
9551 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9552 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009553
Gilles Peskine449bd832023-01-11 14:50:10 +01009554 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009555 }
9556
Gilles Peskine449bd832023-01-11 14:50:10 +01009557 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009558}
Xiaokang Qian03409292022-10-12 02:49:52 +00009559#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9560 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009561 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009562 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009564#endif /* MBEDTLS_SSL_TLS_C */