blob: 2c88da59b3228148e00e01812639605cc3b1f299 [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
Valerio Setti7aeec542023-07-05 18:57:21 +0200989#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200990 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200992#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200993#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200994#if defined(MBEDTLS_USE_PSA_CRYPTO)
995 handshake->psa_pake_ctx = psa_pake_operation_init();
996 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
997#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200999#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02001000#if defined(MBEDTLS_SSL_CLI_C)
1001 handshake->ecjpake_cache = NULL;
1002 handshake->ecjpake_cache_len = 0;
1003#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001004#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001005
Gilles Peskineeccd8882020-03-10 12:19:08 +01001006#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001008#endif
1009
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001010#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1011 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1012#endif
Hanno Becker75173122019-02-06 16:18:31 +00001013
1014#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1015 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001017#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001018}
1019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001021{
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001023
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001024#if defined(MBEDTLS_USE_PSA_CRYPTO)
1025 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1026 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001027#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1029 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001030#endif
1031
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001032#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001033#if defined(MBEDTLS_USE_PSA_CRYPTO)
1034 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1035 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001036#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 mbedtls_md_init(&transform->md_ctx_enc);
1038 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001039#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001040#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041}
1042
Gilles Peskine449bd832023-01-11 14:50:10 +01001043void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001044{
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001046}
1047
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001048MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001049static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001050{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1052
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (ssl->transform_negotiate) {
1056 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1057 }
Jerry Yu2e199812022-12-01 18:57:19 +08001058#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->session_negotiate) {
1060 mbedtls_ssl_session_free(ssl->session_negotiate);
1061 }
1062 if (ssl->handshake) {
1063 mbedtls_ssl_handshake_free(ssl);
1064 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001065
Jerry Yu2e199812022-12-01 18:57:19 +08001066#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001067 /*
1068 * Either the pointers are now NULL or cleared properly and can be freed.
1069 * Now allocate missing structures.
1070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 if (ssl->transform_negotiate == NULL) {
1072 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001073 }
Jerry Yu2e199812022-12-01 18:57:19 +08001074#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001075
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (ssl->session_negotiate == NULL) {
1077 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001078 }
Paul Bakker48916f92012-09-16 19:57:18 +00001079
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 if (ssl->handshake == NULL) {
1081 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001082 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001083#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1084 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1087 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001088#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001089
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001090 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001092#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001093 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001094#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 ssl->session_negotiate == NULL) {
1096 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001097
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001099 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001100
1101#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001103 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001104#endif
1105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001107 ssl->session_negotiate = NULL;
1108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001110 }
1111
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001112 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001113 mbedtls_ssl_session_init(ssl->session_negotiate);
1114 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001115
Jerry Yu2e199812022-12-01 18:57:19 +08001116#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001118#endif
1119
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001120 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001121 ret = mbedtls_ssl_reset_checksum(ssl);
1122 if (ret != 0) {
1123 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1124 return ret;
1125 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001126
Jerry Yud0766ec2022-09-22 10:46:57 +08001127#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1128 defined(MBEDTLS_SSL_SRV_C) && \
1129 defined(MBEDTLS_SSL_SESSION_TICKETS)
1130 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001132#endif
1133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001136 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001137
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001139 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001141 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001143
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001145 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001146#endif
1147
Brett Warrene0edc842021-08-17 09:53:13 +01001148/*
1149 * curve_list is translated to IANA TLS group identifiers here because
1150 * mbedtls_ssl_conf_curves returns void and so can't return
1151 * any error codes.
1152 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001153#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001154#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1155 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001157 size_t length;
1158 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1159
Thomas Daubney850a0792023-05-22 12:05:03 +01001160 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 }
Brett Warrene0edc842021-08-17 09:53:13 +01001162
1163 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1165 if (group_list == NULL) {
1166 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1167 }
Brett Warrene0edc842021-08-17 09:53:13 +01001168
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001170 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 curve_list[i]);
1172 if (tls_id == 0) {
1173 mbedtls_free(group_list);
1174 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001175 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001176 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001177 }
1178
1179 group_list[length] = 0;
1180
1181 ssl->handshake->group_list = group_list;
1182 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001184 ssl->handshake->group_list = ssl->conf->group_list;
1185 ssl->handshake->group_list_heap_allocated = 0;
1186 }
1187#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001188#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001189
Ronald Crone68ab4f2022-10-05 12:46:29 +02001190#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001191#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001192#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001193 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1194 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1196 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001197 const int *md;
1198 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001199 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001200 uint16_t *p;
1201
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001202 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1203 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1204 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001205
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1207 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001208 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001210#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001212#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001213
Jerry Yub476a442022-01-21 18:14:45 +08001214#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001216#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1218 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1219 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001220 }
1221
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1223 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1224 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1227 sizeof(uint16_t));
1228 if (ssl->handshake->sig_algs == NULL) {
1229 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1230 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 p = (uint16_t *) ssl->handshake->sig_algs;
1233 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1234 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1235 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001236 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001238#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001239 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001241#endif
1242#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001244 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001245#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001247 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001248 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001250#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001251 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001252 ssl->handshake->sig_algs_heap_allocated = 0;
1253 }
Jerry Yucc539102022-06-27 16:27:35 +08001254#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001255#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001256 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001257}
1258
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001259#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001260/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001261MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001262static int ssl_cookie_write_dummy(void *ctx,
1263 unsigned char **p, unsigned char *end,
1264 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001265{
1266 ((void) ctx);
1267 ((void) p);
1268 ((void) end);
1269 ((void) cli_id);
1270 ((void) cli_id_len);
1271
Gilles Peskine449bd832023-01-11 14:50:10 +01001272 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001273}
1274
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001275MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001276static int ssl_cookie_check_dummy(void *ctx,
1277 const unsigned char *cookie, size_t cookie_len,
1278 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001279{
1280 ((void) ctx);
1281 ((void) cookie);
1282 ((void) cookie_len);
1283 ((void) cli_id);
1284 ((void) cli_id_len);
1285
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001287}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001288#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001289
Paul Bakker5121ce52009-01-03 21:22:43 +00001290/*
1291 * Initialize an SSL context
1292 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001293void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001294{
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001296}
1297
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001298MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001299static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001300{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001301 const mbedtls_ssl_config *conf = ssl->conf;
1302
Ronald Cron6f135e12021-12-08 16:57:54 +01001303#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1305 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1306 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1307 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001308 }
1309
Gilles Peskine449bd832023-01-11 14:50:10 +01001310 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1311 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001312 }
1313#endif
1314
1315#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1317 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1318 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001319 }
1320#endif
1321
Ronald Cron6f135e12021-12-08 16:57:54 +01001322#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1324 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1325 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1326 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001327 }
1328
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1330 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001331 }
1332#endif
1333
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1335 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001336}
1337
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001338MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001339static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1340{
1341 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 ret = ssl_conf_version_check(ssl);
1343 if (ret != 0) {
1344 return ret;
1345 }
Jerry Yu60835a82021-08-04 10:13:52 +08001346
Jerry Yudef7ae42022-10-30 14:13:19 +08001347#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1348 /* RFC 8446 section 4.4.3
1349 *
1350 * If the verification fails, the receiver MUST terminate the handshake with
1351 * a "decrypt_error" alert.
1352 *
1353 * If the client is configured as TLS 1.3 only with optional verify, return
1354 * bad config.
1355 *
1356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1358 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001359 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1360 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1361 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001363 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 1, ("Optional verify auth mode "
1365 "is not available for TLS 1.3 client"));
1366 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001367 }
1368#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1369
Jerry Yu60835a82021-08-04 10:13:52 +08001370 /* Space for further checks */
1371
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001373}
1374
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001375/*
1376 * Setup an SSL context
1377 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001378
Gilles Peskine449bd832023-01-11 14:50:10 +01001379int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1380 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001381{
Janos Follath865b3eb2019-12-16 11:46:15 +00001382 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001383 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1384 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001385
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001386 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001387
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 if ((ret = ssl_conf_check(ssl)) != 0) {
1389 return ret;
1390 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001391 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001392
Paul Bakker62f2dee2012-09-28 07:31:51 +00001393 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001394 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001395 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001396
1397 /* Set to NULL in case of an error condition */
1398 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001399
Darryl Greenb33cc762019-11-28 14:29:44 +00001400#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1401 ssl->in_buf_len = in_buf_len;
1402#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1404 if (ssl->in_buf == NULL) {
1405 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001406 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001407 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001408 }
1409
Darryl Greenb33cc762019-11-28 14:29:44 +00001410#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1411 ssl->out_buf_len = out_buf_len;
1412#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1414 if (ssl->out_buf == NULL) {
1415 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001416 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001417 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001418 }
1419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001421
Johan Pascalb62bb512015-12-03 21:56:45 +01001422#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001424#endif
1425
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001427 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001431
1432error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 mbedtls_free(ssl->in_buf);
1434 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001435
1436 ssl->conf = NULL;
1437
Darryl Greenb33cc762019-11-28 14:29:44 +00001438#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1439 ssl->in_buf_len = 0;
1440 ssl->out_buf_len = 0;
1441#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001442 ssl->in_buf = NULL;
1443 ssl->out_buf = NULL;
1444
1445 ssl->in_hdr = NULL;
1446 ssl->in_ctr = NULL;
1447 ssl->in_len = NULL;
1448 ssl->in_iv = NULL;
1449 ssl->in_msg = NULL;
1450
1451 ssl->out_hdr = NULL;
1452 ssl->out_ctr = NULL;
1453 ssl->out_len = NULL;
1454 ssl->out_iv = NULL;
1455 ssl->out_msg = NULL;
1456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001458}
1459
1460/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001461 * Reset an initialized and used SSL context for re-use while retaining
1462 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001463 *
1464 * If partial is non-zero, keep data in the input buffer and client ID.
1465 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001466 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001467void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1468 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001469{
Darryl Greenb33cc762019-11-28 14:29:44 +00001470#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1471 size_t in_buf_len = ssl->in_buf_len;
1472 size_t out_buf_len = ssl->out_buf_len;
1473#else
1474 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1475 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1476#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001477
Hanno Beckerb0302c42021-08-03 09:39:42 +01001478#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1479 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001480#endif
1481
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001482 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001484
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001486
1487 /* Reset incoming message parsing */
1488 ssl->in_offt = NULL;
1489 ssl->nb_zero = 0;
1490 ssl->in_msgtype = 0;
1491 ssl->in_msglen = 0;
1492 ssl->in_hslen = 0;
1493 ssl->keep_current_message = 0;
1494 ssl->transform_in = NULL;
1495
1496#if defined(MBEDTLS_SSL_PROTO_DTLS)
1497 ssl->next_record_offset = 0;
1498 ssl->in_epoch = 0;
1499#endif
1500
1501 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001505 }
1506
Ronald Cronad8c17b2022-06-10 17:18:09 +02001507 ssl->send_alert = 0;
1508
Hanno Beckerb0302c42021-08-03 09:39:42 +01001509 /* Reset outgoing message writing */
1510 ssl->out_msgtype = 0;
1511 ssl->out_msglen = 0;
1512 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 memset(ssl->out_buf, 0, out_buf_len);
1514 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001515 ssl->transform_out = NULL;
1516
1517#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001519#endif
1520
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 if (ssl->transform) {
1523 mbedtls_ssl_transform_free(ssl->transform);
1524 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001525 ssl->transform = NULL;
1526 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001527#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1528
XiaokangQian2b01dc32022-01-21 02:53:13 +00001529#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 mbedtls_ssl_transform_free(ssl->transform_application);
1531 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532 ssl->transform_application = NULL;
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001535#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1537 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001538 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001539#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1542 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001543 ssl->handshake->transform_handshake = NULL;
1544 }
1545
XiaokangQian2b01dc32022-01-21 02:53:13 +00001546#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001547}
1548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001550{
1551 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1552
1553 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1554
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001556
1557 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558#if defined(MBEDTLS_SSL_RENEGOTIATION)
1559 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001560 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001561
1562 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1564 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001565#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001567
Hanno Beckerb0302c42021-08-03 09:39:42 +01001568 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001569 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 if (ssl->session) {
1571 mbedtls_ssl_session_free(ssl->session);
1572 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001573 ssl->session = NULL;
1574 }
1575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001577 ssl->alpn_chosen = NULL;
1578#endif
1579
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001580#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001581 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001582#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001584#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 if (free_cli_id) {
1586 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001587 ssl->cli_id = NULL;
1588 ssl->cli_id_len = 0;
1589 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001590#endif
1591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 if ((ret = ssl_handshake_init(ssl)) != 0) {
1593 return ret;
1594 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001597}
1598
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001599/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001600 * Reset an initialized and used SSL context for re-use while retaining
1601 * all application-set variables, function pointers and data.
1602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001603int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001604{
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001606}
1607
1608/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001609 * SSL set accessors
1610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001611void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001612{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001613 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001614}
1615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001619}
1620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001622void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001623{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001624 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001625}
1626#endif
1627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001629{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001630 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001631}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001633#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001634
Gilles Peskine449bd832023-01-11 14:50:10 +01001635void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1636 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001637{
1638 ssl->disable_datagram_packing = !allow_packing;
1639}
1640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1642 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001643{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001644 conf->hs_timeout_min = min;
1645 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001646}
1647#endif
1648
Gilles Peskine449bd832023-01-11 14:50:10 +01001649void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001650{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001651 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001652}
1653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001655void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1656 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1657 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001658{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001659 conf->f_vrfy = f_vrfy;
1660 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001661}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001663
Gilles Peskine449bd832023-01-11 14:50:10 +01001664void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1665 int (*f_rng)(void *, unsigned char *, size_t),
1666 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001667{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001668 conf->f_rng = f_rng;
1669 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001670}
1671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1673 void (*f_dbg)(void *, int, const char *, int, const char *),
1674 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001675{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001676 conf->f_dbg = f_dbg;
1677 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001678}
1679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1681 void *p_bio,
1682 mbedtls_ssl_send_t *f_send,
1683 mbedtls_ssl_recv_t *f_recv,
1684 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001685{
1686 ssl->p_bio = p_bio;
1687 ssl->f_send = f_send;
1688 ssl->f_recv = f_recv;
1689 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001690}
1691
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001692#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001693void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001694{
1695 ssl->mtu = mtu;
1696}
1697#endif
1698
Gilles Peskine449bd832023-01-11 14:50:10 +01001699void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001700{
1701 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001702}
1703
Gilles Peskine449bd832023-01-11 14:50:10 +01001704void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1705 void *p_timer,
1706 mbedtls_ssl_set_timer_t *f_set_timer,
1707 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001708{
1709 ssl->p_timer = p_timer;
1710 ssl->f_set_timer = f_set_timer;
1711 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001712
1713 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001715}
1716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001718void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1719 void *p_cache,
1720 mbedtls_ssl_cache_get_t *f_get_cache,
1721 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001722{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001723 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001724 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001725 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001726}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001730int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001731{
Janos Follath865b3eb2019-12-16 11:46:15 +00001732 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001735 session == NULL ||
1736 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1738 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001739 }
1740
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 if (ssl->handshake->resume == 1) {
1742 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1743 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001744
Jerry Yu21092062022-10-10 21:21:31 +08001745#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001747 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001751 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1753 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1754 session->ciphersuite));
1755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001756 }
Jerry Yu40afab62022-10-08 10:42:13 +08001757 }
Jerry Yu21092062022-10-10 21:21:31 +08001758#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1761 session)) != 0) {
1762 return ret;
1763 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001764
Paul Bakker0a597072012-09-25 21:55:46 +00001765 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001768}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1772 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001773{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001774 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001775}
1776
Ronald Cron6f135e12021-12-08 16:57:54 +01001777#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001778void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1779 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001780{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001781 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001782}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001783
1784#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001785void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
1786 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787{
1788 conf->early_data_enabled = early_data_enabled;
1789}
Jerry Yucc4e0072022-11-22 17:22:22 +08001790
1791#if defined(MBEDTLS_SSL_SRV_C)
1792void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001794{
Jerry Yu39da9852022-12-06 16:58:36 +08001795 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001796}
1797#endif /* MBEDTLS_SSL_SRV_C */
1798
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001799#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001800#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001803void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1804 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001805{
1806 conf->cert_profile = profile;
1807}
1808
Gilles Peskine449bd832023-01-11 14:50:10 +01001809static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001810{
1811 mbedtls_ssl_key_cert *cur = key_cert, *next;
1812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001814 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001816 cur = next;
1817 }
1818}
1819
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001820/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001821MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001822static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1823 mbedtls_x509_crt *cert,
1824 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001825{
niisato8ee24222018-06-25 19:05:48 +09001826 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001829 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001831 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001833 }
1834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1836 if (new_cert == NULL) {
1837 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1838 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001839
niisato8ee24222018-06-25 19:05:48 +09001840 new_cert->cert = cert;
1841 new_cert->key = key;
1842 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001843
Glenn Strauss36872db2022-01-22 05:06:31 -05001844 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001846 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001848 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 }
niisato8ee24222018-06-25 19:05:48 +09001852 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001853 }
1854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001856}
1857
Gilles Peskine449bd832023-01-11 14:50:10 +01001858int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001859 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001861{
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001863}
1864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001866 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001868{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001869 conf->ca_chain = ca_chain;
1870 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001871
1872#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1873 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1874 * cannot be used together. */
1875 conf->f_ca_cb = NULL;
1876 conf->p_ca_cb = NULL;
1877#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001878}
Hanno Becker5adaad92019-03-27 16:54:37 +00001879
1880#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001881void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1882 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1883 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001884{
1885 conf->f_ca_cb = f_ca_cb;
1886 conf->p_ca_cb = p_ca_cb;
1887
1888 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1889 * cannot be used together. */
1890 conf->ca_chain = NULL;
1891 conf->ca_crl = NULL;
1892}
1893#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001895
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001896#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001897const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1898 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001899{
1900 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001902}
1903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1905 mbedtls_x509_crt *own_cert,
1906 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001907{
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1909 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001910}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1913 mbedtls_x509_crt *ca_chain,
1914 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001915{
1916 ssl->handshake->sni_ca_chain = ca_chain;
1917 ssl->handshake->sni_ca_crl = ca_crl;
1918}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001919
Glenn Strauss999ef702022-03-11 01:37:23 -05001920#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001921void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1922 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001923{
1924 ssl->handshake->dn_hints = crt;
1925}
1926#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1927
Gilles Peskine449bd832023-01-11 14:50:10 +01001928void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1929 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001930{
1931 ssl->handshake->sni_authmode = authmode;
1932}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001933#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1934
Hanno Becker8927c832019-04-03 12:52:50 +01001935#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001936void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1937 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1938 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001939{
1940 ssl->f_vrfy = f_vrfy;
1941 ssl->p_vrfy = p_vrfy;
1942}
1943#endif
1944
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001945#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001946
Valerio Setti016f6822022-12-09 14:17:50 +01001947#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001948static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1949static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1950
Valerio Setti016f6822022-12-09 14:17:50 +01001951static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 mbedtls_ssl_context *ssl,
1953 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001954{
1955 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001956 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001957 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001958 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001959 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001960 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1962 psa_pake_cs_set_primitive(&cipher_suite,
1963 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1964 PSA_ECC_FAMILY_SECP_R1,
1965 256));
1966 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1969 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001970 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001972
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001974 user = jpake_server_id;
1975 user_len = sizeof(jpake_server_id);
1976 peer = jpake_client_id;
1977 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001979 user = jpake_client_id;
1980 user_len = sizeof(jpake_client_id);
1981 peer = jpake_server_id;
1982 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001984
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001985 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1986 if (status != PSA_SUCCESS) {
1987 return status;
1988 }
1989
1990 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001992 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 }
Valerio Setti016f6822022-12-09 14:17:50 +01001994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1996 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001997 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 }
Valerio Setti016f6822022-12-09 14:17:50 +01001999
2000 ssl->handshake->psa_pake_ctx_is_ok = 1;
2001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002003}
2004
Gilles Peskine449bd832023-01-11 14:50:10 +01002005int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2006 const unsigned char *pw,
2007 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002008{
2009 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2010 psa_status_t status;
2011
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 if (ssl->handshake == NULL || ssl->conf == NULL) {
2013 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002014 }
2015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 /* Empty password is not valid */
2017 if ((pw == NULL) || (pw_len == 0)) {
2018 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2019 }
2020
2021 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2022 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2023 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2024
2025 status = psa_import_key(&attributes, pw, pw_len,
2026 &ssl->handshake->psa_pake_password);
2027 if (status != PSA_SUCCESS) {
2028 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2029 }
2030
2031 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2032 ssl->handshake->psa_pake_password);
2033 if (status != PSA_SUCCESS) {
2034 psa_destroy_key(ssl->handshake->psa_pake_password);
2035 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2036 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2037 }
2038
2039 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002040}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2043 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002044{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002045 psa_status_t status;
2046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 if (ssl->handshake == NULL || ssl->conf == NULL) {
2048 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002049 }
2050
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 if (mbedtls_svc_key_id_is_null(pwd)) {
2052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2053 }
2054
2055 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2056 if (status != PSA_SUCCESS) {
2057 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2058 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2059 }
2060
2061 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002062}
2063#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002064int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2065 const unsigned char *pw,
2066 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002067{
2068 mbedtls_ecjpake_role role;
2069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 if (ssl->handshake == NULL || ssl->conf == NULL) {
2071 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2072 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002073
Valerio Settic689ed82022-12-07 14:40:38 +01002074 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 if ((pw == NULL) || (pw_len == 0)) {
2076 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2077 }
Valerio Settic689ed82022-12-07 14:40:38 +01002078
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002080 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002082 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2086 role,
2087 MBEDTLS_MD_SHA256,
2088 MBEDTLS_ECP_DP_SECP256R1,
2089 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002090}
Valerio Setti02c25b52022-11-15 14:08:42 +01002091#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002092#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002093
Ronald Cron73fe8df2022-10-05 14:31:43 +02002094#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002095int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002096{
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (conf->psk_identity == NULL ||
2098 conf->psk_identity_len == 0) {
2099 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002100 }
2101
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002102#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2104 return 1;
2105 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002106#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (conf->psk != NULL && conf->psk_len != 0) {
2109 return 1;
2110 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002113}
2114
Gilles Peskine449bd832023-01-11 14:50:10 +01002115static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002116{
2117 /* Remove reference to existing PSK, if any. */
2118#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002120 /* The maintenance of the PSK key slot is the
2121 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002122 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002123 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002124#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002126 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002127 conf->psk = NULL;
2128 conf->psk_len = 0;
2129 }
2130
2131 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 if (conf->psk_identity != NULL) {
2133 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002134 conf->psk_identity = NULL;
2135 conf->psk_identity_len = 0;
2136 }
2137}
2138
Hanno Becker7390c712018-11-15 13:33:04 +00002139/* This function assumes that PSK identity in the SSL config is unset.
2140 * It checks that the provided identity is well-formed and attempts
2141 * to make a copy of it in the SSL config.
2142 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002143MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002144static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2145 unsigned char const *psk_identity,
2146 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002147{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002148 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002150 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 (psk_identity_len >> 16) != 0 ||
2152 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2153 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002154 }
2155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2157 if (conf->psk_identity == NULL) {
2158 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2159 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002160
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002161 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002163
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002165}
2166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2168 const unsigned char *psk, size_t psk_len,
2169 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002170{
Janos Follath865b3eb2019-12-16 11:46:15 +00002171 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002172
2173 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2175 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2176 }
Hanno Becker7390c712018-11-15 13:33:04 +00002177
2178 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 if (psk == NULL) {
2180 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2181 }
2182 if (psk_len == 0) {
2183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2184 }
2185 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2186 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2187 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2190 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2191 }
Hanno Becker7390c712018-11-15 13:33:04 +00002192 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002194
2195 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2197 if (ret != 0) {
2198 ssl_conf_remove_psk(conf);
2199 }
Hanno Becker7390c712018-11-15 13:33:04 +00002200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002202}
2203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002205{
2206#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002208 /* The maintenance of the external PSK key slot is the
2209 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 if (ssl->handshake->psk_opaque_is_internal) {
2211 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002212 ssl->handshake->psk_opaque_is_internal = 0;
2213 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002214 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002215 }
Neil Armstronge952a302022-05-03 10:22:14 +02002216#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002218 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002220 ssl->handshake->psk_len = 0;
2221 }
Neil Armstronge952a302022-05-03 10:22:14 +02002222#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002223}
2224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2226 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002227{
Neil Armstrong501c9322022-05-03 09:35:09 +02002228#if defined(MBEDTLS_USE_PSA_CRYPTO)
2229 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002230 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002231 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002232 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002233#endif /* MBEDTLS_USE_PSA_CRYPTO */
2234
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (psk == NULL || ssl->handshake == NULL) {
2236 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2237 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2241 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002242
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002244
Neil Armstrong501c9322022-05-03 09:35:09 +02002245#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002246#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2248 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2249 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2250 } else {
2251 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2252 }
2253 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002254 }
2255#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002256
Jerry Yu568ec252022-07-22 21:27:34 +08002257#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2259 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2260 psa_set_key_usage_flags(&key_attributes,
2261 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002262 }
2263#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 psa_set_key_algorithm(&key_attributes, alg);
2266 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2269 if (status != PSA_SUCCESS) {
2270 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2271 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002272
2273 /* Allow calling psa_destroy_key() on psk remove */
2274 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002276#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2278 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2279 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002280
2281 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002285#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002286}
2287
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002288#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002289int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2290 mbedtls_svc_key_id_t psk,
2291 const unsigned char *psk_identity,
2292 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002293{
Janos Follath865b3eb2019-12-16 11:46:15 +00002294 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002295
2296 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2298 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2299 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002300
Hanno Becker7390c712018-11-15 13:33:04 +00002301 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 if (mbedtls_svc_key_id_is_null(psk)) {
2303 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2304 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002305 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002306
2307 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2309 psk_identity_len);
2310 if (ret != 0) {
2311 ssl_conf_remove_psk(conf);
2312 }
Hanno Becker7390c712018-11-15 13:33:04 +00002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002315}
2316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2318 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002319{
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 if ((mbedtls_svc_key_id_is_null(psk)) ||
2321 (ssl->handshake == NULL)) {
2322 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2323 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002326 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002328}
2329#endif /* MBEDTLS_USE_PSA_CRYPTO */
2330
Jerry Yu8897c072022-08-12 13:56:53 +08002331#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002332void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2333 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2334 size_t),
2335 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002336{
2337 conf->f_psk = f_psk;
2338 conf->p_psk = p_psk;
2339}
Jerry Yu8897c072022-08-12 13:56:53 +08002340#endif /* MBEDTLS_SSL_SRV_C */
2341
Ronald Cron73fe8df2022-10-05 14:31:43 +02002342#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002343
2344#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002345static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002347{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002348#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 if (alg == PSA_ALG_CBC_NO_PADDING) {
2350 return MBEDTLS_SSL_MODE_CBC;
2351 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002352#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (PSA_ALG_IS_AEAD(alg)) {
2354 return MBEDTLS_SSL_MODE_AEAD;
2355 }
2356 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002357}
2358
2359#else /* MBEDTLS_USE_PSA_CRYPTO */
2360
2361static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002363{
2364#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 if (mode == MBEDTLS_MODE_CBC) {
2366 return MBEDTLS_SSL_MODE_CBC;
2367 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002368#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2369
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002370#if defined(MBEDTLS_GCM_C) || \
2371 defined(MBEDTLS_CCM_C) || \
2372 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002374 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 mode == MBEDTLS_MODE_CHACHAPOLY) {
2376 return MBEDTLS_SSL_MODE_AEAD;
2377 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002378#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002379
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381}
Gilles Peskine301711e2022-04-26 16:57:05 +02002382#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002383
Gilles Peskinee108d982022-04-26 16:50:40 +02002384static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2385 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002387{
2388#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2390 base_mode == MBEDTLS_SSL_MODE_CBC) {
2391 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002392 }
2393#else
2394 (void) encrypt_then_mac;
2395#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002397}
2398
Neil Armstrongab555e02022-04-04 11:07:59 +02002399mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002401{
Gilles Peskinee108d982022-04-26 16:50:40 +02002402 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002405#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002407#endif
2408 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002409
Gilles Peskinee108d982022-04-26 16:50:40 +02002410 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002411#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002412 encrypt_then_mac = transform->encrypt_then_mac;
2413#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002415}
2416
Neil Armstrongab555e02022-04-04 11:07:59 +02002417mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002418#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002420#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002422{
Gilles Peskinee108d982022-04-26 16:50:40 +02002423 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2424
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002425#if defined(MBEDTLS_USE_PSA_CRYPTO)
2426 psa_status_t status;
2427 psa_algorithm_t alg;
2428 psa_key_type_t type;
2429 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002430 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2431 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 if (status == PSA_SUCCESS) {
2433 base_mode = mbedtls_ssl_get_base_mode(alg);
2434 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002435#else
2436 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002437 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002439 base_mode =
2440 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002442 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002443#endif /* MBEDTLS_USE_PSA_CRYPTO */
2444
Gilles Peskinee108d982022-04-26 16:50:40 +02002445#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2446 int encrypt_then_mac = 0;
2447#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002449}
2450
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002451#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002452
2453#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002454/* Serialization of TLS 1.3 sessions:
2455 *
2456 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002457 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002458 * uint64 ticket_received;
2459 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002460 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002461 * } ClientOnlyData;
2462 *
2463 * struct {
2464 * uint8 endpoint;
2465 * uint8 ciphersuite[2];
2466 * uint32 ticket_age_add;
2467 * uint8 ticket_flags;
2468 * opaque resumption_key<0..255>;
Jerry Yu02e3a072022-12-12 15:13:20 +08002469 * uint32 max_early_data_size;
Jerry Yu438ddd82022-07-07 06:55:50 +00002470 * select ( endpoint ) {
2471 * case client: ClientOnlyData;
2472 * case server: uint64 start_time;
2473 * };
2474 * } serialized_session_tls13;
2475 *
2476 */
2477#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002478MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002479static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2480 unsigned char *buf,
2481 size_t buf_len,
2482 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002483{
2484 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002485#if defined(MBEDTLS_SSL_CLI_C) && \
2486 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 size_t hostname_len = (session->hostname == NULL) ?
2488 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002489#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002490 size_t needed = 1 /* endpoint */
2491 + 2 /* ciphersuite */
2492 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002493 + 1 /* ticket_flags */
2494 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002495 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002496
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2498 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2499 }
Jerry Yu34191072022-08-18 10:32:09 +08002500 needed += session->resumption_key_len; /* resumption_key */
2501
Jerry Yu02e3a072022-12-12 15:13:20 +08002502#if defined(MBEDTLS_SSL_EARLY_DATA)
2503 needed += 4; /* max_early_data_size */
2504#endif
2505
Jerry Yu438ddd82022-07-07 06:55:50 +00002506#if defined(MBEDTLS_HAVE_TIME)
2507 needed += 8; /* start_time or ticket_received */
2508#endif
2509
2510#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002512#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002513 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002515#endif
2516
Jerry Yu438ddd82022-07-07 06:55:50 +00002517 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002518 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002519
2520 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 if (session->ticket_len > SIZE_MAX - needed) {
2522 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2523 }
Jerry Yu34191072022-08-18 10:32:09 +08002524
Jerry Yue28d9742022-08-18 15:44:03 +08002525 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002526 }
2527#endif /* MBEDTLS_SSL_CLI_C */
2528
Jerry Yue36fdd62022-08-17 21:31:36 +08002529 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 if (needed > buf_len) {
2531 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2532 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002533
2534 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2536 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002537 p[7] = session->ticket_flags;
2538
2539 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002540 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002541 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002543 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002544
Jerry Yu02e3a072022-12-12 15:13:20 +08002545#if defined(MBEDTLS_SSL_EARLY_DATA)
2546 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
2547 p += 4;
2548#endif
2549
Jerry Yu438ddd82022-07-07 06:55:50 +00002550#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2552 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002553 p += 8;
2554 }
2555#endif /* MBEDTLS_HAVE_TIME */
2556
2557#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002559#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002561 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002563 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002565 p += hostname_len;
2566 }
2567#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2568
Jerry Yu438ddd82022-07-07 06:55:50 +00002569#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002571 p += 8;
2572#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002574 p += 4;
2575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002577 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002578
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 if (session->ticket != NULL && session->ticket_len > 0) {
2580 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002581 p += session->ticket_len;
2582 }
2583 }
2584#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002586}
2587
2588MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002589static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2590 const unsigned char *buf,
2591 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002592{
2593 const unsigned char *p = buf;
2594 const unsigned char *end = buf + len;
2595
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 if (end - p < 9) {
2597 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2598 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002599 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2601 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002602 session->ticket_flags = p[7];
2603
2604 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002605 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002606 p += 9;
2607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 if (end - p < session->resumption_key_len) {
2609 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2610 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002611
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2614 }
2615 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002616 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002617
Jerry Yu02e3a072022-12-12 15:13:20 +08002618#if defined(MBEDTLS_SSL_EARLY_DATA)
2619 if (end - p < 4) {
2620 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2621 }
2622 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
2623 p += 4;
2624#endif
2625
Jerry Yu438ddd82022-07-07 06:55:50 +00002626#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2628 if (end - p < 8) {
2629 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2630 }
2631 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002632 p += 8;
2633 }
2634#endif /* MBEDTLS_HAVE_TIME */
2635
2636#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002638#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002640 size_t hostname_len;
2641 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 if (end - p < 2) {
2643 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2644 }
2645 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002646 p += 2;
2647
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 if (end - p < (long int) hostname_len) {
2649 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2650 }
2651 if (hostname_len > 0) {
2652 session->hostname = mbedtls_calloc(1, hostname_len);
2653 if (session->hostname == NULL) {
2654 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2655 }
2656 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002657 p += hostname_len;
2658 }
2659#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2660 MBEDTLS_SSL_SESSION_TICKETS */
2661
Jerry Yu438ddd82022-07-07 06:55:50 +00002662#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 if (end - p < 8) {
2664 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2665 }
2666 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002667 p += 8;
2668#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 if (end - p < 4) {
2670 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2671 }
2672 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002673 p += 4;
2674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 if (end - p < 2) {
2676 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2677 }
2678 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002679 p += 2;
2680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 if (end - p < (long int) session->ticket_len) {
2682 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2683 }
2684 if (session->ticket_len > 0) {
2685 session->ticket = mbedtls_calloc(1, session->ticket_len);
2686 if (session->ticket == NULL) {
2687 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2688 }
2689 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002690 p += session->ticket_len;
2691 }
2692 }
2693#endif /* MBEDTLS_SSL_CLI_C */
2694
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002696
2697}
2698#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002699MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002700static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2701 unsigned char *buf,
2702 size_t buf_len,
2703 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002704{
2705 ((void) session);
2706 ((void) buf);
2707 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002708 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002710}
Jerry Yu438ddd82022-07-07 06:55:50 +00002711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2713 unsigned char *buf,
2714 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002715{
2716 ((void) session);
2717 ((void) buf);
2718 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002720}
2721#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002722#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2723
Gilles Peskine449bd832023-01-11 14:50:10 +01002724psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2725 size_t taglen,
2726 psa_algorithm_t *alg,
2727 psa_key_type_t *key_type,
2728 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002729{
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002731 case MBEDTLS_CIPHER_AES_128_CBC:
2732 *alg = PSA_ALG_CBC_NO_PADDING;
2733 *key_type = PSA_KEY_TYPE_AES;
2734 *key_size = 128;
2735 break;
2736 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002738 *key_type = PSA_KEY_TYPE_AES;
2739 *key_size = 128;
2740 break;
2741 case MBEDTLS_CIPHER_AES_128_GCM:
2742 *alg = PSA_ALG_GCM;
2743 *key_type = PSA_KEY_TYPE_AES;
2744 *key_size = 128;
2745 break;
2746 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002748 *key_type = PSA_KEY_TYPE_AES;
2749 *key_size = 192;
2750 break;
2751 case MBEDTLS_CIPHER_AES_192_GCM:
2752 *alg = PSA_ALG_GCM;
2753 *key_type = PSA_KEY_TYPE_AES;
2754 *key_size = 192;
2755 break;
2756 case MBEDTLS_CIPHER_AES_256_CBC:
2757 *alg = PSA_ALG_CBC_NO_PADDING;
2758 *key_type = PSA_KEY_TYPE_AES;
2759 *key_size = 256;
2760 break;
2761 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002763 *key_type = PSA_KEY_TYPE_AES;
2764 *key_size = 256;
2765 break;
2766 case MBEDTLS_CIPHER_AES_256_GCM:
2767 *alg = PSA_ALG_GCM;
2768 *key_type = PSA_KEY_TYPE_AES;
2769 *key_size = 256;
2770 break;
2771 case MBEDTLS_CIPHER_ARIA_128_CBC:
2772 *alg = PSA_ALG_CBC_NO_PADDING;
2773 *key_type = PSA_KEY_TYPE_ARIA;
2774 *key_size = 128;
2775 break;
2776 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002778 *key_type = PSA_KEY_TYPE_ARIA;
2779 *key_size = 128;
2780 break;
2781 case MBEDTLS_CIPHER_ARIA_128_GCM:
2782 *alg = PSA_ALG_GCM;
2783 *key_type = PSA_KEY_TYPE_ARIA;
2784 *key_size = 128;
2785 break;
2786 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002788 *key_type = PSA_KEY_TYPE_ARIA;
2789 *key_size = 192;
2790 break;
2791 case MBEDTLS_CIPHER_ARIA_192_GCM:
2792 *alg = PSA_ALG_GCM;
2793 *key_type = PSA_KEY_TYPE_ARIA;
2794 *key_size = 192;
2795 break;
2796 case MBEDTLS_CIPHER_ARIA_256_CBC:
2797 *alg = PSA_ALG_CBC_NO_PADDING;
2798 *key_type = PSA_KEY_TYPE_ARIA;
2799 *key_size = 256;
2800 break;
2801 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002803 *key_type = PSA_KEY_TYPE_ARIA;
2804 *key_size = 256;
2805 break;
2806 case MBEDTLS_CIPHER_ARIA_256_GCM:
2807 *alg = PSA_ALG_GCM;
2808 *key_type = PSA_KEY_TYPE_ARIA;
2809 *key_size = 256;
2810 break;
2811 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2812 *alg = PSA_ALG_CBC_NO_PADDING;
2813 *key_type = PSA_KEY_TYPE_CAMELLIA;
2814 *key_size = 128;
2815 break;
2816 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002818 *key_type = PSA_KEY_TYPE_CAMELLIA;
2819 *key_size = 128;
2820 break;
2821 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2822 *alg = PSA_ALG_GCM;
2823 *key_type = PSA_KEY_TYPE_CAMELLIA;
2824 *key_size = 128;
2825 break;
2826 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002828 *key_type = PSA_KEY_TYPE_CAMELLIA;
2829 *key_size = 192;
2830 break;
2831 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2832 *alg = PSA_ALG_GCM;
2833 *key_type = PSA_KEY_TYPE_CAMELLIA;
2834 *key_size = 192;
2835 break;
2836 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2837 *alg = PSA_ALG_CBC_NO_PADDING;
2838 *key_type = PSA_KEY_TYPE_CAMELLIA;
2839 *key_size = 256;
2840 break;
2841 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002843 *key_type = PSA_KEY_TYPE_CAMELLIA;
2844 *key_size = 256;
2845 break;
2846 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2847 *alg = PSA_ALG_GCM;
2848 *key_type = PSA_KEY_TYPE_CAMELLIA;
2849 *key_size = 256;
2850 break;
2851 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2852 *alg = PSA_ALG_CHACHA20_POLY1305;
2853 *key_type = PSA_KEY_TYPE_CHACHA20;
2854 *key_size = 256;
2855 break;
2856 case MBEDTLS_CIPHER_NULL:
2857 *alg = MBEDTLS_SSL_NULL_CIPHER;
2858 *key_type = 0;
2859 *key_size = 0;
2860 break;
2861 default:
2862 return PSA_ERROR_NOT_SUPPORTED;
2863 }
2864
2865 return PSA_SUCCESS;
2866}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002867#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002868
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002869#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002870int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2871 const unsigned char *dhm_P, size_t P_len,
2872 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002873{
Janos Follath865b3eb2019-12-16 11:46:15 +00002874 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 mbedtls_mpi_free(&conf->dhm_P);
2877 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002878
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2880 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2881 mbedtls_mpi_free(&conf->dhm_P);
2882 mbedtls_mpi_free(&conf->dhm_G);
2883 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002884 }
2885
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002887}
Paul Bakker5121ce52009-01-03 21:22:43 +00002888
Gilles Peskine449bd832023-01-11 14:50:10 +01002889int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002890{
Janos Follath865b3eb2019-12-16 11:46:15 +00002891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 mbedtls_mpi_free(&conf->dhm_P);
2894 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002895
Gilles Peskine449bd832023-01-11 14:50:10 +01002896 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2897 &conf->dhm_P)) != 0 ||
2898 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2899 &conf->dhm_G)) != 0) {
2900 mbedtls_mpi_free(&conf->dhm_P);
2901 mbedtls_mpi_free(&conf->dhm_G);
2902 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002903 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002904
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002906}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002907#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002908
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002909#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2910/*
2911 * Set the minimum length for Diffie-Hellman parameters
2912 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002913void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2914 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002915{
2916 conf->dhm_min_bitlen = bitlen;
2917}
2918#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2919
Ronald Crone68ab4f2022-10-05 12:46:29 +02002920#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002921#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002922/*
2923 * Set allowed/preferred hashes for handshake signatures
2924 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002925void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2926 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002927{
2928 conf->sig_hashes = hashes;
2929}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002930#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002931
Jerry Yuf017ee42022-01-12 15:49:48 +08002932/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002933void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2934 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002935{
Jerry Yuf017ee42022-01-12 15:49:48 +08002936#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2937 conf->sig_hashes = NULL;
2938#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2939 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002940}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002941#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002942
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002943#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002944#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002945/*
2946 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002947 *
2948 * mbedtls_ssl_setup() takes the provided list
2949 * and translates it to a list of IANA TLS group identifiers,
2950 * stored in ssl->handshake->group_list.
2951 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002952 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002953void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2954 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002955{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002956 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002957 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002958}
Brett Warrene0edc842021-08-17 09:53:13 +01002959#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002960#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002961
Brett Warrene0edc842021-08-17 09:53:13 +01002962/*
2963 * Set the allowed groups
2964 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002965void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2966 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002967{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002968#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002969 conf->curve_list = NULL;
2970#endif
2971 conf->group_list = group_list;
2972}
2973
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002974#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002975int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002976{
Hanno Becker947194e2017-04-07 13:25:49 +01002977 /* Initialize to suppress unnecessary compiler warning */
2978 size_t hostname_len = 0;
2979
2980 /* Check if new hostname is valid before
2981 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 if (hostname != NULL) {
2983 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2986 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2987 }
Hanno Becker947194e2017-04-07 13:25:49 +01002988 }
2989
2990 /* Now it's clear that we will overwrite the old hostname,
2991 * so we can free it safely */
2992
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002994 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002995 }
2996
2997 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002998
Gilles Peskine449bd832023-01-11 14:50:10 +01002999 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01003000 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 } else {
3002 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
3003 if (ssl->hostname == NULL) {
3004 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3005 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003006
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003008
Hanno Becker947194e2017-04-07 13:25:49 +01003009 ssl->hostname[hostname_len] = '\0';
3010 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003011
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003013}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003014#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003015
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003016#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003017void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3018 int (*f_sni)(void *, mbedtls_ssl_context *,
3019 const unsigned char *, size_t),
3020 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003021{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003022 conf->f_sni = f_sni;
3023 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003024}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003027#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003028int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003029{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003030 size_t cur_len, tot_len;
3031 const char **p;
3032
3033 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003034 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3035 * MUST NOT be truncated."
3036 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003037 */
3038 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 for (p = protos; *p != NULL; p++) {
3040 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003041 tot_len += cur_len;
3042
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 if ((cur_len == 0) ||
3044 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3045 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3046 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3047 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003048 }
3049
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003050 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003051
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003053}
3054
Gilles Peskine449bd832023-01-11 14:50:10 +01003055const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003056{
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003058}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003059#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003060
Johan Pascalb62bb512015-12-03 21:56:45 +01003061#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003062void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3063 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003064{
3065 conf->dtls_srtp_mki_support = support_mki_value;
3066}
3067
Gilles Peskine449bd832023-01-11 14:50:10 +01003068int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3069 unsigned char *mki_value,
3070 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003071{
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3073 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003074 }
Ron Eldor591f1622018-01-22 12:30:04 +02003075
Gilles Peskine449bd832023-01-11 14:50:10 +01003076 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3077 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003078 }
Ron Eldor591f1622018-01-22 12:30:04 +02003079
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003081 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003083}
3084
Gilles Peskine449bd832023-01-11 14:50:10 +01003085int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3086 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003087{
Johan Pascal253d0262020-09-22 13:04:45 +02003088 const mbedtls_ssl_srtp_profile *p;
3089 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003090
Johan Pascal253d0262020-09-22 13:04:45 +02003091 /* check the profiles list: all entry must be valid,
3092 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3094 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3095 p++) {
3096 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003097 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003099 /* unsupported value, stop parsing and set the size to an error value */
3100 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003101 }
3102 }
3103
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3105 conf->dtls_srtp_profile_list = NULL;
3106 conf->dtls_srtp_profile_list_len = 0;
3107 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003108 }
3109
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003110 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003111 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003112
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003114}
3115
Gilles Peskine449bd832023-01-11 14:50:10 +01003116void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3117 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003118{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003119 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3120 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003122 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003124 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3126 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003127 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003128}
Johan Pascalb62bb512015-12-03 21:56:45 +01003129#endif /* MBEDTLS_SSL_DTLS_SRTP */
3130
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303131#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003132void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003133{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003134 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003135}
3136
Gilles Peskine449bd832023-01-11 14:50:10 +01003137void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003138{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003139 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003140}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303141#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003142
Janos Follath088ce432017-04-10 12:42:31 +01003143#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003144void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3145 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003146{
3147 conf->cert_req_ca_list = cert_req_ca_list;
3148}
3149#endif
3150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003152void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003153{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003154 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003155}
3156#endif
3157
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003159void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003160{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003161 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003162}
3163#endif
3164
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003166int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003167{
Gilles Peskine449bd832023-01-11 14:50:10 +01003168 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3169 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003171 }
3172
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003173 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003174
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003176}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003177#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003178
Gilles Peskine449bd832023-01-11 14:50:10 +01003179void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003180{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003181 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003182}
3183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003184#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003185void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003186{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003187 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003188}
3189
Gilles Peskine449bd832023-01-11 14:50:10 +01003190void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003191{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003192 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003193}
3194
Gilles Peskine449bd832023-01-11 14:50:10 +01003195void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3196 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003197{
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003199}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003201
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003202#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003203#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003204void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003205{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003206 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003207}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003208#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003209
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003210#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003211
Jerry Yud0766ec2022-09-22 10:46:57 +08003212#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003213void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3214 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003215{
Jerry Yud0766ec2022-09-22 10:46:57 +08003216 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003217}
3218#endif
3219
Gilles Peskine449bd832023-01-11 14:50:10 +01003220void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3221 mbedtls_ssl_ticket_write_t *f_ticket_write,
3222 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3223 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003224{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003225 conf->f_ticket_write = f_ticket_write;
3226 conf->f_ticket_parse = f_ticket_parse;
3227 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003228}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003229#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003230#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003231
Gilles Peskine449bd832023-01-11 14:50:10 +01003232void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3233 mbedtls_ssl_export_keys_t *f_export_keys,
3234 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003235{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003236 ssl->f_export_keys = f_export_keys;
3237 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003238}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003239
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003240#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003241void mbedtls_ssl_conf_async_private_cb(
3242 mbedtls_ssl_config *conf,
3243 mbedtls_ssl_async_sign_t *f_async_sign,
3244 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3245 mbedtls_ssl_async_resume_t *f_async_resume,
3246 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003247 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003248{
3249 conf->f_async_sign_start = f_async_sign;
3250 conf->f_async_decrypt_start = f_async_decrypt;
3251 conf->f_async_resume = f_async_resume;
3252 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003253 conf->p_async_config_data = async_config_data;
3254}
3255
Gilles Peskine449bd832023-01-11 14:50:10 +01003256void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003257{
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003259}
3260
Gilles Peskine449bd832023-01-11 14:50:10 +01003261void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003262{
Gilles Peskine449bd832023-01-11 14:50:10 +01003263 if (ssl->handshake == NULL) {
3264 return NULL;
3265 } else {
3266 return ssl->handshake->user_async_ctx;
3267 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003268}
3269
Gilles Peskine449bd832023-01-11 14:50:10 +01003270void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3271 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003272{
Gilles Peskine449bd832023-01-11 14:50:10 +01003273 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003274 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003275 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003276}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003277#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003278
Paul Bakker5121ce52009-01-03 21:22:43 +00003279/*
3280 * SSL get accessors
3281 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003282uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003283{
Gilles Peskine449bd832023-01-11 14:50:10 +01003284 if (ssl->session != NULL) {
3285 return ssl->session->verify_result;
3286 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003287
Gilles Peskine449bd832023-01-11 14:50:10 +01003288 if (ssl->session_negotiate != NULL) {
3289 return ssl->session_negotiate->verify_result;
3290 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003291
Gilles Peskine449bd832023-01-11 14:50:10 +01003292 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003293}
3294
Gilles Peskine449bd832023-01-11 14:50:10 +01003295int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003296{
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 if (ssl == NULL || ssl->session == NULL) {
3298 return 0;
3299 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003300
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003302}
3303
Gilles Peskine449bd832023-01-11 14:50:10 +01003304const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003305{
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 if (ssl == NULL || ssl->session == NULL) {
3307 return NULL;
3308 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003309
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003311}
3312
Gilles Peskine449bd832023-01-11 14:50:10 +01003313const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003314{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003315#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3317 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003318 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003320 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003321 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003322 }
3323 }
3324#endif
3325
Gilles Peskine449bd832023-01-11 14:50:10 +01003326 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003327 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003328 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003329 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003331 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003333 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003334}
3335
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003336#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003337size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003338{
David Horstmann95d516f2021-05-04 18:36:56 +01003339 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003340 size_t read_mfl;
3341
Jerry Yuddda0502022-12-01 19:43:12 +08003342#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003343 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3345 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3346 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003347 }
Jerry Yuddda0502022-12-01 19:43:12 +08003348#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003349
3350 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003351 if (ssl->session_out != NULL) {
3352 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3353 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003354 max_len = read_mfl;
3355 }
3356 }
3357
Jerry Yuddda0502022-12-01 19:43:12 +08003358 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 if (ssl->session_negotiate != NULL) {
3360 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3361 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003362 max_len = read_mfl;
3363 }
3364 }
3365
Gilles Peskine449bd832023-01-11 14:50:10 +01003366 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003367}
3368
Gilles Peskine449bd832023-01-11 14:50:10 +01003369size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003370{
3371 size_t max_len;
3372
3373 /*
3374 * Assume mfl_code is correct since it was checked when set
3375 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003376 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003377
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003378 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003379 if (ssl->session_out != NULL &&
3380 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3381 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003382 }
3383
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003384 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003385 if (ssl->session_negotiate != NULL &&
3386 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3387 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003388 }
3389
Gilles Peskine449bd832023-01-11 14:50:10 +01003390 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003391}
3392#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3393
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003394#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003395size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003396{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003397 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003398 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3399 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3400 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3401 return 0;
3402 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003403
Gilles Peskine449bd832023-01-11 14:50:10 +01003404 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3405 return ssl->mtu;
3406 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003407
Gilles Peskine449bd832023-01-11 14:50:10 +01003408 if (ssl->mtu == 0) {
3409 return ssl->handshake->mtu;
3410 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003411
Gilles Peskine449bd832023-01-11 14:50:10 +01003412 return ssl->mtu < ssl->handshake->mtu ?
3413 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003414}
3415#endif /* MBEDTLS_SSL_PROTO_DTLS */
3416
Gilles Peskine449bd832023-01-11 14:50:10 +01003417int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003418{
3419 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3420
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003421#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3422 !defined(MBEDTLS_SSL_PROTO_DTLS)
3423 (void) ssl;
3424#endif
3425
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003426#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003427 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003428
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003430 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003432#endif
3433
3434#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003435 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3436 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3437 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003438 const size_t overhead = (size_t) ret;
3439
Gilles Peskine449bd832023-01-11 14:50:10 +01003440 if (ret < 0) {
3441 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003442 }
3443
Gilles Peskine449bd832023-01-11 14:50:10 +01003444 if (mtu <= overhead) {
3445 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3446 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3447 }
3448
3449 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003450 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003451 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003452 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003453#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003454
Hanno Becker0defedb2018-08-10 12:35:02 +01003455#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3456 !defined(MBEDTLS_SSL_PROTO_DTLS)
3457 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003458#endif
3459
Gilles Peskine449bd832023-01-11 14:50:10 +01003460 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003461}
3462
Gilles Peskine449bd832023-01-11 14:50:10 +01003463int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003464{
3465 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3466
3467#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3468 (void) ssl;
3469#endif
3470
3471#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003472 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003473
Gilles Peskine449bd832023-01-11 14:50:10 +01003474 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003475 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003476 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003477#endif
3478
Gilles Peskine449bd832023-01-11 14:50:10 +01003479 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003480}
3481
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003482#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003483const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003484{
Gilles Peskine449bd832023-01-11 14:50:10 +01003485 if (ssl == NULL || ssl->session == NULL) {
3486 return NULL;
3487 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003488
Hanno Beckere6824572019-02-07 13:18:46 +00003489#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003490 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003491#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003492 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003493#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003494}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003495#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003496
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003497#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003498int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3499 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003500{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003501 int ret;
3502
Gilles Peskine449bd832023-01-11 14:50:10 +01003503 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003504 dst == NULL ||
3505 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003506 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3507 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003508 }
3509
Hanno Beckere810bbc2021-05-14 16:01:05 +01003510 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3511 * idempotent: Each session can only be exported once.
3512 *
3513 * (This is in preparation for TLS 1.3 support where we will
3514 * need the ability to export multiple sessions (aka tickets),
3515 * which will be achieved by calling mbedtls_ssl_get_session()
3516 * multiple times until it fails.)
3517 *
3518 * Check whether we have already exported the current session,
3519 * and fail if so.
3520 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003521 if (ssl->session->exported == 1) {
3522 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3523 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003524
Gilles Peskine449bd832023-01-11 14:50:10 +01003525 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3526 if (ret != 0) {
3527 return ret;
3528 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003529
3530 /* Remember that we've exported the session. */
3531 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003532 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003533}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003534#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003535
Paul Bakker5121ce52009-01-03 21:22:43 +00003536/*
Hanno Beckera835da52019-05-16 12:39:07 +01003537 * Define ticket header determining Mbed TLS version
3538 * and structure of the ticket.
3539 */
3540
Hanno Becker94ef3b32019-05-16 12:50:45 +01003541/*
Hanno Becker50b59662019-05-28 14:30:45 +01003542 * Define bitflag determining compile-time settings influencing
3543 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003544 */
3545
Hanno Becker50b59662019-05-28 14:30:45 +01003546#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003547#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003548#else
Hanno Becker3e088662019-05-29 11:10:18 +01003549#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003550#endif /* MBEDTLS_HAVE_TIME */
3551
3552#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003553#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003554#else
Hanno Becker3e088662019-05-29 11:10:18 +01003555#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003556#endif /* MBEDTLS_X509_CRT_PARSE_C */
3557
3558#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003559#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003560#else
Hanno Becker3e088662019-05-29 11:10:18 +01003561#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003562#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3563
3564#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003565#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003566#else
Hanno Becker3e088662019-05-29 11:10:18 +01003567#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003568#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3569
Hanno Becker94ef3b32019-05-16 12:50:45 +01003570#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003571#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003572#else
Hanno Becker3e088662019-05-29 11:10:18 +01003573#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003574#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3575
Hanno Becker94ef3b32019-05-16 12:50:45 +01003576#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3577#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3578#else
3579#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3580#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3581
Hanno Becker3e088662019-05-29 11:10:18 +01003582#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3583#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3584#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3585#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003586#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3587#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003588
Hanno Becker50b59662019-05-28 14:30:45 +01003589#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003590 ((uint16_t) ( \
3591 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3592 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3593 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3594 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3595 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3596 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3597 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003598
Hanno Beckerf8787072019-05-16 12:41:07 +01003599static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003600 MBEDTLS_VERSION_MAJOR,
3601 MBEDTLS_VERSION_MINOR,
3602 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003603 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3604 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003605};
Hanno Beckera835da52019-05-16 12:39:07 +01003606
3607/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003608 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003609 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003610 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003611 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003612 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003613 * opaque mbedtls_version[3]; // library version: major, minor, patch
3614 * opaque session_format[2]; // library-version specific 16-bit field
3615 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003616 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003617 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003618 * Note: When updating the format, remember to keep
3619 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003620 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003621 * // In this version, `session_format` determines
3622 * // the setting of those compile-time
3623 * // configuration options which influence
3624 * // the structure of mbedtls_ssl_session.
3625 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003626 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003627 * // - TLS 1.2 (0x0303)
3628 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003629 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003630 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003631 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003632 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003633 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003634 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003635 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003636 *
3637 * };
3638 *
3639 * } serialized_session;
3640 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003641 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003642
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003643MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003644static int ssl_session_save(const mbedtls_ssl_session *session,
3645 unsigned char omit_header,
3646 unsigned char *buf,
3647 size_t buf_len,
3648 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003649{
3650 unsigned char *p = buf;
3651 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003652 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003653#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3654 size_t out_len;
3655 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3656#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003657 if (session == NULL) {
3658 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3659 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003660
Gilles Peskine449bd832023-01-11 14:50:10 +01003661 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003662 /*
3663 * Add Mbed TLS version identifier
3664 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003665 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003666
Gilles Peskine449bd832023-01-11 14:50:10 +01003667 if (used <= buf_len) {
3668 memcpy(p, ssl_serialized_session_header,
3669 sizeof(ssl_serialized_session_header));
3670 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003671 }
3672 }
3673
3674 /*
3675 * TLS version identifier
3676 */
3677 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003678 if (used <= buf_len) {
3679 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003680 }
3681
3682 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003683 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003684 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003685#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003686 case MBEDTLS_SSL_VERSION_TLS1_2:
3687 used += ssl_tls12_session_save(session, p, remaining_len);
3688 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003689#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3690
Jerry Yu251a12e2022-07-13 15:15:48 +08003691#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003692 case MBEDTLS_SSL_VERSION_TLS1_3:
3693 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3694 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3695 return ret;
3696 }
3697 used += out_len;
3698 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003699#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3700
Gilles Peskine449bd832023-01-11 14:50:10 +01003701 default:
3702 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003703 }
3704
3705 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003706 if (used > buf_len) {
3707 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3708 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003709
Gilles Peskine449bd832023-01-11 14:50:10 +01003710 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003711}
3712
3713/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003714 * Public wrapper for ssl_session_save()
3715 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003716int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3717 unsigned char *buf,
3718 size_t buf_len,
3719 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003720{
Gilles Peskine449bd832023-01-11 14:50:10 +01003721 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003722}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003723
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003724/*
3725 * Deserialize session, see mbedtls_ssl_session_save() for format.
3726 *
3727 * This internal version is wrapped by a public function that cleans up in
3728 * case of error, and has an extra option omit_header.
3729 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003730MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003731static int ssl_session_load(mbedtls_ssl_session *session,
3732 unsigned char omit_header,
3733 const unsigned char *buf,
3734 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003735{
3736 const unsigned char *p = buf;
3737 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003738 size_t remaining_len;
3739
3740
Gilles Peskine449bd832023-01-11 14:50:10 +01003741 if (session == NULL) {
3742 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3743 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003744
Gilles Peskine449bd832023-01-11 14:50:10 +01003745 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003746 /*
3747 * Check Mbed TLS version identifier
3748 */
3749
Gilles Peskine449bd832023-01-11 14:50:10 +01003750 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3751 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003752 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003753
3754 if (memcmp(p, ssl_serialized_session_header,
3755 sizeof(ssl_serialized_session_header)) != 0) {
3756 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3757 }
3758 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003759 }
3760
3761 /*
3762 * TLS version identifier
3763 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003764 if (1 > (size_t) (end - p)) {
3765 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3766 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003767 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003768
3769 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003770 remaining_len = (end - p);
3771 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003772#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003773 case MBEDTLS_SSL_VERSION_TLS1_2:
3774 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003775#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3776
Jerry Yu438ddd82022-07-07 06:55:50 +00003777#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003778 case MBEDTLS_SSL_VERSION_TLS1_3:
3779 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003780#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3781
Gilles Peskine449bd832023-01-11 14:50:10 +01003782 default:
3783 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003784 }
3785}
3786
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003787/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003788 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003789 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003790int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3791 const unsigned char *buf,
3792 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003793{
Gilles Peskine449bd832023-01-11 14:50:10 +01003794 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003795
Gilles Peskine449bd832023-01-11 14:50:10 +01003796 if (ret != 0) {
3797 mbedtls_ssl_session_free(session);
3798 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003799
Gilles Peskine449bd832023-01-11 14:50:10 +01003800 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003801}
3802
3803/*
Paul Bakker1961b702013-01-25 14:49:24 +01003804 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003805 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003806MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003807static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003808{
3809 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3810
Ronald Cron66dbf912022-02-02 15:33:46 +01003811 /*
3812 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003813 * that were written into the output buffer by the previous handshake step,
3814 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003815 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3816 * We proceed to the next handshake step only when all data from the
3817 * previous one have been sent to the peer, thus we make sure that this is
3818 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3819 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3820 * we have to wait before to go ahead.
3821 * In the case of TLS 1.3, handshake step handlers do not send data to the
3822 * peer. Data are only sent here and through
3823 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003824 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003825 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003826 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3827 return ret;
3828 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003829
3830#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003831 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3832 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3833 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3834 return ret;
3835 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003836 }
3837#endif /* MBEDTLS_SSL_PROTO_DTLS */
3838
Gilles Peskine449bd832023-01-11 14:50:10 +01003839 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003840}
3841
Gilles Peskine449bd832023-01-11 14:50:10 +01003842int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003843{
Hanno Becker41934dd2021-08-07 19:13:43 +01003844 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003845
Gilles Peskine449bd832023-01-11 14:50:10 +01003846 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003847 ssl->conf == NULL ||
3848 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003849 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3850 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003851 }
3852
Gilles Peskine449bd832023-01-11 14:50:10 +01003853 ret = ssl_prepare_handshake_step(ssl);
3854 if (ret != 0) {
3855 return ret;
3856 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003857
Gilles Peskine449bd832023-01-11 14:50:10 +01003858 ret = mbedtls_ssl_handle_pending_alert(ssl);
3859 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003860 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003861 }
Jerry Yue7047812021-09-13 19:26:39 +08003862
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003863 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3864 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3865 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3866
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003867#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003868 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3869 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003870 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003871
Gilles Peskine449bd832023-01-11 14:50:10 +01003872 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003873 case MBEDTLS_SSL_HELLO_REQUEST:
3874 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003875 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003876 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003877
Ronald Cron9f0fba32022-02-10 16:45:15 +01003878 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003879 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003880 break;
3881
3882 default:
3883#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003884 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3885 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3886 } else {
3887 ret = mbedtls_ssl_handshake_client_step(ssl);
3888 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003889#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003890 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003891#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003892 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003893#endif
3894 }
Jerry Yub9930e72021-08-06 17:11:51 +08003895 }
Ronald Cron6291b232023-03-08 15:51:25 +01003896#endif /* MBEDTLS_SSL_CLI_C */
3897
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003898#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003899 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003900#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3901 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003902 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003903 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003904 ret = mbedtls_ssl_handshake_server_step(ssl);
3905 }
Ronald Cron6291b232023-03-08 15:51:25 +01003906#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3907 ret = mbedtls_ssl_handshake_server_step(ssl);
3908#else
3909 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003910#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003911 }
3912#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003913
Gilles Peskine449bd832023-01-11 14:50:10 +01003914 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003915 /* handshake_step return error. And it is same
3916 * with alert_reason.
3917 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003918 if (ssl->send_alert) {
3919 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003920 goto cleanup;
3921 }
3922 }
3923
3924cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003925 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003926}
3927
3928/*
3929 * Perform the SSL handshake
3930 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003931int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003932{
3933 int ret = 0;
3934
Hanno Beckera817ea42020-10-20 15:20:23 +01003935 /* Sanity checks */
3936
Gilles Peskine449bd832023-01-11 14:50:10 +01003937 if (ssl == NULL || ssl->conf == NULL) {
3938 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3939 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003940
Hanno Beckera817ea42020-10-20 15:20:23 +01003941#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003942 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3943 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3944 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3945 "mbedtls_ssl_set_timer_cb() for DTLS"));
3946 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003947 }
3948#endif /* MBEDTLS_SSL_PROTO_DTLS */
3949
Gilles Peskine449bd832023-01-11 14:50:10 +01003950 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003951
Hanno Beckera817ea42020-10-20 15:20:23 +01003952 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003953 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3954 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003955
Gilles Peskine449bd832023-01-11 14:50:10 +01003956 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003957 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003958 }
Paul Bakker1961b702013-01-25 14:49:24 +01003959 }
3960
Gilles Peskine449bd832023-01-11 14:50:10 +01003961 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003962
Gilles Peskine449bd832023-01-11 14:50:10 +01003963 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003964}
3965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003966#if defined(MBEDTLS_SSL_RENEGOTIATION)
3967#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003968/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003969 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003970 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003971MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003972static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003973{
Janos Follath865b3eb2019-12-16 11:46:15 +00003974 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003975
Gilles Peskine449bd832023-01-11 14:50:10 +01003976 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003977
3978 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003979 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3980 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003981
Gilles Peskine449bd832023-01-11 14:50:10 +01003982 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3983 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3984 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003985 }
3986
Gilles Peskine449bd832023-01-11 14:50:10 +01003987 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003988
Gilles Peskine449bd832023-01-11 14:50:10 +01003989 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003990}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003991#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003992
3993/*
3994 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003995 * - any side: calling mbedtls_ssl_renegotiate(),
3996 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3997 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003998 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003999 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004000 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004001 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004002int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004003{
Janos Follath865b3eb2019-12-16 11:46:15 +00004004 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004005
Gilles Peskine449bd832023-01-11 14:50:10 +01004006 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004007
Gilles Peskine449bd832023-01-11 14:50:10 +01004008 if ((ret = ssl_handshake_init(ssl)) != 0) {
4009 return ret;
4010 }
Paul Bakker48916f92012-09-16 19:57:18 +00004011
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004012 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4013 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004014#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4016 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4017 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004018 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004019 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004020 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004022 }
4023#endif
4024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004025 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4026 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004027
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4029 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4030 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004031 }
4032
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004034
Gilles Peskine449bd832023-01-11 14:50:10 +01004035 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004036}
4037
4038/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004039 * Renegotiate current connection on client,
4040 * or request renegotiation on server
4041 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004042int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004043{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004044 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004045
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 if (ssl == NULL || ssl->conf == NULL) {
4047 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4048 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004049
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004050#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004051 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004052 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4053 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4055 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004056
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004057 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004058
4059 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 if (ssl->out_left != 0) {
4061 return mbedtls_ssl_flush_output(ssl);
4062 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004063
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004065 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004066#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004067
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004068#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004069 /*
4070 * On client, either start the renegotiation process or,
4071 * if already in progress, continue the handshake
4072 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004073 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4074 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4075 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004076 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004077
4078 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4079 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4080 return ret;
4081 }
4082 } else {
4083 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4084 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4085 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004086 }
4087 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004088#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004089
Gilles Peskine449bd832023-01-11 14:50:10 +01004090 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004091}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004092#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004093
Gilles Peskine449bd832023-01-11 14:50:10 +01004094void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004095{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004096 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4097
Gilles Peskine449bd832023-01-11 14:50:10 +01004098 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004099 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004100 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004101
Valerio Setti6f0441d2023-07-03 12:11:36 +02004102#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004103#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 if (ssl->handshake->group_list_heap_allocated) {
4105 mbedtls_free((void *) handshake->group_list);
4106 }
Brett Warrene0edc842021-08-17 09:53:13 +01004107 handshake->group_list = NULL;
4108#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004109#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004110
Ronald Crone68ab4f2022-10-05 12:46:29 +02004111#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004112#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004113 if (ssl->handshake->sig_algs_heap_allocated) {
4114 mbedtls_free((void *) handshake->sig_algs);
4115 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004116 handshake->sig_algs = NULL;
4117#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004118#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 if (ssl->handshake->certificate_request_context) {
4120 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004121 }
4122#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004123#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004124
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004125#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4127 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004128 handshake->async_in_progress = 0;
4129 }
4130#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4131
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004132#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004133#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004135#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004136 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004137#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004138#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004139#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004140#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004141 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004142#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004143 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004144#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004145#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004146
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004147#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004148 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004149#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004150#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004151 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004153#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004154
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004155#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004156#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004157 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004158 /*
4159 * Opaque keys are not stored in the handshake's data and it's the user
4160 * responsibility to destroy them. Clear ones, instead, are created by
4161 * the TLS library and should be destroyed at the same level
4162 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4164 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004165 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004166 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4167#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004168 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004169#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004170#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004172 handshake->ecjpake_cache = NULL;
4173 handshake->ecjpake_cache_len = 0;
4174#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004175#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004176
Valerio Setti7aeec542023-07-05 18:57:21 +02004177#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004178 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004179 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004180 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004181 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004182#endif
4183
Ronald Cron73fe8df2022-10-05 14:31:43 +02004184#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004185#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004186 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004187 /* The maintenance of the external PSK key slot is the
4188 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 if (ssl->handshake->psk_opaque_is_internal) {
4190 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004191 ssl->handshake->psk_opaque_is_internal = 0;
4192 }
4193 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4194 }
Neil Armstronge952a302022-05-03 10:22:14 +02004195#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004197 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004198 }
Neil Armstronge952a302022-05-03 10:22:14 +02004199#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004200#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004201
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004202#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4203 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004204 /*
4205 * Free only the linked list wrapper, not the keys themselves
4206 * since the belong to the SNI callback
4207 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004209#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004210
Gilles Peskineeccd8882020-03-10 12:19:08 +01004211#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4213 if (handshake->ecrs_peer_cert != NULL) {
4214 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4215 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004216 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004217#endif
4218
Hanno Becker75173122019-02-06 16:18:31 +00004219#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4220 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004222#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4223
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004224#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4226 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004227#endif /* MBEDTLS_SSL_CLI_C &&
4228 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004229
4230#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 mbedtls_ssl_flight_free(handshake->flight);
4232 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004233#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004234
Valerio Settiea59c432023-07-25 11:14:03 +02004235#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004236 if (handshake->xxdh_psa_privkey_is_external == 0) {
4237 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 }
Valerio Settiea59c432023-07-25 11:14:03 +02004239#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004240
Ronald Cron6f135e12021-12-08 16:57:54 +01004241#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 mbedtls_ssl_transform_free(handshake->transform_handshake);
4243 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004244#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4246 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004247#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004248#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004249
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004250
4251#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4252 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4253 * processes datagrams and the fact that a datagram is allowed to have
4254 * several records in it, it is possible that the I/O buffers are not
4255 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4257 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004258#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004259
Jerry Yuba9c7272021-10-30 11:54:10 +08004260 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 mbedtls_platform_zeroize(handshake,
4262 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004263}
4264
Gilles Peskine449bd832023-01-11 14:50:10 +01004265void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004266{
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004268 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004269 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004270
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004271#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004273#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004274
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004275#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004276#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4277 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004279#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004280 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004281#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004282
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004284}
4285
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004286#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004287
4288#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4289#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4290#else
4291#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4292#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4293
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004294#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004295
4296#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4297#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4298#else
4299#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4300#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4301
4302#if defined(MBEDTLS_SSL_ALPN)
4303#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4304#else
4305#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4306#endif /* MBEDTLS_SSL_ALPN */
4307
4308#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4309#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4310#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4311#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4312
4313#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 ((uint32_t) ( \
4315 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4316 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4317 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4318 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4319 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4320 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4321 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4322 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004323
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004324static unsigned char ssl_serialized_context_header[] = {
4325 MBEDTLS_VERSION_MAJOR,
4326 MBEDTLS_VERSION_MINOR,
4327 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4329 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4330 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4331 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4332 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004333};
4334
Paul Bakker5121ce52009-01-03 21:22:43 +00004335/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004336 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004337 *
4338 * The format of the serialized data is:
4339 * (in the presentation language of TLS, RFC 8446 section 3)
4340 *
4341 * // header
4342 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004343 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004344 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004345 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004346 * Note: When updating the format, remember to keep these
4347 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004348 *
4349 * // session sub-structure
4350 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4351 * // transform sub-structure
4352 * uint8 random[64]; // ServerHello.random+ClientHello.random
4353 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4354 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4355 * // fields from ssl_context
4356 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4357 * uint64 in_window_top; // DTLS: last validated record seq_num
4358 * uint64 in_window; // DTLS: bitmask for replay protection
4359 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4360 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4361 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4362 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4363 *
4364 * Note that many fields of the ssl_context or sub-structures are not
4365 * serialized, as they fall in one of the following categories:
4366 *
4367 * 1. forced value (eg in_left must be 0)
4368 * 2. pointer to dynamically-allocated memory (eg session, transform)
4369 * 3. value can be re-derived from other data (eg session keys from MS)
4370 * 4. value was temporary (eg content of input buffer)
4371 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004372 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004373int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4374 unsigned char *buf,
4375 size_t buf_len,
4376 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004377{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004378 unsigned char *p = buf;
4379 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004380 size_t session_len;
4381 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004382
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004383 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004384 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4385 * this function's documentation.
4386 *
4387 * These are due to assumptions/limitations in the implementation. Some of
4388 * them are likely to stay (no handshake in progress) some might go away
4389 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004390 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004391 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4393 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4394 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004395 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 if (ssl->handshake != NULL) {
4397 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4398 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004399 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004400 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 if (ssl->transform == NULL || ssl->session == NULL) {
4402 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4403 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004404 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004405 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 if (mbedtls_ssl_check_pending(ssl) != 0) {
4407 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4408 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004409 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 if (ssl->out_left != 0) {
4411 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4412 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004413 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004414 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4416 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4417 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004418 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004419 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4421 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4422 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004423 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004424 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4426 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4427 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004428 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004429 /* Renegotiation must not be enabled */
4430#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4432 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4433 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004434 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004435#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004436
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004437 /*
4438 * Version and format identifier
4439 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (used <= buf_len) {
4443 memcpy(p, ssl_serialized_context_header,
4444 sizeof(ssl_serialized_context_header));
4445 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004446 }
4447
4448 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004449 * Session (length + data)
4450 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004451 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4452 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4453 return ret;
4454 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004455
4456 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 if (used <= buf_len) {
4458 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004459 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004460
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 ret = ssl_session_save(ssl->session, 1,
4462 p, session_len, &session_len);
4463 if (ret != 0) {
4464 return ret;
4465 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004466
4467 p += session_len;
4468 }
4469
4470 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004471 * Transform
4472 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 used += sizeof(ssl->transform->randbytes);
4474 if (used <= buf_len) {
4475 memcpy(p, ssl->transform->randbytes,
4476 sizeof(ssl->transform->randbytes));
4477 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004478 }
4479
4480#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4481 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004483 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004485 p += ssl->transform->in_cid_len;
4486
4487 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004489 p += ssl->transform->out_cid_len;
4490 }
4491#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4492
4493 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004494 * Saved fields from top-level ssl_context structure
4495 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004496 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 if (used <= buf_len) {
4498 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004499 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004500 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004501
4502#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4503 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 if (used <= buf_len) {
4505 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004506 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004507
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004509 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004510 }
4511#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4512
4513#if defined(MBEDTLS_SSL_PROTO_DTLS)
4514 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004516 *p++ = ssl->disable_datagram_packing;
4517 }
4518#endif /* MBEDTLS_SSL_PROTO_DTLS */
4519
Jerry Yuae0b2e22021-10-08 15:21:19 +08004520 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 if (used <= buf_len) {
4522 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004523 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004524 }
4525
4526#if defined(MBEDTLS_SSL_PROTO_DTLS)
4527 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 if (used <= buf_len) {
4529 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004530 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004531 }
4532#endif /* MBEDTLS_SSL_PROTO_DTLS */
4533
4534#if defined(MBEDTLS_SSL_ALPN)
4535 {
4536 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004538 : 0;
4539
4540 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004542 *p++ = alpn_len;
4543
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 if (ssl->alpn_chosen != NULL) {
4545 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004546 p += alpn_len;
4547 }
4548 }
4549 }
4550#endif /* MBEDTLS_SSL_ALPN */
4551
4552 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004553 * Done
4554 */
4555 *olen = used;
4556
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 if (used > buf_len) {
4558 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4559 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004560
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004562
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004564}
4565
4566/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004567 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004568 *
4569 * This internal version is wrapped by a public function that cleans up in
4570 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004571 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004572MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004573static int ssl_context_load(mbedtls_ssl_context *ssl,
4574 const unsigned char *buf,
4575 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004576{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004577 const unsigned char *p = buf;
4578 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004579 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004580 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004581#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004582 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004583#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004584
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004585 /*
4586 * The context should have been freshly setup or reset.
4587 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004588 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004589 * renegotiating, or if the user mistakenly loaded a session first.)
4590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4592 ssl->session != NULL) {
4593 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004594 }
4595
4596 /*
4597 * We can't check that the config matches the initial one, but we can at
4598 * least check it matches the requirements for serializing.
4599 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004600 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004601#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004602 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004603#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004604 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4605 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4606 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4607 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004609 }
4610
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004612
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004613 /*
4614 * Check version identifier
4615 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004618 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004619
4620 if (memcmp(p, ssl_serialized_context_header,
4621 sizeof(ssl_serialized_context_header)) != 0) {
4622 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4623 }
4624 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004625
4626 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004627 * Session
4628 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 if ((size_t) (end - p) < 4) {
4630 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4631 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004632
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004633 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004634 p += 4;
4635
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004636 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004637 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004638 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004639 ssl->session_in = ssl->session;
4640 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004641 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004642
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 if ((size_t) (end - p) < session_len) {
4644 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4645 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004646
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 ret = ssl_session_load(ssl->session, 1, p, session_len);
4648 if (ret != 0) {
4649 mbedtls_ssl_session_free(ssl->session);
4650 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004651 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004652
4653 p += session_len;
4654
4655 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004656 * Transform
4657 */
4658
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004659 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004660 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004661#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004662 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004663 ssl->transform_in = ssl->transform;
4664 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004665 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004666#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004667
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004668#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4670 if (prf_func == NULL) {
4671 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4672 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004673
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004674 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4676 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4677 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004678
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 ret = ssl_tls12_populate_transform(ssl->transform,
4680 ssl->session->ciphersuite,
4681 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004682#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004684#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 prf_func,
4686 p, /* currently pointing to randbytes */
4687 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4688 ssl->conf->endpoint,
4689 ssl);
4690 if (ret != 0) {
4691 return ret;
4692 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004693#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004695
4696#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4697 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 if ((size_t) (end - p) < 1) {
4699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4700 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004701
4702 ssl->transform->in_cid_len = *p++;
4703
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4705 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4706 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004707
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004709 p += ssl->transform->in_cid_len;
4710
4711 ssl->transform->out_cid_len = *p++;
4712
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4714 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4715 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004716
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004718 p += ssl->transform->out_cid_len;
4719#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4720
4721 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004722 * Saved fields from top-level ssl_context structure
4723 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 if ((size_t) (end - p) < 4) {
4725 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4726 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004727
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004728 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004729 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004730
4731#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 if ((size_t) (end - p) < 16) {
4733 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4734 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004735
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004736 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004737 p += 8;
4738
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004739 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004740 p += 8;
4741#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4742
4743#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 if ((size_t) (end - p) < 1) {
4745 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4746 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004747
4748 ssl->disable_datagram_packing = *p++;
4749#endif /* MBEDTLS_SSL_PROTO_DTLS */
4750
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4752 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4753 }
4754 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4755 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004756
4757#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 if ((size_t) (end - p) < 2) {
4759 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4760 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004761
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004763 p += 2;
4764#endif /* MBEDTLS_SSL_PROTO_DTLS */
4765
4766#if defined(MBEDTLS_SSL_ALPN)
4767 {
4768 uint8_t alpn_len;
4769 const char **cur;
4770
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if ((size_t) (end - p) < 1) {
4772 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4773 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004774
4775 alpn_len = *p++;
4776
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004778 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4780 if (strlen(*cur) == alpn_len &&
4781 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004782 ssl->alpn_chosen = *cur;
4783 break;
4784 }
4785 }
4786 }
4787
4788 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004789 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4790 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4791 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004792
4793 p += alpn_len;
4794 }
4795#endif /* MBEDTLS_SSL_ALPN */
4796
4797 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004798 * Forced fields from top-level ssl_context structure
4799 *
4800 * Most of them already set to the correct value by mbedtls_ssl_init() and
4801 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4802 */
4803 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004804 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004805
Hanno Becker361b10d2019-08-30 10:42:49 +01004806 /* Adjust pointers for header fields of outgoing records to
4807 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004809
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004810#if defined(MBEDTLS_SSL_PROTO_DTLS)
4811 ssl->in_epoch = 1;
4812#endif
4813
4814 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4815 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004816 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4817 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 if (ssl->handshake != NULL) {
4819 mbedtls_ssl_handshake_free(ssl);
4820 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004821 ssl->handshake = NULL;
4822 }
4823
4824 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004825 * Done - should have consumed entire buffer
4826 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 if (p != end) {
4828 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4829 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004830
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004832}
4833
4834/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004835 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004836 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004837int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4838 const unsigned char *buf,
4839 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004840{
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004842
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 if (ret != 0) {
4844 mbedtls_ssl_free(context);
4845 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004846
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004848}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004849#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004850
4851/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004852 * Free an SSL context
4853 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004854void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004855{
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004857 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004859
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004861
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004863#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4864 size_t out_buf_len = ssl->out_buf_len;
4865#else
4866 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4867#endif
4868
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004869 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004870 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004871 }
4872
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004874#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4875 size_t in_buf_len = ssl->in_buf_len;
4876#else
4877 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4878#endif
4879
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004880 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004881 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004882 }
4883
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 if (ssl->transform) {
4885 mbedtls_ssl_transform_free(ssl->transform);
4886 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004887 }
4888
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 if (ssl->handshake) {
4890 mbedtls_ssl_handshake_free(ssl);
4891 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004892
4893#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4895 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004896#endif
4897
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 mbedtls_ssl_session_free(ssl->session_negotiate);
4899 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004900 }
4901
Ronald Cron6f135e12021-12-08 16:57:54 +01004902#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 mbedtls_ssl_transform_free(ssl->transform_application);
4904 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004905#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 if (ssl->session) {
4908 mbedtls_ssl_session_free(ssl->session);
4909 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004910 }
4911
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004912#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004914 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00004915 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004916#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004917
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004918#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004920#endif
4921
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004923
Paul Bakker86f04f42013-02-14 11:20:09 +01004924 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004926}
4927
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004928/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004929 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004930 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004931void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004932{
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004934}
4935
Gilles Peskineae270bf2021-06-02 00:05:29 +02004936/* The selection should be the same as mbedtls_x509_crt_profile_default in
4937 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004938 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004939 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004940 * about this list.
4941 */
Brett Warrene0edc842021-08-17 09:53:13 +01004942static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02004943#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01004944 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004945#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004946#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004947 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004948#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004949#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004950 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004951#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004952#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01004953 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004954#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004955#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004956 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004957#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004958#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004959 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004960#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004961#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004962 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004963#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004964#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004965 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004966#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02004967#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01004968 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
4969 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
4970 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
4971 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
4972 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
4973#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004974 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004975};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004976
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03004977static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004978 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4979 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4980 0
4981};
4982
Ronald Crone68ab4f2022-10-05 12:46:29 +02004983#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004984
Jerry Yu909df7b2022-01-22 11:56:27 +08004985/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004986 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004987 * rules SHOULD be upheld.
4988 * - No duplicate entries.
4989 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004990 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004991 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004992 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004993static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004994
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004995#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004996 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02004997 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08004998 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004999 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5000#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005001
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005002#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005003 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005004 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005005 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005006 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5007#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005008
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005009#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005010 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005011 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005012 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005013 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5014#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005015
Gilles Peskine449bd832023-01-11 14:50:10 +01005016#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005017 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005018 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005019#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005020 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005021
Gilles Peskine449bd832023-01-11 14:50:10 +01005022#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005023 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005024 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005025#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005026 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005027
Gilles Peskine449bd832023-01-11 14:50:10 +01005028#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005029 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005030 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005031#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005032 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005033
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005034#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005035 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005036#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005037
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005038#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005039 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005040#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005041
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005042#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005043 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005044#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005045
Gabor Mezei15b95a62022-05-09 16:37:58 +02005046 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005047};
5048
5049/* NOTICE: see above */
5050#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5051static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005052#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005053#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005055#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005056#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5057 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5058#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005059#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005061#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005062#endif /* MBEDTLS_MD_CAN_SHA512*/
5063#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005064#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005066#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005067#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5068 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5069#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005070#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005072#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005073#endif /* MBEDTLS_MD_CAN_SHA384*/
5074#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005075#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005077#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005078#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5079 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5080#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005081#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005082 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005083#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005084#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005085 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005086};
5087#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5088/* NOTICE: see above */
5089static uint16_t ssl_preset_suiteb_sig_algs[] = {
5090
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005091#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005092 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005093 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005094 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005095 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5096#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005097
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005098#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005099 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005100 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005101 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005102 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5103#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005104
Gilles Peskine449bd832023-01-11 14:50:10 +01005105#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005106 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005107 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005108#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005109 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005110
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005111#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005112 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005113#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005114
Gabor Mezei15b95a62022-05-09 16:37:58 +02005115 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005116};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005117
Jerry Yu909df7b2022-01-22 11:56:27 +08005118/* NOTICE: see above */
5119#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5120static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005121#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005122#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005124#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005125#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005127#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005128#endif /* MBEDTLS_MD_CAN_SHA256*/
5129#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005130#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005132#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005133#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005135#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005136#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005137 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005138};
Jerry Yu909df7b2022-01-22 11:56:27 +08005139#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5140
Ronald Crone68ab4f2022-10-05 12:46:29 +02005141#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005142
Brett Warrene0edc842021-08-17 09:53:13 +01005143static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005144#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005145 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005146#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005147#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005148 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005149#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005150 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005151};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005152
Ronald Crone68ab4f2022-10-05 12:46:29 +02005153#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005154/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005155 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005156MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005157static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005158{
5159 size_t i, j;
5160 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005161
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5163 for (j = 0; j < i; j++) {
5164 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005165 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 }
5167 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5168 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5169 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005170 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005171 }
5172 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005174}
5175
Ronald Crone68ab4f2022-10-05 12:46:29 +02005176#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005177
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005178/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005179 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005180 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005181int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5182 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005183{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005184#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005186#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005187
Ronald Crone68ab4f2022-10-05 12:46:29 +02005188#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5190 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5191 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005192 }
5193
Gilles Peskine449bd832023-01-11 14:50:10 +01005194 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5195 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5196 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005197 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005198
5199#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005200 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5201 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5202 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005203 }
5204
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5206 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5207 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005208 }
5209#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005210#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005211
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005212 /* Use the functions here so that they are covered in tests,
5213 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 mbedtls_ssl_conf_endpoint(conf, endpoint);
5215 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005216
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005217 /*
5218 * Things that are common to all presets
5219 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005220#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005222 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5223#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5224 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5225#endif
5226 }
5227#endif
5228
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005229#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5230 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5231#endif
5232
5233#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5234 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5235#endif
5236
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005237#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005238 conf->f_cookie_write = ssl_cookie_write_dummy;
5239 conf->f_cookie_check = ssl_cookie_check_dummy;
5240#endif
5241
5242#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5243 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5244#endif
5245
Janos Follath088ce432017-04-10 12:42:31 +01005246#if defined(MBEDTLS_SSL_SRV_C)
5247 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005248 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005249#endif
5250
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005251#if defined(MBEDTLS_SSL_PROTO_DTLS)
5252 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5253 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5254#endif
5255
5256#if defined(MBEDTLS_SSL_RENEGOTIATION)
5257 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 memset(conf->renego_period, 0x00, 2);
5259 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005260#endif
5261
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005262#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005264 const unsigned char dhm_p[] =
5265 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5266 const unsigned char dhm_g[] =
5267 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005268
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5270 dhm_p, sizeof(dhm_p),
5271 dhm_g, sizeof(dhm_g))) != 0) {
5272 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005273 }
5274 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005275#endif
5276
Ronald Cron6f135e12021-12-08 16:57:54 +01005277#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005278
5279#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 mbedtls_ssl_tls13_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005281#if defined(MBEDTLS_SSL_SRV_C)
5282 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005284#endif
5285#endif /* MBEDTLS_SSL_EARLY_DATA */
5286
Jerry Yud0766ec2022-09-22 10:46:57 +08005287#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005288 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005290#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005291 /*
5292 * Allow all TLS 1.3 key exchange modes by default.
5293 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005294 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005295#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005296
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005298#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005299 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005300 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005301#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005303#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005305#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005306 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5307 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005308#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5309 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5310 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5311#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5312 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5313 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5314#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005316#endif
5317 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005318
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005319 /*
5320 * Preset-specific defaults
5321 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005323 /*
5324 * NSA Suite B
5325 */
5326 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005327
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005328 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005329
5330#if defined(MBEDTLS_X509_CRT_PARSE_C)
5331 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005332#endif
5333
Ronald Crone68ab4f2022-10-05 12:46:29 +02005334#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005335#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005337 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005339#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005341#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005342
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005343#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005344 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005345#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005346 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005347 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005348
5349 /*
5350 * Default
5351 */
5352 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005353
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005354 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005355
5356#if defined(MBEDTLS_X509_CRT_PARSE_C)
5357 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5358#endif
5359
Ronald Crone68ab4f2022-10-05 12:46:29 +02005360#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005361#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005363 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005365#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005367#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005368
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005369#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005370 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005371#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005372 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005373
5374#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5375 conf->dhm_min_bitlen = 1024;
5376#endif
5377 }
5378
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005380}
5381
5382/*
5383 * Free mbedtls_ssl_config
5384 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005385void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005386{
5387#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 mbedtls_mpi_free(&conf->dhm_P);
5389 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005390#endif
5391
Ronald Cron73fe8df2022-10-05 14:31:43 +02005392#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005393#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005395 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5396 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005397#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005399 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005400 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005401 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005402 }
5403
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005405 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005406 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005407 conf->psk_identity_len = 0;
5408 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005409#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005410
5411#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005413#endif
5414
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005416}
5417
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005418#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005419 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005420/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005421 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005422 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005423unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005424{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005425#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5427 return MBEDTLS_SSL_SIG_RSA;
5428 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005429#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005430#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5432 return MBEDTLS_SSL_SIG_ECDSA;
5433 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005434#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005436}
5437
Gilles Peskine449bd832023-01-11 14:50:10 +01005438unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005439{
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005441 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005443 case MBEDTLS_PK_ECDSA:
5444 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005446 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005447 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005448 }
5449}
5450
Gilles Peskine449bd832023-01-11 14:50:10 +01005451mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005452{
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005454#if defined(MBEDTLS_RSA_C)
5455 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005457#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005458#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005459 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005461#endif
5462 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005464 }
5465}
Valerio Settie9646ec2023-08-02 20:02:28 +02005466#endif /* MBEDTLS_PK_C &&
5467 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005468
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005469/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005470 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005471 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005472mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005473{
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005475#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005476 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005478#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005479#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005480 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005482#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005483#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005484 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005486#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005487#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005488 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005490#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005491#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005492 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005494#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005495#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005496 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005498#endif
5499 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005501 }
5502}
5503
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005504/*
5505 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5506 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005507unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005508{
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005510#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005511 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005513#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005514#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005515 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005517#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005518#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005519 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005521#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005522#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005523 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005525#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005526#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005527 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005528 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005529#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005530#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005531 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005533#endif
5534 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005536 }
5537}
5538
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005539/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005540 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005541 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005542 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005543int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005544{
Gilles Peskine449bd832023-01-11 14:50:10 +01005545 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005546
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 if (group_list == NULL) {
5548 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005549 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005550
Gilles Peskine449bd832023-01-11 14:50:10 +01005551 for (; *group_list != 0; group_list++) {
5552 if (*group_list == tls_id) {
5553 return 0;
5554 }
5555 }
5556
5557 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005558}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005559
Valerio Setti49e69072023-06-27 17:27:51 +02005560#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005561/*
5562 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5563 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005564int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005565{
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005567
Gilles Peskine449bd832023-01-11 14:50:10 +01005568 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005569 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005571
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005573}
Valerio Setti49e69072023-06-27 17:27:51 +02005574#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005575
Valerio Setti18c9fed2022-12-30 17:44:24 +01005576static const struct {
5577 uint16_t tls_id;
5578 mbedtls_ecp_group_id ecp_group_id;
5579 psa_ecc_family_t psa_family;
5580 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005581} tls_id_match_table[] =
5582{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005583#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005584 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005585#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005586#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005587 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005588#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005589#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005590 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005591#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005592#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005593 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005594#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005595#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005596 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005597#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005598#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005599 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005600#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005601#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005602 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005603#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005604#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005605 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005606#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005607#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005608 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005609#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005610#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005611 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005612#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005613#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005614 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005615#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005616#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005617 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005618#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005619#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005620 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005621#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005622 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005623};
5624
Gilles Peskine449bd832023-01-11 14:50:10 +01005625int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005626 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005627 size_t *bits)
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) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005631 if (type != NULL) {
5632 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 }
5634 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005635 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005636 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005637 return PSA_SUCCESS;
5638 }
5639 }
5640
5641 return PSA_ERROR_NOT_SUPPORTED;
5642}
5643
Gilles Peskine449bd832023-01-11 14:50:10 +01005644mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005645{
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5647 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005648 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005650 }
5651
5652 return MBEDTLS_ECP_DP_NONE;
5653}
5654
Gilles Peskine449bd832023-01-11 14:50:10 +01005655uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005656{
Gilles Peskine449bd832023-01-11 14:50:10 +01005657 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5658 i++) {
5659 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005660 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005662 }
5663
5664 return 0;
5665}
5666
Valerio Setti67419f02023-01-04 16:12:42 +01005667#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005668static const struct {
5669 uint16_t tls_id;
5670 const char *name;
5671} tls_id_curve_name_table[] =
5672{
Valerio Setti54e23792023-07-07 10:49:27 +02005673 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5674 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5675 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5676 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5677 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5678 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5679 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5680 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5681 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5682 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5683 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5684 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5685 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005686 { 0, NULL },
5687};
5688
Gilles Peskine449bd832023-01-11 14:50:10 +01005689const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005690{
Valerio Settiacd32c02023-06-29 18:06:29 +02005691 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5692 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5693 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005695 }
5696
5697 return NULL;
5698}
Valerio Setti67419f02023-01-04 16:12:42 +01005699#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005700
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005701#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005702int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5703 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5704 int cert_endpoint,
5705 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005706{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005707 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005708 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005709 const char *ext_oid;
5710 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005711
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005713 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005715 case MBEDTLS_KEY_EXCHANGE_RSA:
5716 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005717 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005718 break;
5719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005720 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5721 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5722 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5723 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005724 break;
5725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005726 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5727 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005728 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005729 break;
5730
5731 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005732 case MBEDTLS_KEY_EXCHANGE_NONE:
5733 case MBEDTLS_KEY_EXCHANGE_PSK:
5734 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5735 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005736 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005737 usage = 0;
5738 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005740 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5741 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005742 }
5743
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005745 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005746 ret = -1;
5747 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005748
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005750 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5752 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005753 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005755 }
5756
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005758 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005759 ret = -1;
5760 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005761
Gilles Peskine449bd832023-01-11 14:50:10 +01005762 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005763}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005764#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005765
Jerry Yu148165c2021-09-24 23:20:59 +08005766#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005767int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5768 const mbedtls_md_type_t md,
5769 unsigned char *dst,
5770 size_t dst_len,
5771 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005772{
Ronald Cronf6893e12022-01-07 22:09:01 +01005773 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5774 psa_hash_operation_t *hash_operation_to_clone;
5775 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5776
Jerry Yu148165c2021-09-24 23:20:59 +08005777 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005778
Gilles Peskine449bd832023-01-11 14:50:10 +01005779 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005780#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 case MBEDTLS_MD_SHA384:
5782 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5783 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005784#endif
5785
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005786#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005787 case MBEDTLS_MD_SHA256:
5788 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5789 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005790#endif
5791
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 default:
5793 goto exit;
5794 }
5795
5796 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5797 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005798 goto exit;
5799 }
5800
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5802 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005803 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005804 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005805
5806exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005807#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5808 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005809 (void) ssl;
5810#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005811 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005812}
5813#else /* MBEDTLS_USE_PSA_CRYPTO */
5814
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005815#if defined(MBEDTLS_MD_CAN_SHA384)
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_sha384(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é-Gonnard02d55d52023-02-24 13:21:16 +01005823 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005824
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 if (dst_len < 48) {
5826 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5827 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005828
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005829 mbedtls_md_init(&sha384);
5830 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005831 if (ret != 0) {
5832 goto exit;
5833 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005834 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005835 if (ret != 0) {
5836 goto exit;
5837 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005838
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005839 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005840 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005841 goto exit;
5842 }
5843
5844 *olen = 48;
5845
5846exit:
5847
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005848 mbedtls_md_free(&sha384);
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_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005852
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005853#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005854MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005855static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5856 unsigned char *dst,
5857 size_t dst_len,
5858 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005859{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005860 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005861 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005862
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 if (dst_len < 32) {
5864 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5865 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005866
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005867 mbedtls_md_init(&sha256);
5868 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5869 if (ret != 0) {
5870 goto exit;
5871 }
5872 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5873 if (ret != 0) {
5874 goto exit;
5875 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005876
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005877 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5878 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005879 goto exit;
5880 }
5881
5882 *olen = 32;
5883
5884exit:
5885
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005886 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005888}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005889#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005890
Gilles Peskine449bd832023-01-11 14:50:10 +01005891int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5892 const mbedtls_md_type_t md,
5893 unsigned char *dst,
5894 size_t dst_len,
5895 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005896{
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005898
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005899#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 case MBEDTLS_MD_SHA384:
5901 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005902#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005903
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005904#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005905 case MBEDTLS_MD_SHA256:
5906 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005907#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005908
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005910#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5911 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 (void) ssl;
5913 (void) dst;
5914 (void) dst_len;
5915 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005916#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005917 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005918 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005920}
XiaokangQian647719a2021-12-07 09:16:29 +00005921
Jerry Yu148165c2021-09-24 23:20:59 +08005922#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005923
Ronald Crone68ab4f2022-10-05 12:46:29 +02005924#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005925/* mbedtls_ssl_parse_sig_alg_ext()
5926 *
5927 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5928 * value (TLS 1.3 RFC8446):
5929 * enum {
5930 * ....
5931 * ecdsa_secp256r1_sha256( 0x0403 ),
5932 * ecdsa_secp384r1_sha384( 0x0503 ),
5933 * ecdsa_secp521r1_sha512( 0x0603 ),
5934 * ....
5935 * } SignatureScheme;
5936 *
5937 * struct {
5938 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5939 * } SignatureSchemeList;
5940 *
5941 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5942 * value (TLS 1.2 RFC5246):
5943 * enum {
5944 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5945 * sha512(6), (255)
5946 * } HashAlgorithm;
5947 *
5948 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5949 * SignatureAlgorithm;
5950 *
5951 * struct {
5952 * HashAlgorithm hash;
5953 * SignatureAlgorithm signature;
5954 * } SignatureAndHashAlgorithm;
5955 *
5956 * SignatureAndHashAlgorithm
5957 * supported_signature_algorithms<2..2^16-2>;
5958 *
5959 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5960 * generalization of the TLS 1.2 signature algorithm extension.
5961 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5962 * `SignatureScheme` field of TLS 1.3
5963 *
5964 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005965int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5966 const unsigned char *buf,
5967 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005968{
5969 const unsigned char *p = buf;
5970 size_t supported_sig_algs_len = 0;
5971 const unsigned char *supported_sig_algs_end;
5972 uint16_t sig_alg;
5973 uint32_t common_idx = 0;
5974
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5976 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005977 p += 2;
5978
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 memset(ssl->handshake->received_sig_algs, 0,
5980 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005981
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005983 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005984 while (p < supported_sig_algs_end) {
5985 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5986 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005987 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5989 sig_alg,
5990 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005991#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5993 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5994 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005995 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005996 }
5997#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005998
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6000 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006001
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006003 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6004 common_idx += 1;
6005 }
6006 }
6007 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 if (p != end) {
6009 MBEDTLS_SSL_DEBUG_MSG(1,
6010 ("Signature algorithms extension length misaligned"));
6011 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6012 MBEDTLS_ERR_SSL_DECODE_ERROR);
6013 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006014 }
6015
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 if (common_idx == 0) {
6017 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6018 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6019 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6020 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006021 }
6022
Gabor Mezei15b95a62022-05-09 16:37:58 +02006023 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006025}
6026
Ronald Crone68ab4f2022-10-05 12:46:29 +02006027#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006028
Jerry Yudc7bd172022-02-17 13:44:15 +08006029#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6030
6031#if defined(MBEDTLS_USE_PSA_CRYPTO)
6032
Gilles Peskine449bd832023-01-11 14:50:10 +01006033static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6034 mbedtls_svc_key_id_t key,
6035 psa_algorithm_t alg,
6036 const unsigned char *raw_psk, size_t raw_psk_length,
6037 const unsigned char *seed, size_t seed_length,
6038 const unsigned char *label, size_t label_length,
6039 const unsigned char *other_secret,
6040 size_t other_secret_length,
6041 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006042{
6043 psa_status_t status;
6044
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 status = psa_key_derivation_setup(derivation, alg);
6046 if (status != PSA_SUCCESS) {
6047 return status;
6048 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006049
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6051 status = psa_key_derivation_input_bytes(derivation,
6052 PSA_KEY_DERIVATION_INPUT_SEED,
6053 seed, seed_length);
6054 if (status != PSA_SUCCESS) {
6055 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006056 }
6057
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 if (other_secret != NULL) {
6059 status = psa_key_derivation_input_bytes(derivation,
6060 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6061 other_secret, other_secret_length);
6062 if (status != PSA_SUCCESS) {
6063 return status;
6064 }
6065 }
6066
6067 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006068 status = psa_key_derivation_input_bytes(
6069 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 raw_psk, raw_psk_length);
6071 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006072 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006074 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 if (status != PSA_SUCCESS) {
6076 return status;
6077 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006078
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 status = psa_key_derivation_input_bytes(derivation,
6080 PSA_KEY_DERIVATION_INPUT_LABEL,
6081 label, label_length);
6082 if (status != PSA_SUCCESS) {
6083 return status;
6084 }
6085 } else {
6086 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006087 }
6088
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 status = psa_key_derivation_set_capacity(derivation, capacity);
6090 if (status != PSA_SUCCESS) {
6091 return status;
6092 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006093
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006095}
6096
Andrzej Kurek57d10632022-10-24 10:32:01 -04006097#if defined(PSA_WANT_ALG_SHA_384) || \
6098 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006099MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006100static int tls_prf_generic(mbedtls_md_type_t md_type,
6101 const unsigned char *secret, size_t slen,
6102 const char *label,
6103 const unsigned char *random, size_t rlen,
6104 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006105{
6106 psa_status_t status;
6107 psa_algorithm_t alg;
6108 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6109 psa_key_derivation_operation_t derivation =
6110 PSA_KEY_DERIVATION_OPERATION_INIT;
6111
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006113 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006115 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006117
6118 /* Normally a "secret" should be long enough to be impossible to
6119 * find by brute force, and in particular should not be empty. But
6120 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6121 * and for this use case it makes sense to have a 0-length "secret".
6122 * Since the key API doesn't allow importing a key of length 0,
6123 * keep master_key=0, which setup_psa_key_derivation() understands
6124 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006126 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006127 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6128 psa_set_key_algorithm(&key_attributes, alg);
6129 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006130
Gilles Peskine449bd832023-01-11 14:50:10 +01006131 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6132 if (status != PSA_SUCCESS) {
6133 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6134 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006135 }
6136
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 status = setup_psa_key_derivation(&derivation,
6138 master_key, alg,
6139 NULL, 0,
6140 random, rlen,
6141 (unsigned char const *) label,
6142 (size_t) strlen(label),
6143 NULL, 0,
6144 dlen);
6145 if (status != PSA_SUCCESS) {
6146 psa_key_derivation_abort(&derivation);
6147 psa_destroy_key(master_key);
6148 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006149 }
6150
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6152 if (status != PSA_SUCCESS) {
6153 psa_key_derivation_abort(&derivation);
6154 psa_destroy_key(master_key);
6155 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006156 }
6157
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 status = psa_key_derivation_abort(&derivation);
6159 if (status != PSA_SUCCESS) {
6160 psa_destroy_key(master_key);
6161 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006162 }
6163
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 if (!mbedtls_svc_key_id_is_null(master_key)) {
6165 status = psa_destroy_key(master_key);
6166 }
6167 if (status != PSA_SUCCESS) {
6168 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6169 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006170
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006172}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006173#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006174#else /* MBEDTLS_USE_PSA_CRYPTO */
6175
Andrzej Kurek57d10632022-10-24 10:32:01 -04006176#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006177 (defined(MBEDTLS_MD_CAN_SHA256) || \
6178 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006179MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006180static int tls_prf_generic(mbedtls_md_type_t md_type,
6181 const unsigned char *secret, size_t slen,
6182 const char *label,
6183 const unsigned char *random, size_t rlen,
6184 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006185{
6186 size_t nb;
6187 size_t i, j, k, md_len;
6188 unsigned char *tmp;
6189 size_t tmp_len = 0;
6190 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6191 const mbedtls_md_info_t *md_info;
6192 mbedtls_md_context_t md_ctx;
6193 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6194
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006196
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6198 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6199 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006200
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006202
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 tmp_len = md_len + strlen(label) + rlen;
6204 tmp = mbedtls_calloc(1, tmp_len);
6205 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006206 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6207 goto exit;
6208 }
6209
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 nb = strlen(label);
6211 memcpy(tmp + md_len, label, nb);
6212 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006213 nb += rlen;
6214
6215 /*
6216 * Compute P_<hash>(secret, label + random)[0..dlen]
6217 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006219 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006221
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6223 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006224 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006225 }
6226 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6227 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006228 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 }
6230 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6231 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006232 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006234
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 for (i = 0; i < dlen; i += md_len) {
6236 ret = mbedtls_md_hmac_reset(&md_ctx);
6237 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006238 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 }
6240 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6241 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006242 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 }
6244 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6245 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006246 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006248
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 ret = mbedtls_md_hmac_reset(&md_ctx);
6250 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006251 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006252 }
6253 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6254 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006255 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 }
6257 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6258 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006259 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006261
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006263
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006265 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006267 }
6268
6269exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006271
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 if (tmp != NULL) {
6273 mbedtls_platform_zeroize(tmp, tmp_len);
6274 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006275
Gilles Peskine449bd832023-01-11 14:50:10 +01006276 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006277
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006279
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006281}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006282#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006283#endif /* MBEDTLS_USE_PSA_CRYPTO */
6284
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006285#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006286MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006287static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6288 const char *label,
6289 const unsigned char *random, size_t rlen,
6290 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006291{
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6293 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006294}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006295#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006296
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006297#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006298MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006299static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6300 const char *label,
6301 const unsigned char *random, size_t rlen,
6302 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006303{
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6305 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006306}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006307#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006308
Jerry Yuf009d862022-02-17 14:01:37 +08006309/*
6310 * Set appropriate PRF function and other SSL / TLS1.2 functions
6311 *
6312 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006313 * - hash associated with the ciphersuite (only used by TLS 1.2)
6314 *
6315 * Outputs:
6316 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6317 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006318MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006319static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6320 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006321{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006322#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006324 handshake->tls_prf = tls_prf_sha384;
6325 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6326 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006328#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006329#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006330 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006331 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006332 handshake->tls_prf = tls_prf_sha256;
6333 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6334 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6335 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006336#else
Jerry Yuf009d862022-02-17 14:01:37 +08006337 {
Jerry Yuf009d862022-02-17 14:01:37 +08006338 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006339 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006340 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006341 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006342#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006343
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006345}
Jerry Yud6ab2352022-02-17 14:03:43 +08006346
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006347/*
6348 * Compute master secret if needed
6349 *
6350 * Parameters:
6351 * [in/out] handshake
6352 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6353 * (PSA-PSK) ciphersuite_info, psk_opaque
6354 * [out] premaster (cleared)
6355 * [out] master
6356 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6357 * debug: conf->f_dbg, conf->p_dbg
6358 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006359 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006360 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006361MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006362static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6363 unsigned char *master,
6364 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006365{
6366 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6367
6368 /* cf. RFC 5246, Section 8.1:
6369 * "The master secret is always exactly 48 bytes in length." */
6370 size_t const master_secret_len = 48;
6371
6372#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6373 unsigned char session_hash[48];
6374#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6375
6376 /* The label for the KDF used for key expansion.
6377 * This is either "master secret" or "extended master secret"
6378 * depending on whether the Extended Master Secret extension
6379 * is used. */
6380 char const *lbl = "master secret";
6381
Przemek Stekielae4ed302022-04-05 17:15:55 +02006382 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006383 * - If the Extended Master Secret extension is not used,
6384 * this is ClientHello.Random + ServerHello.Random
6385 * (see Sect. 8.1 in RFC 5246).
6386 * - If the Extended Master Secret extension is used,
6387 * this is the transcript of the handshake so far.
6388 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006389 unsigned char const *seed = handshake->randbytes;
6390 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006391
6392#if !defined(MBEDTLS_DEBUG_C) && \
6393 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6394 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006395 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006396 ssl = NULL; /* make sure we don't use it except for those cases */
6397 (void) ssl;
6398#endif
6399
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 if (handshake->resume != 0) {
6401 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6402 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006403 }
6404
6405#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006407 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006408 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006409 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6410 if (ret != 0) {
6411 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6412 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006413
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6415 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006416 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006417#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006418
Przemek Stekiel99114f32022-04-22 11:20:09 +02006419#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006420 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006422 /* Perform PSK-to-MS expansion in a single step. */
6423 psa_status_t status;
6424 psa_algorithm_t alg;
6425 mbedtls_svc_key_id_t psk;
6426 psa_key_derivation_operation_t derivation =
6427 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006428 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006429
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006431
Gilles Peskine449bd832023-01-11 14:50:10 +01006432 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006433
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006435 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006437 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006439
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006440 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006442
Gilles Peskine449bd832023-01-11 14:50:10 +01006443 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006444 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006445 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006446 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006447 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006448 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006449 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006450 other_secret_len = 48;
6451 other_secret = handshake->premaster + 2;
6452 break;
6453 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006454 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006455 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6456 other_secret = handshake->premaster + 2;
6457 break;
6458 default:
6459 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006460 }
6461
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 status = setup_psa_key_derivation(&derivation, psk, alg,
6463 ssl->conf->psk, ssl->conf->psk_len,
6464 seed, seed_len,
6465 (unsigned char const *) lbl,
6466 (size_t) strlen(lbl),
6467 other_secret, other_secret_len,
6468 master_secret_len);
6469 if (status != PSA_SUCCESS) {
6470 psa_key_derivation_abort(&derivation);
6471 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006472 }
6473
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 status = psa_key_derivation_output_bytes(&derivation,
6475 master,
6476 master_secret_len);
6477 if (status != PSA_SUCCESS) {
6478 psa_key_derivation_abort(&derivation);
6479 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006480 }
6481
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 status = psa_key_derivation_abort(&derivation);
6483 if (status != PSA_SUCCESS) {
6484 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6485 }
6486 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006487#endif
6488 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006489#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6491 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006492 psa_status_t status;
6493 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6494 psa_key_derivation_operation_t derivation =
6495 PSA_KEY_DERIVATION_OPERATION_INIT;
6496
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006498
6499 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6500
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 status = psa_key_derivation_setup(&derivation, alg);
6502 if (status != PSA_SUCCESS) {
6503 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006504 }
6505
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 status = psa_key_derivation_set_capacity(&derivation,
6507 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6508 if (status != PSA_SUCCESS) {
6509 psa_key_derivation_abort(&derivation);
6510 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006511 }
6512
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6514 &derivation);
6515 if (status != PSA_SUCCESS) {
6516 psa_key_derivation_abort(&derivation);
6517 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006518 }
6519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 status = psa_key_derivation_output_bytes(&derivation,
6521 handshake->premaster,
6522 handshake->pmslen);
6523 if (status != PSA_SUCCESS) {
6524 psa_key_derivation_abort(&derivation);
6525 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6526 }
6527
6528 status = psa_key_derivation_abort(&derivation);
6529 if (status != PSA_SUCCESS) {
6530 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006531 }
6532 }
6533#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6535 lbl, seed, seed_len,
6536 master,
6537 master_secret_len);
6538 if (ret != 0) {
6539 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6540 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006541 }
6542
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6544 handshake->premaster,
6545 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006546
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 mbedtls_platform_zeroize(handshake->premaster,
6548 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006549 }
6550
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006552}
6553
Gilles Peskine449bd832023-01-11 14:50:10 +01006554int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006555{
6556 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6557 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6558 ssl->handshake->ciphersuite_info;
6559
Gilles Peskine449bd832023-01-11 14:50:10 +01006560 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006561
6562 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006564 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 if (ret != 0) {
6566 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6567 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006568 }
6569
6570 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 ret = ssl_compute_master(ssl->handshake,
6572 ssl->session_negotiate->master,
6573 ssl);
6574 if (ret != 0) {
6575 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6576 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006577 }
6578
6579 /* Swap the client and server random values:
6580 * - MS derivation wanted client+server (RFC 5246 8.1)
6581 * - key derivation wants server+client (RFC 5246 6.3) */
6582 {
6583 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 memcpy(tmp, ssl->handshake->randbytes, 64);
6585 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6586 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6587 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006588 }
6589
6590 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6592 ssl->session_negotiate->ciphersuite,
6593 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006594#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006596#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006597 ssl->handshake->tls_prf,
6598 ssl->handshake->randbytes,
6599 ssl->tls_version,
6600 ssl->conf->endpoint,
6601 ssl);
6602 if (ret != 0) {
6603 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6604 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006605 }
6606
6607 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006608 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6609 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006610
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006612
Gilles Peskine449bd832023-01-11 14:50:10 +01006613 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006614}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006615
Gilles Peskine449bd832023-01-11 14:50:10 +01006616int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006617{
Gilles Peskine449bd832023-01-11 14:50:10 +01006618 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006619#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006620 case MBEDTLS_SSL_HASH_SHA384:
6621 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6622 break;
6623#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006624#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006625 case MBEDTLS_SSL_HASH_SHA256:
6626 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6627 break;
6628#endif
6629 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006630 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006631 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006632#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6633 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006634 (void) ssl;
6635#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006637}
6638
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006639#if defined(MBEDTLS_USE_PSA_CRYPTO)
6640static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6641 const psa_hash_operation_t *hs_op,
6642 size_t buffer_size,
6643 unsigned char *hash,
6644 size_t *hlen)
6645{
6646 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006647 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006648
6649#if !defined(MBEDTLS_DEBUG_C)
6650 (void) ssl;
6651#endif
6652 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006653 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006654 if (status != PSA_SUCCESS) {
6655 goto exit;
6656 }
6657
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006658 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006659 if (status != PSA_SUCCESS) {
6660 goto exit;
6661 }
6662
6663 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6664 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6665
6666exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006667 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006668 return mbedtls_md_error_from_psa(status);
6669}
6670#else
6671static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6672 const mbedtls_md_context_t *hs_ctx,
6673 unsigned char *hash,
6674 size_t *hlen)
6675{
6676 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006677 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006678
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006679 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006680
6681#if !defined(MBEDTLS_DEBUG_C)
6682 (void) ssl;
6683#endif
6684 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6685
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006686 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006687 if (ret != 0) {
6688 goto exit;
6689 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006690 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006691 if (ret != 0) {
6692 goto exit;
6693 }
6694
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006695 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006696 if (ret != 0) {
6697 goto exit;
6698 }
6699
6700 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6701
6702 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6703 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6704
6705exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006706 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006707 return ret;
6708}
6709#endif /* MBEDTLS_USE_PSA_CRYPTO */
6710
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006711#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006712int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6713 unsigned char *hash,
6714 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006715{
6716#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006717 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6718 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006719#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006720 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6721 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006722#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006723}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006724#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006725
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006726#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006727int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6728 unsigned char *hash,
6729 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006730{
6731#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006732 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6733 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006734#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006735 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6736 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006737#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006738}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006739#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006740
Neil Armstrong80f6f322022-05-03 17:56:38 +02006741#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6742 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006743int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006744{
6745 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006747 const unsigned char *psk = NULL;
6748 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006750
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006752 /*
6753 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006754 * checked before calling this function.
6755 *
6756 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006757 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006758 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6760 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6761 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006762 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006763 }
6764
6765 /*
6766 * PMS = struct {
6767 * opaque other_secret<0..2^16-1>;
6768 * opaque psk<0..2^16-1>;
6769 * };
6770 * with "other_secret" depending on the particular key exchange
6771 */
6772#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6774 if (end - p < 2) {
6775 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6776 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006777
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006779 p += 2;
6780
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 if (end < p || (size_t) (end - p) < psk_len) {
6782 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6783 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006784
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006786 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006788#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6789#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006791 /*
6792 * other_secret already set by the ClientKeyExchange message,
6793 * and is 48 bytes long
6794 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006795 if (end - p < 2) {
6796 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6797 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006798
6799 *p++ = 0;
6800 *p++ = 48;
6801 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006802 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006803#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6804#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006805 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006806 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6807 size_t len;
6808
6809 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6811 p + 2, end - (p + 2), &len,
6812 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6813 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6814 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006815 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006817 p += 2 + len;
6818
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6820 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006821#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006822#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006823 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006824 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6825 size_t zlen;
6826
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6828 p + 2, end - (p + 2),
6829 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6830 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6831 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006832 }
6833
Gilles Peskine449bd832023-01-11 14:50:10 +01006834 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006835 p += 2 + zlen;
6836
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6838 MBEDTLS_DEBUG_ECDH_Z);
6839 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006840#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006841 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6843 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006844 }
6845
6846 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 if (end - p < 2) {
6848 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6849 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006850
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006852 p += 2;
6853
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 if (end < p || (size_t) (end - p) < psk_len) {
6855 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6856 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006857
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006859 p += psk_len;
6860
6861 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6862
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006864}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006865#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006866
6867#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006868MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006869static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006870
6871#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006872int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006873{
6874 /* If renegotiation is not enforced, retransmit until we would reach max
6875 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006877 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6878 unsigned char doublings = 1;
6879
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006881 ++doublings;
6882 ratio >>= 1;
6883 }
6884
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 if (++ssl->renego_records_seen > doublings) {
6886 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6887 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006888 }
6889 }
6890
Gilles Peskine449bd832023-01-11 14:50:10 +01006891 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006892}
6893#endif
6894#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006895
Jerry Yud9526692022-02-17 14:23:47 +08006896/*
6897 * Handshake functions
6898 */
6899#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6900/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006901int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006902{
6903 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6904 ssl->handshake->ciphersuite_info;
6905
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6909 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006910 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006912 }
6913
Gilles Peskine449bd832023-01-11 14:50:10 +01006914 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6915 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006916}
6917
Gilles Peskine449bd832023-01-11 14:50:10 +01006918int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006919{
6920 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6921 ssl->handshake->ciphersuite_info;
6922
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006924
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6926 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006927 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006929 }
6930
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6932 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006933}
6934
6935#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6936/* Some certificate support -> implement write and parse */
6937
Gilles Peskine449bd832023-01-11 14:50:10 +01006938int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006939{
6940 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6941 size_t i, n;
6942 const mbedtls_x509_crt *crt;
6943 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6944 ssl->handshake->ciphersuite_info;
6945
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006947
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6949 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006950 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006952 }
6953
6954#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6956 if (ssl->handshake->client_auth == 0) {
6957 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006958 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006960 }
6961 }
6962#endif /* MBEDTLS_SSL_CLI_C */
6963#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6965 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006966 /* Should never happen because we shouldn't have picked the
6967 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006969 }
6970 }
6971#endif
6972
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006974
6975 /*
6976 * 0 . 0 handshake type
6977 * 1 . 3 handshake length
6978 * 4 . 6 length of all certs
6979 * 7 . 9 length of cert. 1
6980 * 10 . n-1 peer certificate
6981 * n . n+2 length of cert. 2
6982 * n+3 . ... upper level cert, etc.
6983 */
6984 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006985 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006986
Gilles Peskine449bd832023-01-11 14:50:10 +01006987 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006988 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006989 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6990 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6991 " > %" MBEDTLS_PRINTF_SIZET,
6992 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6993 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006994 }
6995
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6997 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6998 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006999
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007001 i += n; crt = crt->next;
7002 }
7003
Gilles Peskine449bd832023-01-11 14:50:10 +01007004 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7005 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7006 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007007
7008 ssl->out_msglen = i;
7009 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7010 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7011
7012 ssl->state++;
7013
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7015 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7016 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007017 }
7018
Gilles Peskine449bd832023-01-11 14:50:10 +01007019 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007020
Gilles Peskine449bd832023-01-11 14:50:10 +01007021 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007022}
7023
7024#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7025
7026#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007027MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007028static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7029 unsigned char *crt_buf,
7030 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007031{
7032 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7033
Gilles Peskine449bd832023-01-11 14:50:10 +01007034 if (peer_crt == NULL) {
7035 return -1;
7036 }
Jerry Yud9526692022-02-17 14:23:47 +08007037
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 if (peer_crt->raw.len != crt_buf_len) {
7039 return -1;
7040 }
Jerry Yud9526692022-02-17 14:23:47 +08007041
Gilles Peskine449bd832023-01-11 14:50:10 +01007042 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007043}
7044#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007045MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007046static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7047 unsigned char *crt_buf,
7048 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007049{
7050 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7051 unsigned char const * const peer_cert_digest =
7052 ssl->session->peer_cert_digest;
7053 mbedtls_md_type_t const peer_cert_digest_type =
7054 ssl->session->peer_cert_digest_type;
7055 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007057 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7058 size_t digest_len;
7059
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 if (peer_cert_digest == NULL || digest_info == NULL) {
7061 return -1;
7062 }
Jerry Yud9526692022-02-17 14:23:47 +08007063
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 digest_len = mbedtls_md_get_size(digest_info);
7065 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7066 return -1;
7067 }
Jerry Yud9526692022-02-17 14:23:47 +08007068
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7070 if (ret != 0) {
7071 return -1;
7072 }
Jerry Yud9526692022-02-17 14:23:47 +08007073
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007075}
7076#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7077#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7078
7079/*
7080 * Once the certificate message is read, parse it into a cert chain and
7081 * perform basic checks, but leave actual verification to the caller
7082 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007083MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007084static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7085 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007086{
7087 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7088#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007090#endif
7091 size_t i, n;
7092 uint8_t alert;
7093
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7095 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7096 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7097 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7098 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007099 }
7100
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7102 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7103 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7104 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007105 }
7106
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7108 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7109 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7110 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7111 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007112 }
7113
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007115
7116 /*
7117 * Same message structure as in mbedtls_ssl_write_certificate()
7118 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007120
Gilles Peskine449bd832023-01-11 14:50:10 +01007121 if (ssl->in_msg[i] != 0 ||
7122 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7123 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7124 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7125 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7126 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007127 }
7128
7129 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7130 i += 3;
7131
7132 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007134 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 if (i + 3 > ssl->in_hslen) {
7136 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7137 mbedtls_ssl_send_alert_message(ssl,
7138 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7139 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7140 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007141 }
7142 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7143 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 if (ssl->in_msg[i] != 0) {
7145 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7146 mbedtls_ssl_send_alert_message(ssl,
7147 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7148 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7149 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007150 }
7151
7152 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007153 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007154 | (unsigned int) ssl->in_msg[i + 2];
7155 i += 3;
7156
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 if (n < 128 || i + n > ssl->in_hslen) {
7158 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7159 mbedtls_ssl_send_alert_message(ssl,
7160 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7161 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7162 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007163 }
7164
7165 /* Check if we're handling the first CRT in the chain. */
7166#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007167 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007168 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007170 /* During client-side renegotiation, check that the server's
7171 * end-CRTs hasn't changed compared to the initial handshake,
7172 * mitigating the triple handshake attack. On success, reuse
7173 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7175 if (ssl_check_peer_crt_unchanged(ssl,
7176 &ssl->in_msg[i],
7177 n) != 0) {
7178 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7179 mbedtls_ssl_send_alert_message(ssl,
7180 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7181 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7182 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007183 }
7184
7185 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007186 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007187 }
7188#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7189
7190 /* Parse the next certificate in the chain. */
7191#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007193#else
7194 /* If we don't need to store the CRT chain permanently, parse
7195 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007196 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007197#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007198 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007199 case 0: /*ok*/
7200 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7201 /* Ignore certificate with an unknown algorithm: maybe a
7202 prior certificate was already trusted. */
7203 break;
7204
7205 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7206 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7207 goto crt_parse_der_failed;
7208
7209 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7210 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7211 goto crt_parse_der_failed;
7212
7213 default:
7214 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007215crt_parse_der_failed:
7216 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7217 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7218 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007219 }
7220
7221 i += n;
7222 }
7223
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7225 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007226}
7227
7228#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007229MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007230static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007231{
Gilles Peskine449bd832023-01-11 14:50:10 +01007232 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7233 return -1;
7234 }
Jerry Yud9526692022-02-17 14:23:47 +08007235
Gilles Peskine449bd832023-01-11 14:50:10 +01007236 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007237 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7238 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7240 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7241 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007242 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007243 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007244}
7245#endif /* MBEDTLS_SSL_SRV_C */
7246
7247/* Check if a certificate message is expected.
7248 * Return either
7249 * - SSL_CERTIFICATE_EXPECTED, or
7250 * - SSL_CERTIFICATE_SKIP
7251 * indicating whether a Certificate message is expected or not.
7252 */
7253#define SSL_CERTIFICATE_EXPECTED 0
7254#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007255MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007256static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7257 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007258{
7259 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7260 ssl->handshake->ciphersuite_info;
7261
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7263 return SSL_CERTIFICATE_SKIP;
7264 }
Jerry Yud9526692022-02-17 14:23:47 +08007265
7266#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007267 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7268 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7269 return SSL_CERTIFICATE_SKIP;
7270 }
Jerry Yud9526692022-02-17 14:23:47 +08007271
Gilles Peskine449bd832023-01-11 14:50:10 +01007272 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007273 ssl->session_negotiate->verify_result =
7274 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007276 }
7277 }
7278#else
7279 ((void) authmode);
7280#endif /* MBEDTLS_SSL_SRV_C */
7281
Gilles Peskine449bd832023-01-11 14:50:10 +01007282 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007283}
7284
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007285MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007286static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7287 int authmode,
7288 mbedtls_x509_crt *chain,
7289 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007290{
7291 int ret = 0;
7292 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7293 ssl->handshake->ciphersuite_info;
7294 int have_ca_chain = 0;
7295
7296 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7297 void *p_vrfy;
7298
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7300 return 0;
7301 }
Jerry Yud9526692022-02-17 14:23:47 +08007302
Gilles Peskine449bd832023-01-11 14:50:10 +01007303 if (ssl->f_vrfy != NULL) {
7304 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007305 f_vrfy = ssl->f_vrfy;
7306 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 } else {
7308 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007309 f_vrfy = ssl->conf->f_vrfy;
7310 p_vrfy = ssl->conf->p_vrfy;
7311 }
7312
7313 /*
7314 * Main check: verify certificate
7315 */
7316#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007318 ((void) rs_ctx);
7319 have_ca_chain = 1;
7320
Gilles Peskine449bd832023-01-11 14:50:10 +01007321 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007322 ret = mbedtls_x509_crt_verify_with_ca_cb(
7323 chain,
7324 ssl->conf->f_ca_cb,
7325 ssl->conf->p_ca_cb,
7326 ssl->conf->cert_profile,
7327 ssl->hostname,
7328 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 f_vrfy, p_vrfy);
7330 } else
Jerry Yud9526692022-02-17 14:23:47 +08007331#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7332 {
7333 mbedtls_x509_crt *ca_chain;
7334 mbedtls_x509_crl *ca_crl;
7335
7336#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007337 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007338 ca_chain = ssl->handshake->sni_ca_chain;
7339 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007340 } else
Jerry Yud9526692022-02-17 14:23:47 +08007341#endif
7342 {
7343 ca_chain = ssl->conf->ca_chain;
7344 ca_crl = ssl->conf->ca_crl;
7345 }
7346
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007348 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007349 }
Jerry Yud9526692022-02-17 14:23:47 +08007350
7351 ret = mbedtls_x509_crt_verify_restartable(
7352 chain,
7353 ca_chain, ca_crl,
7354 ssl->conf->cert_profile,
7355 ssl->hostname,
7356 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007357 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007358 }
7359
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 if (ret != 0) {
7361 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007362 }
7363
7364#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7366 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7367 }
Jerry Yud9526692022-02-17 14:23:47 +08007368#endif
7369
7370 /*
7371 * Secondary checks: always done, but change 'ret' only if it was 0
7372 */
7373
Valerio Settiacd32c02023-06-29 18:06:29 +02007374#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007375 {
7376 const mbedtls_pk_context *pk = &chain->pk;
7377
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007378 /* If certificate uses an EC key, make sure the curve is OK.
7379 * This is a public key, so it can't be opaque, so can_do() is a good
7380 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007382 /* and in the unlikely case the above assumption no longer holds
7383 * we are making sure that pk_ec() here does not return a NULL
7384 */
Valerio Settid0405092023-05-24 13:16:40 +02007385 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7386 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7387 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007389 }
Valerio Setti97207782023-05-18 18:59:06 +02007390 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007391 ssl->session_negotiate->verify_result |=
7392 MBEDTLS_X509_BADCERT_BAD_KEY;
7393
Gilles Peskine449bd832023-01-11 14:50:10 +01007394 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7395 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007396 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007398 }
Jerry Yud9526692022-02-17 14:23:47 +08007399 }
7400 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007401#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007402
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 if (mbedtls_ssl_check_cert_usage(chain,
7404 ciphersuite_info,
7405 !ssl->conf->endpoint,
7406 &ssl->session_negotiate->verify_result) != 0) {
7407 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7408 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007409 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 }
Jerry Yud9526692022-02-17 14:23:47 +08007411 }
7412
7413 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7414 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7415 * with details encoded in the verification flags. All other kinds
7416 * of error codes, including those from the user provided f_vrfy
7417 * functions, are treated as fatal and lead to a failure of
7418 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7420 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7421 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007422 ret = 0;
7423 }
7424
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7426 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007427 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7428 }
7429
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007431 uint8_t alert;
7432
7433 /* The certificate may have been rejected for several reasons.
7434 Pick one and send the corresponding alert. Which alert to send
7435 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007437 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007439 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007441 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007443 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007445 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007447 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007449 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007451 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007453 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007455 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007457 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 }
7459 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7460 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007461 }
7462
7463#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 if (ssl->session_negotiate->verify_result != 0) {
7465 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7466 (unsigned int) ssl->session_negotiate->verify_result));
7467 } else {
7468 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007469 }
7470#endif /* MBEDTLS_DEBUG_C */
7471
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007473}
7474
7475#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007476MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007477static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7478 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007479{
7480 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7481 /* Remember digest of the peer's end-CRT. */
7482 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7484 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7485 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7486 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7487 mbedtls_ssl_send_alert_message(ssl,
7488 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7489 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007490
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007492 }
7493
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 ret = mbedtls_md(mbedtls_md_info_from_type(
7495 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7496 start, len,
7497 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007498
7499 ssl->session_negotiate->peer_cert_digest_type =
7500 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7501 ssl->session_negotiate->peer_cert_digest_len =
7502 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7503
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007505}
7506
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007507MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007508static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7509 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007510{
7511 unsigned char *end = start + len;
7512 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7513
7514 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7516 ret = mbedtls_pk_parse_subpubkey(&start, end,
7517 &ssl->handshake->peer_pubkey);
7518 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007519 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007521 }
7522
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007524}
7525#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7526
Gilles Peskine449bd832023-01-11 14:50:10 +01007527int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007528{
7529 int ret = 0;
7530 int crt_expected;
7531#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7532 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7533 ? ssl->handshake->sni_authmode
7534 : ssl->conf->authmode;
7535#else
7536 const int authmode = ssl->conf->authmode;
7537#endif
7538 void *rs_ctx = NULL;
7539 mbedtls_x509_crt *chain = NULL;
7540
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007542
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7544 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7545 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007546 goto exit;
7547 }
7548
7549#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 if (ssl->handshake->ecrs_enabled &&
7551 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007552 chain = ssl->handshake->ecrs_peer_cert;
7553 ssl->handshake->ecrs_peer_cert = NULL;
7554 goto crt_verify;
7555 }
7556#endif
7557
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007559 /* mbedtls_ssl_read_record may have sent an alert already. We
7560 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007562 goto exit;
7563 }
7564
7565#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007567 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7568
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007570 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 }
Jerry Yud9526692022-02-17 14:23:47 +08007572
7573 goto exit;
7574 }
7575#endif /* MBEDTLS_SSL_SRV_C */
7576
7577 /* Clear existing peer CRT structure in case we tried to
7578 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007580
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7582 if (chain == NULL) {
7583 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7584 sizeof(mbedtls_x509_crt)));
7585 mbedtls_ssl_send_alert_message(ssl,
7586 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7587 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007588
7589 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7590 goto exit;
7591 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007593
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 ret = ssl_parse_certificate_chain(ssl, chain);
7595 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007596 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 }
Jerry Yud9526692022-02-17 14:23:47 +08007598
7599#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007601 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 }
Jerry Yud9526692022-02-17 14:23:47 +08007603
7604crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007606 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007607 }
Jerry Yud9526692022-02-17 14:23:47 +08007608#endif
7609
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 ret = ssl_parse_certificate_verify(ssl, authmode,
7611 chain, rs_ctx);
7612 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007613 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 }
Jerry Yud9526692022-02-17 14:23:47 +08007615
7616#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7617 {
7618 unsigned char *crt_start, *pk_start;
7619 size_t crt_len, pk_len;
7620
7621 /* We parse the CRT chain without copying, so
7622 * these pointers point into the input buffer,
7623 * and are hence still valid after freeing the
7624 * CRT chain. */
7625
7626 crt_start = chain->raw.p;
7627 crt_len = chain->raw.len;
7628
7629 pk_start = chain->pk_raw.p;
7630 pk_len = chain->pk_raw.len;
7631
7632 /* Free the CRT structures before computing
7633 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 mbedtls_x509_crt_free(chain);
7635 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007636 chain = NULL;
7637
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7639 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007640 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 }
Jerry Yud9526692022-02-17 14:23:47 +08007642
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7644 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007645 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 }
Jerry Yud9526692022-02-17 14:23:47 +08007647 }
7648#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7649 /* Pass ownership to session structure. */
7650 ssl->session_negotiate->peer_cert = chain;
7651 chain = NULL;
7652#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7653
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007655
7656exit:
7657
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007659 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 }
Jerry Yud9526692022-02-17 14:23:47 +08007661
7662#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007663 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007664 ssl->handshake->ecrs_peer_cert = chain;
7665 chain = NULL;
7666 }
7667#endif
7668
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 if (chain != NULL) {
7670 mbedtls_x509_crt_free(chain);
7671 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007672 }
7673
Gilles Peskine449bd832023-01-11 14:50:10 +01007674 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007675}
7676#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7677
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007678static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7679 unsigned char *padbuf, size_t hlen,
7680 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007681{
7682 int len = 12;
7683 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007684#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007685 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007686 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007687 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007688 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007689#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007690 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007691 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007692 mbedtls_md_context_t cloned_ctx;
7693 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007694#endif
7695
7696 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007698 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007700
Gilles Peskine449bd832023-01-11 14:50:10 +01007701 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007702 ? "client finished"
7703 : "server finished";
7704
7705#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007706 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007707
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007708 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007710 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007711 }
7712
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007713 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007715 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007716 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007717 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007718#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007719 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007720
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007721 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007722 if (ret != 0) {
7723 goto exit;
7724 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007725 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007726 if (ret != 0) {
7727 goto exit;
7728 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007729
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007730 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007731 if (ret != 0) {
7732 goto exit;
7733 }
7734#endif /* MBEDTLS_USE_PSA_CRYPTO */
7735
7736 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7737
Jerry Yu615bd6f2022-02-17 14:25:15 +08007738 /*
7739 * TLSv1.2:
7740 * hash = PRF( master, finished_label,
7741 * Hash( handshake ) )[0.11]
7742 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007744 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007745
Gilles Peskine449bd832023-01-11 14:50:10 +01007746 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007747
Paul Elliottecb95be2023-08-11 16:41:04 +01007748 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007749
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007750 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007751
7752exit:
7753#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007754 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007755 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007756#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007757 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007758 return ret;
7759#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007760}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007761
7762#if defined(MBEDTLS_MD_CAN_SHA256)
7763static int ssl_calc_finished_tls_sha256(
7764 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7765{
7766 unsigned char padbuf[32];
7767 return ssl_calc_finished_tls_generic(ssl,
7768#if defined(MBEDTLS_USE_PSA_CRYPTO)
7769 &ssl->handshake->fin_sha256_psa,
7770#else
7771 &ssl->handshake->fin_sha256,
7772#endif
7773 padbuf, sizeof(padbuf),
7774 buf, from);
7775}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007776#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007777
Jerry Yub7ba49e2022-02-17 14:25:53 +08007778
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007779#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007780static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007782{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007783 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007784 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007785#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007786 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007787#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007788 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007789#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007790 padbuf, sizeof(padbuf),
7791 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007792}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007793#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007794
Gilles Peskine449bd832023-01-11 14:50:10 +01007795void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007796{
Gilles Peskine449bd832023-01-11 14:50:10 +01007797 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007798
7799 /*
7800 * Free our handshake params
7801 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 mbedtls_ssl_handshake_free(ssl);
7803 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007804 ssl->handshake = NULL;
7805
7806 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007807 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007808 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 if (ssl->transform) {
7810 mbedtls_ssl_transform_free(ssl->transform);
7811 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007812 }
7813 ssl->transform = ssl->transform_negotiate;
7814 ssl->transform_negotiate = NULL;
7815
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007817}
7818
Gilles Peskine449bd832023-01-11 14:50:10 +01007819void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007820{
7821 int resume = ssl->handshake->resume;
7822
Gilles Peskine449bd832023-01-11 14:50:10 +01007823 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007824
7825#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007827 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7828 ssl->renego_records_seen = 0;
7829 }
7830#endif
7831
7832 /*
7833 * Free the previous session and switch in the current one
7834 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007835 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007836#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7837 /* RFC 7366 3.1: keep the EtM state */
7838 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007839 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007840#endif
7841
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 mbedtls_ssl_session_free(ssl->session);
7843 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007844 }
7845 ssl->session = ssl->session_negotiate;
7846 ssl->session_negotiate = NULL;
7847
7848 /*
7849 * Add cache entry
7850 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007851 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007852 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 resume == 0) {
7854 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7855 ssl->session->id,
7856 ssl->session->id_len,
7857 ssl->session) != 0) {
7858 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7859 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007860 }
7861
7862#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7864 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007865 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007866 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007867
7868 /* Keep last flight around in case we need to resend it:
7869 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7871 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007872#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007874
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007875 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007876
Gilles Peskine449bd832023-01-11 14:50:10 +01007877 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007878}
7879
Gilles Peskine449bd832023-01-11 14:50:10 +01007880int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007881{
7882 int ret, hash_len;
7883
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007885
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007887
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007888 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7889 if (ret != 0) {
7890 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7891 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007892
7893 /*
7894 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7895 * may define some other value. Currently (early 2016), no defined
7896 * ciphersuite does this (and this is unlikely to change as activity has
7897 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7898 */
7899 hash_len = 12;
7900
7901#if defined(MBEDTLS_SSL_RENEGOTIATION)
7902 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007904#endif
7905
7906 ssl->out_msglen = 4 + hash_len;
7907 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7908 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7909
7910 /*
7911 * In case of session resuming, invert the client and server
7912 * ChangeCipherSpec messages order.
7913 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007915#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007917 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007919#endif
7920#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007922 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007924#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007925 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007926 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007927 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007928
7929 /*
7930 * Switch to our negotiated transform and session parameters for outbound
7931 * data.
7932 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007934
7935#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007937 unsigned char i;
7938
7939 /* Remember current epoch settings for resending */
7940 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7942 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007943
7944 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007945 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007946
7947
7948 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007949 for (i = 2; i > 0; i--) {
7950 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007951 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 }
7953 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007954
7955 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007956 if (i == 0) {
7957 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7958 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007959 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007961#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007962 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007963
7964 ssl->transform_out = ssl->transform_negotiate;
7965 ssl->session_out = ssl->session_negotiate;
7966
7967#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007968 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7969 mbedtls_ssl_send_flight_completed(ssl);
7970 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007971#endif
7972
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7974 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7975 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007976 }
7977
7978#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007979 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7980 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7981 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7982 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007983 }
7984#endif
7985
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007987
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007989}
7990
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007991#define SSL_MAX_HASH_LEN 12
7992
Gilles Peskine449bd832023-01-11 14:50:10 +01007993int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007994{
7995 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7996 unsigned int hash_len = 12;
7997 unsigned char buf[SSL_MAX_HASH_LEN];
7998
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008000
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008001 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8002 if (ret != 0) {
8003 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8004 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008005
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8007 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008008 goto exit;
8009 }
8010
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8012 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8013 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8014 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008015 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8016 goto exit;
8017 }
8018
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8020 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8021 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008022 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8023 goto exit;
8024 }
8025
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8027 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8028 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8029 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008030 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8031 goto exit;
8032 }
8033
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8035 buf, hash_len) != 0) {
8036 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8037 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8038 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008039 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8040 goto exit;
8041 }
8042
8043#if defined(MBEDTLS_SSL_RENEGOTIATION)
8044 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008045 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008046#endif
8047
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008049#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008050 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008051 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008052 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008053#endif
8054#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008055 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008056 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008057 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008058#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008060 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008061 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008062
8063#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8065 mbedtls_ssl_recv_flight_completed(ssl);
8066 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008067#endif
8068
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008070
8071exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 mbedtls_platform_zeroize(buf, hash_len);
8073 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008074}
8075
Jerry Yu392112c2022-02-17 14:34:10 +08008076#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8077/*
8078 * Helper to get TLS 1.2 PRF from ciphersuite
8079 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8080 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008081static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008082{
Jerry Yu392112c2022-02-17 14:34:10 +08008083 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008085#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8087 return tls_prf_sha384;
8088 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008089#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008090#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008091 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8093 return tls_prf_sha256;
8094 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008095 }
8096#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008097#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8098 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008099 (void) ciphersuite_info;
8100#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008101
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008103}
8104#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008105
Gilles Peskine449bd832023-01-11 14:50:10 +01008106static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008107{
8108 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008109#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008110 if (tls_prf == tls_prf_sha384) {
8111 return MBEDTLS_SSL_TLS_PRF_SHA384;
8112 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008113#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008114#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008115 if (tls_prf == tls_prf_sha256) {
8116 return MBEDTLS_SSL_TLS_PRF_SHA256;
8117 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008118#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008119 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008120}
8121
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008122/*
8123 * Populate a transform structure with session keys and all the other
8124 * necessary information.
8125 *
8126 * Parameters:
8127 * - [in/out]: transform: structure to populate
8128 * [in] must be just initialised with mbedtls_ssl_transform_init()
8129 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8130 * - [in] ciphersuite
8131 * - [in] master
8132 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008133 * - [in] tls_prf: pointer to PRF to use for key derivation
8134 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008135 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008136 * - [in] endpoint: client or server
8137 * - [in] ssl: used for:
8138 * - ssl->conf->{f,p}_export_keys
8139 * [in] optionally used for:
8140 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8141 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008142MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008143static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8144 int ciphersuite,
8145 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008146#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008148#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008149 ssl_tls_prf_t tls_prf,
8150 const unsigned char randbytes[64],
8151 mbedtls_ssl_protocol_version tls_version,
8152 unsigned endpoint,
8153 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008154{
8155 int ret = 0;
8156 unsigned char keyblk[256];
8157 unsigned char *key1;
8158 unsigned char *key2;
8159 unsigned char *mac_enc;
8160 unsigned char *mac_dec;
8161 size_t mac_key_len = 0;
8162 size_t iv_copy_len;
8163 size_t keylen;
8164 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008165 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008166#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008167 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008168 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008169#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008170
8171#if defined(MBEDTLS_USE_PSA_CRYPTO)
8172 psa_key_type_t key_type;
8173 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8174 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008175 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008176 size_t key_bits;
8177 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8178#endif
8179
8180#if !defined(MBEDTLS_DEBUG_C) && \
8181 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008182 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008183 ssl = NULL; /* make sure we don't use it except for these cases */
8184 (void) ssl;
8185 }
8186#endif
8187
8188 /*
8189 * Some data just needs copying into the structure
8190 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008191#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008192 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008193#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008194 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008195
8196#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008197 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008198#endif
8199
8200#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008201 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008202 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8203 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008204 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008205 }
8206#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8207
8208 /*
8209 * Get various info structures
8210 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8212 if (ciphersuite_info == NULL) {
8213 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8214 ciphersuite));
8215 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008216 }
8217
Neil Armstrongab555e02022-04-04 11:07:59 +02008218 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008219#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008221#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008222 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008223
Gilles Peskine449bd832023-01-11 14:50:10 +01008224 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008225 transform->taglen =
8226 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008228
8229#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008230 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008231 transform->taglen,
8232 &alg,
8233 &key_type,
8234 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008235 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008236 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008237 goto end;
8238 }
8239#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008240 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 if (cipher_info == NULL) {
8242 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8243 ciphersuite_info->cipher));
8244 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008245 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008246#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008247
Neil Armstronge4512952022-03-08 09:08:22 +01008248#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008249 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008250 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008251 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008252 (unsigned) ciphersuite_info->mac));
8253 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008254 }
8255#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008256 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008257 if (md_info == NULL) {
8258 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8259 (unsigned) ciphersuite_info->mac));
8260 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008261 }
Neil Armstronge4512952022-03-08 09:08:22 +01008262#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008263
8264#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8265 /* Copy own and peer's CID if the use of the CID
8266 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8268 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008269
8270 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8272 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8273 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008274
8275 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008276 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8277 ssl->handshake->peer_cid_len);
8278 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8279 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008280 }
8281#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8282
8283 /*
8284 * Compute key block using the PRF
8285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8287 if (ret != 0) {
8288 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8289 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008290 }
8291
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8293 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8294 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8295 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8296 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008297
8298 /*
8299 * Determine the appropriate key, IV and MAC length.
8300 */
8301
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008302#if defined(MBEDTLS_USE_PSA_CRYPTO)
8303 keylen = PSA_BITS_TO_BYTES(key_bits);
8304#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008305 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008306#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008307
8308#if defined(MBEDTLS_GCM_C) || \
8309 defined(MBEDTLS_CCM_C) || \
8310 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008312 size_t explicit_ivlen;
8313
8314 transform->maclen = 0;
8315 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008316
8317 /* All modes haves 96-bit IVs, but the length of the static parts vary
8318 * with mode and version:
8319 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8320 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8321 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8322 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8323 * sequence number).
8324 */
8325 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008326
8327 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008328#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008329 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008330#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008331 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8332 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008333#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008334
Gilles Peskine449bd832023-01-11 14:50:10 +01008335 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008336 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008337 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008338 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008339 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008340
8341 /* Minimum length of encrypted record */
8342 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8343 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008344 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008345#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8346#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008347 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008348 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008349 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008350#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008351 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008352#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008353 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008354#endif /* MBEDTLS_USE_PSA_CRYPTO */
8355
8356#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008357 /* Get MAC length */
8358 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8359#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008360 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008361 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8362 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8363 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008364 goto end;
8365 }
8366
8367 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008368 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008369#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008370 transform->maclen = mac_key_len;
8371
8372 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008373#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008374 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008375#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008376 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008377#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008378
8379 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008380 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008381 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008382 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008383 /*
8384 * GenericBlockCipher:
8385 * 1. if EtM is in use: one block plus MAC
8386 * otherwise: * first multiple of blocklen greater than maclen
8387 * 2. IV
8388 */
8389#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008390 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008391 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008392 + block_size;
8393 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008394#endif
8395 {
8396 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008397 + block_size
8398 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008399 }
8400
Gilles Peskine449bd832023-01-11 14:50:10 +01008401 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008402 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008403 } else {
8404 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008405 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8406 goto end;
8407 }
8408 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008409 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008410#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8411 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008412 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8413 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008414 }
8415
Gilles Peskine449bd832023-01-11 14:50:10 +01008416 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8417 (unsigned) keylen,
8418 (unsigned) transform->minlen,
8419 (unsigned) transform->ivlen,
8420 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008421
8422 /*
8423 * Finally setup the cipher contexts, IVs and MAC secrets.
8424 */
8425#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008426 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008427 key1 = keyblk + mac_key_len * 2;
8428 key2 = keyblk + mac_key_len * 2 + keylen;
8429
8430 mac_enc = keyblk;
8431 mac_dec = keyblk + mac_key_len;
8432
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 iv_copy_len = (transform->fixed_ivlen) ?
8434 transform->fixed_ivlen : transform->ivlen;
8435 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8436 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8437 iv_copy_len);
8438 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008439#endif /* MBEDTLS_SSL_CLI_C */
8440#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008441 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008442 key1 = keyblk + mac_key_len * 2 + keylen;
8443 key2 = keyblk + mac_key_len * 2;
8444
8445 mac_enc = keyblk + mac_key_len;
8446 mac_dec = keyblk;
8447
Gilles Peskine449bd832023-01-11 14:50:10 +01008448 iv_copy_len = (transform->fixed_ivlen) ?
8449 transform->fixed_ivlen : transform->ivlen;
8450 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8451 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8452 iv_copy_len);
8453 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008454#endif /* MBEDTLS_SSL_SRV_C */
8455 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008456 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008457 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8458 goto end;
8459 }
8460
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 if (ssl != NULL && ssl->f_export_keys != NULL) {
8462 ssl->f_export_keys(ssl->p_export_keys,
8463 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8464 master, 48,
8465 randbytes + 32,
8466 randbytes,
8467 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008468 }
8469
8470#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008471 transform->psa_alg = alg;
8472
Gilles Peskine449bd832023-01-11 14:50:10 +01008473 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8474 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8475 psa_set_key_algorithm(&attributes, alg);
8476 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008477
Gilles Peskine449bd832023-01-11 14:50:10 +01008478 if ((status = psa_import_key(&attributes,
8479 key1,
8480 PSA_BITS_TO_BYTES(key_bits),
8481 &transform->psa_key_enc)) != PSA_SUCCESS) {
8482 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008483 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008484 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008485 goto end;
8486 }
8487
Gilles Peskine449bd832023-01-11 14:50:10 +01008488 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008489
Gilles Peskine449bd832023-01-11 14:50:10 +01008490 if ((status = psa_import_key(&attributes,
8491 key2,
8492 PSA_BITS_TO_BYTES(key_bits),
8493 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008494 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008496 goto end;
8497 }
8498 }
8499#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008500 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8501 cipher_info)) != 0) {
8502 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008503 goto end;
8504 }
8505
Gilles Peskine449bd832023-01-11 14:50:10 +01008506 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8507 cipher_info)) != 0) {
8508 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008509 goto end;
8510 }
8511
Gilles Peskine449bd832023-01-11 14:50:10 +01008512 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8513 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8514 MBEDTLS_ENCRYPT)) != 0) {
8515 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008516 goto end;
8517 }
8518
Gilles Peskine449bd832023-01-11 14:50:10 +01008519 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8520 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8521 MBEDTLS_DECRYPT)) != 0) {
8522 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008523 goto end;
8524 }
8525
8526#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008527 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8528 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8529 MBEDTLS_PADDING_NONE)) != 0) {
8530 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008531 goto end;
8532 }
8533
Gilles Peskine449bd832023-01-11 14:50:10 +01008534 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8535 MBEDTLS_PADDING_NONE)) != 0) {
8536 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008537 goto end;
8538 }
8539 }
8540#endif /* MBEDTLS_CIPHER_MODE_CBC */
8541#endif /* MBEDTLS_USE_PSA_CRYPTO */
8542
Neil Armstrong29c0c042022-03-17 17:47:28 +01008543#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8544 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8545 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008547#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008548 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008549
Gilles Peskine449bd832023-01-11 14:50:10 +01008550 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8551 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8552 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008553
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 if ((status = psa_import_key(&attributes,
8555 mac_enc, mac_key_len,
8556 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008557 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008558 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008559 goto end;
8560 }
8561
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8563 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008564#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008565 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008566#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008567 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008568 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008569 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8570 PSA_KEY_USAGE_VERIFY_HASH);
8571 } else {
8572 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8573 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008574
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 if ((status = psa_import_key(&attributes,
8576 mac_dec, mac_key_len,
8577 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008578 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008579 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008580 goto end;
8581 }
8582#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008583 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8584 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008585 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 }
8587 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8588 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008589 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008590 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008591#endif /* MBEDTLS_USE_PSA_CRYPTO */
8592 }
8593#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8594
8595 ((void) mac_dec);
8596 ((void) mac_enc);
8597
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008598end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008599 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8600 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008601}
8602
Valerio Settia08b1a42022-11-17 15:10:02 +01008603#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8604 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008605int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 psa_pake_operation_t *pake_ctx,
8607 const unsigned char *buf,
8608 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008609{
8610 psa_status_t status;
8611 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008612 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008613 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8614 * At round two perform a single cycle
8615 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008617
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 for (; remaining_steps > 0; remaining_steps--) {
8619 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008620 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008621 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008622 /* Length is stored at the first byte */
8623 size_t length = buf[input_offset];
8624 input_offset += 1;
8625
Gilles Peskine449bd832023-01-11 14:50:10 +01008626 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008627 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8628 }
8629
Gilles Peskine449bd832023-01-11 14:50:10 +01008630 status = psa_pake_input(pake_ctx, step,
8631 buf + input_offset, length);
8632 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008633 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008634 }
8635
8636 input_offset += length;
8637 }
8638 }
8639
Gilles Peskine449bd832023-01-11 14:50:10 +01008640 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008641 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008643
Gilles Peskine449bd832023-01-11 14:50:10 +01008644 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008645}
8646
Valerio Setti6b3dab02022-11-17 17:14:54 +01008647int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008648 psa_pake_operation_t *pake_ctx,
8649 unsigned char *buf,
8650 size_t len, size_t *olen,
8651 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008652{
8653 psa_status_t status;
8654 size_t output_offset = 0;
8655 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008656 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008657 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8658 * At round two perform a single cycle
8659 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008660 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008661
Gilles Peskine449bd832023-01-11 14:50:10 +01008662 for (; remaining_steps > 0; remaining_steps--) {
8663 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8664 step <= PSA_PAKE_STEP_ZK_PROOF;
8665 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008666 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008667 * For each step, prepend 1 byte with the length of the data as
8668 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008669 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008670 status = psa_pake_output(pake_ctx, step,
8671 buf + output_offset + 1,
8672 len - output_offset - 1,
8673 &output_len);
8674 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008675 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008676 }
8677
Valerio Setti99d88c12022-11-22 16:03:43 +01008678 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008679
8680 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008681 }
8682 }
8683
8684 *olen = output_offset;
8685
Gilles Peskine449bd832023-01-11 14:50:10 +01008686 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008687}
Valerio Settia08b1a42022-11-17 15:10:02 +01008688#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8689
Jerry Yuee40f9d2022-02-17 14:55:16 +08008690#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008691int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8692 unsigned char *hash, size_t *hashlen,
8693 unsigned char *data, size_t data_len,
8694 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008695{
8696 psa_status_t status;
8697 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008698 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008699
Gilles Peskine449bd832023-01-11 14:50:10 +01008700 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008701
Gilles Peskine449bd832023-01-11 14:50:10 +01008702 if ((status = psa_hash_setup(&hash_operation,
8703 hash_alg)) != PSA_SUCCESS) {
8704 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008705 goto exit;
8706 }
8707
Gilles Peskine449bd832023-01-11 14:50:10 +01008708 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8709 64)) != PSA_SUCCESS) {
8710 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008711 goto exit;
8712 }
8713
Gilles Peskine449bd832023-01-11 14:50:10 +01008714 if ((status = psa_hash_update(&hash_operation,
8715 data, data_len)) != PSA_SUCCESS) {
8716 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008717 goto exit;
8718 }
8719
Gilles Peskine449bd832023-01-11 14:50:10 +01008720 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8721 hashlen)) != PSA_SUCCESS) {
8722 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8723 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008724 }
8725
8726exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008727 if (status != PSA_SUCCESS) {
8728 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8729 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8730 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008731 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008732 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008733 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8734 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008735 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008736 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008737 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008738 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008739 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008740 }
8741 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008742 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008743}
8744
8745#else
8746
Gilles Peskine449bd832023-01-11 14:50:10 +01008747int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8748 unsigned char *hash, size_t *hashlen,
8749 unsigned char *data, size_t data_len,
8750 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008751{
8752 int ret = 0;
8753 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008754 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8755 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008756
Gilles Peskine449bd832023-01-11 14:50:10 +01008757 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008758
Gilles Peskine449bd832023-01-11 14:50:10 +01008759 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008760
8761 /*
8762 * digitally-signed struct {
8763 * opaque client_random[32];
8764 * opaque server_random[32];
8765 * ServerDHParams params;
8766 * };
8767 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008768 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8769 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008770 goto exit;
8771 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008772 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8773 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008774 goto exit;
8775 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008776 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8777 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008778 goto exit;
8779 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008780 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8781 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008782 goto exit;
8783 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008784 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8785 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008786 goto exit;
8787 }
8788
8789exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008790 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008791
Gilles Peskine449bd832023-01-11 14:50:10 +01008792 if (ret != 0) {
8793 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8794 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8795 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008796
Gilles Peskine449bd832023-01-11 14:50:10 +01008797 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008798}
8799#endif /* MBEDTLS_USE_PSA_CRYPTO */
8800
Jerry Yud9d91da2022-02-17 14:57:06 +08008801#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8802
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008803/* Find the preferred hash for a given signature algorithm. */
8804unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008805 mbedtls_ssl_context *ssl,
8806 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008807{
Gabor Mezei078e8032022-04-27 21:17:56 +02008808 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008809 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008810
Gilles Peskine449bd832023-01-11 14:50:10 +01008811 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8812 return MBEDTLS_SSL_HASH_NONE;
8813 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008814
Gilles Peskine449bd832023-01-11 14:50:10 +01008815 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008816 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008817 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8818 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008819 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008820 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8821 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008822
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008823 mbedtls_md_type_t md_alg =
8824 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8825 if (md_alg == MBEDTLS_MD_NONE) {
8826 continue;
8827 }
8828
Gilles Peskine449bd832023-01-11 14:50:10 +01008829 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008830#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008831 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008832 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008833 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008834
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8836 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8837 PSA_ALG_ECDSA(psa_hash_alg),
8838 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008839 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008840 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008841
Gilles Peskine449bd832023-01-11 14:50:10 +01008842 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8843 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8844 PSA_ALG_RSA_PKCS1V15_SIGN(
8845 psa_hash_alg),
8846 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008847 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008848 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008849 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008850#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008851
Gilles Peskine449bd832023-01-11 14:50:10 +01008852 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008853 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008854 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008855
Gilles Peskine449bd832023-01-11 14:50:10 +01008856 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008857}
8858
8859#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8860
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008861/* Serialization of TLS 1.2 sessions:
8862 *
8863 * struct {
8864 * uint64 start_time;
8865 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008866 * uint8 session_id_len; // at most 32
8867 * opaque session_id[32];
8868 * opaque master[48]; // fixed length in the standard
8869 * uint32 verify_result;
8870 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8871 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8872 * uint32 ticket_lifetime;
8873 * uint8 mfl_code; // up to 255 according to standard
8874 * uint8 encrypt_then_mac; // 0 or 1
8875 * } serialized_session_tls12;
8876 *
8877 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008878static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8879 unsigned char *buf,
8880 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008881{
8882 unsigned char *p = buf;
8883 size_t used = 0;
8884
8885#if defined(MBEDTLS_HAVE_TIME)
8886 uint64_t start;
8887#endif
8888#if defined(MBEDTLS_X509_CRT_PARSE_C)
8889#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8890 size_t cert_len;
8891#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8892#endif /* MBEDTLS_X509_CRT_PARSE_C */
8893
8894 /*
8895 * Time
8896 */
8897#if defined(MBEDTLS_HAVE_TIME)
8898 used += 8;
8899
Gilles Peskine449bd832023-01-11 14:50:10 +01008900 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008901 start = (uint64_t) session->start;
8902
Gilles Peskine449bd832023-01-11 14:50:10 +01008903 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008904 p += 8;
8905 }
8906#endif /* MBEDTLS_HAVE_TIME */
8907
8908 /*
8909 * Basic mandatory fields
8910 */
8911 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008912 + 1 /* id_len */
8913 + sizeof(session->id)
8914 + sizeof(session->master)
8915 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008916
Gilles Peskine449bd832023-01-11 14:50:10 +01008917 if (used <= buf_len) {
8918 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008919 p += 2;
8920
Gilles Peskine449bd832023-01-11 14:50:10 +01008921 *p++ = MBEDTLS_BYTE_0(session->id_len);
8922 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008923 p += 32;
8924
Gilles Peskine449bd832023-01-11 14:50:10 +01008925 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008926 p += 48;
8927
Gilles Peskine449bd832023-01-11 14:50:10 +01008928 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008929 p += 4;
8930 }
8931
8932 /*
8933 * Peer's end-entity certificate
8934 */
8935#if defined(MBEDTLS_X509_CRT_PARSE_C)
8936#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008937 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008938 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008939 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008940 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008941 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008942
8943 used += 3 + cert_len;
8944
Gilles Peskine449bd832023-01-11 14:50:10 +01008945 if (used <= buf_len) {
8946 *p++ = MBEDTLS_BYTE_2(cert_len);
8947 *p++ = MBEDTLS_BYTE_1(cert_len);
8948 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008949
Gilles Peskine449bd832023-01-11 14:50:10 +01008950 if (session->peer_cert != NULL) {
8951 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008952 p += cert_len;
8953 }
8954 }
8955#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008956 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008957 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008958 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008959 *p++ = (unsigned char) session->peer_cert_digest_type;
8960 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008961 memcpy(p, session->peer_cert_digest,
8962 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008963 p += session->peer_cert_digest_len;
8964 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008965 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008966 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008967 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008968 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8969 *p++ = 0;
8970 }
8971 }
8972#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8973#endif /* MBEDTLS_X509_CRT_PARSE_C */
8974
8975 /*
8976 * Session ticket if any, plus associated data
8977 */
8978#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8979 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8980
Gilles Peskine449bd832023-01-11 14:50:10 +01008981 if (used <= buf_len) {
8982 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
8983 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
8984 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008985
Gilles Peskine449bd832023-01-11 14:50:10 +01008986 if (session->ticket != NULL) {
8987 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008988 p += session->ticket_len;
8989 }
8990
Gilles Peskine449bd832023-01-11 14:50:10 +01008991 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008992 p += 4;
8993 }
8994#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8995
8996 /*
8997 * Misc extension-related info
8998 */
8999#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9000 used += 1;
9001
Gilles Peskine449bd832023-01-11 14:50:10 +01009002 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009003 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009004 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009005#endif
9006
9007#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9008 used += 1;
9009
Gilles Peskine449bd832023-01-11 14:50:10 +01009010 if (used <= buf_len) {
9011 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9012 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009013#endif
9014
Gilles Peskine449bd832023-01-11 14:50:10 +01009015 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009016}
9017
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009018MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009019static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9020 const unsigned char *buf,
9021 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009022{
9023#if defined(MBEDTLS_HAVE_TIME)
9024 uint64_t start;
9025#endif
9026#if defined(MBEDTLS_X509_CRT_PARSE_C)
9027#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9028 size_t cert_len;
9029#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9030#endif /* MBEDTLS_X509_CRT_PARSE_C */
9031
9032 const unsigned char *p = buf;
9033 const unsigned char * const end = buf + len;
9034
9035 /*
9036 * Time
9037 */
9038#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009039 if (8 > (size_t) (end - p)) {
9040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9041 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009042
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009043 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009044 p += 8;
9045
9046 session->start = (time_t) start;
9047#endif /* MBEDTLS_HAVE_TIME */
9048
9049 /*
9050 * Basic mandatory fields
9051 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009052 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9053 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9054 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009055
Gilles Peskine449bd832023-01-11 14:50:10 +01009056 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009057 p += 2;
9058
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009059 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009060 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009061 p += 32;
9062
Gilles Peskine449bd832023-01-11 14:50:10 +01009063 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009064 p += 48;
9065
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009066 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009067 p += 4;
9068
9069 /* Immediately clear invalid pointer values that have been read, in case
9070 * we exit early before we replaced them with valid ones. */
9071#if defined(MBEDTLS_X509_CRT_PARSE_C)
9072#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9073 session->peer_cert = NULL;
9074#else
9075 session->peer_cert_digest = NULL;
9076#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9077#endif /* MBEDTLS_X509_CRT_PARSE_C */
9078#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9079 session->ticket = NULL;
9080#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9081
9082 /*
9083 * Peer certificate
9084 */
9085#if defined(MBEDTLS_X509_CRT_PARSE_C)
9086#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9087 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009088 if (3 > (size_t) (end - p)) {
9089 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9090 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009091
Gilles Peskine449bd832023-01-11 14:50:10 +01009092 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009093 p += 3;
9094
Gilles Peskine449bd832023-01-11 14:50:10 +01009095 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009096 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9097
Gilles Peskine449bd832023-01-11 14:50:10 +01009098 if (cert_len > (size_t) (end - p)) {
9099 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9100 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009101
Gilles Peskine449bd832023-01-11 14:50:10 +01009102 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009103
Gilles Peskine449bd832023-01-11 14:50:10 +01009104 if (session->peer_cert == NULL) {
9105 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9106 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009107
Gilles Peskine449bd832023-01-11 14:50:10 +01009108 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009109
Gilles Peskine449bd832023-01-11 14:50:10 +01009110 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9111 p, cert_len)) != 0) {
9112 mbedtls_x509_crt_free(session->peer_cert);
9113 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009114 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009115 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009116 }
9117
9118 p += cert_len;
9119 }
9120#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9121 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009122 if (2 > (size_t) (end - p)) {
9123 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9124 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009125
9126 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9127 session->peer_cert_digest_len = (size_t) *p++;
9128
Gilles Peskine449bd832023-01-11 14:50:10 +01009129 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009130 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009131 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9132 if (md_info == NULL) {
9133 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9134 }
9135 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9136 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9137 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009138
Gilles Peskine449bd832023-01-11 14:50:10 +01009139 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9140 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9141 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009142
9143 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009144 mbedtls_calloc(1, session->peer_cert_digest_len);
9145 if (session->peer_cert_digest == NULL) {
9146 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9147 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009148
Gilles Peskine449bd832023-01-11 14:50:10 +01009149 memcpy(session->peer_cert_digest, p,
9150 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009151 p += session->peer_cert_digest_len;
9152 }
9153#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9154#endif /* MBEDTLS_X509_CRT_PARSE_C */
9155
9156 /*
9157 * Session ticket and associated data
9158 */
9159#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009160 if (3 > (size_t) (end - p)) {
9161 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9162 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009163
Gilles Peskine449bd832023-01-11 14:50:10 +01009164 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009165 p += 3;
9166
Gilles Peskine449bd832023-01-11 14:50:10 +01009167 if (session->ticket_len != 0) {
9168 if (session->ticket_len > (size_t) (end - p)) {
9169 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9170 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009171
Gilles Peskine449bd832023-01-11 14:50:10 +01009172 session->ticket = mbedtls_calloc(1, session->ticket_len);
9173 if (session->ticket == NULL) {
9174 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9175 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009176
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009178 p += session->ticket_len;
9179 }
9180
Gilles Peskine449bd832023-01-11 14:50:10 +01009181 if (4 > (size_t) (end - p)) {
9182 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9183 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009184
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009185 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009186 p += 4;
9187#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9188
9189 /*
9190 * Misc extension-related info
9191 */
9192#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009193 if (1 > (size_t) (end - p)) {
9194 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9195 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009196
9197 session->mfl_code = *p++;
9198#endif
9199
9200#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009201 if (1 > (size_t) (end - p)) {
9202 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9203 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009204
9205 session->encrypt_then_mac = *p++;
9206#endif
9207
9208 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009209 if (p != end) {
9210 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9211 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009212
Gilles Peskine449bd832023-01-11 14:50:10 +01009213 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009214}
Jerry Yudc7bd172022-02-17 13:44:15 +08009215#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9216
XiaokangQian75d40ef2022-04-20 11:05:24 +00009217int mbedtls_ssl_validate_ciphersuite(
9218 const mbedtls_ssl_context *ssl,
9219 const mbedtls_ssl_ciphersuite_t *suite_info,
9220 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009221 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009222{
9223 (void) ssl;
9224
Gilles Peskine449bd832023-01-11 14:50:10 +01009225 if (suite_info == NULL) {
9226 return -1;
9227 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009228
Gilles Peskine449bd832023-01-11 14:50:10 +01009229 if ((suite_info->min_tls_version > max_tls_version) ||
9230 (suite_info->max_tls_version < min_tls_version)) {
9231 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009232 }
9233
XiaokangQian060d8672022-04-21 09:24:56 +00009234#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009235#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009236#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009237 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9238 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009239#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009240 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9241 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009242#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009243 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009244 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009245 }
9246#endif
9247
9248 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9249#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009250 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9251 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9252 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009253 }
9254#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9255#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9256
Gilles Peskine449bd832023-01-11 14:50:10 +01009257 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009258}
9259
Ronald Crone68ab4f2022-10-05 12:46:29 +02009260#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009261/*
9262 * Function for writing a signature algorithm extension.
9263 *
9264 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9265 * value (TLS 1.3 RFC8446):
9266 * enum {
9267 * ....
9268 * ecdsa_secp256r1_sha256( 0x0403 ),
9269 * ecdsa_secp384r1_sha384( 0x0503 ),
9270 * ecdsa_secp521r1_sha512( 0x0603 ),
9271 * ....
9272 * } SignatureScheme;
9273 *
9274 * struct {
9275 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9276 * } SignatureSchemeList;
9277 *
9278 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9279 * value (TLS 1.2 RFC5246):
9280 * enum {
9281 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9282 * sha512(6), (255)
9283 * } HashAlgorithm;
9284 *
9285 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9286 * SignatureAlgorithm;
9287 *
9288 * struct {
9289 * HashAlgorithm hash;
9290 * SignatureAlgorithm signature;
9291 * } SignatureAndHashAlgorithm;
9292 *
9293 * SignatureAndHashAlgorithm
9294 * supported_signature_algorithms<2..2^16-2>;
9295 *
9296 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9297 * generalization of the TLS 1.2 signature algorithm extension.
9298 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9299 * `SignatureScheme` field of TLS 1.3
9300 *
9301 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009302int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9303 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009304{
9305 unsigned char *p = buf;
9306 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9307 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9308
9309 *out_len = 0;
9310
Gilles Peskine449bd832023-01-11 14:50:10 +01009311 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009312
9313 /* Check if we have space for header and length field:
9314 * - extension_type (2 bytes)
9315 * - extension_data_length (2 bytes)
9316 * - supported_signature_algorithms_length (2 bytes)
9317 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009318 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009319 p += 6;
9320
9321 /*
9322 * Write supported_signature_algorithms
9323 */
9324 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009325 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9326 if (sig_alg == NULL) {
9327 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9328 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009329
Gilles Peskine449bd832023-01-11 14:50:10 +01009330 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9331 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9332 *sig_alg,
9333 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9334 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009335 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009336 }
9337 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9338 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009339 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009340 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9341 *sig_alg,
9342 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009343 }
9344
9345 /* Length of supported_signature_algorithms */
9346 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009347 if (supported_sig_alg_len == 0) {
9348 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9349 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009350 }
9351
Gilles Peskine449bd832023-01-11 14:50:10 +01009352 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9353 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9354 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009355
XiaokangQianeaf36512022-04-24 09:07:44 +00009356 *out_len = p - buf;
9357
9358#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009359 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009360#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009361
Gilles Peskine449bd832023-01-11 14:50:10 +01009362 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009363}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009364#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009365
XiaokangQian40a35232022-05-07 09:02:40 +00009366#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009367/*
9368 * mbedtls_ssl_parse_server_name_ext
9369 *
9370 * Structure of server_name extension:
9371 *
9372 * enum {
9373 * host_name(0), (255)
9374 * } NameType;
9375 * opaque HostName<1..2^16-1>;
9376 *
9377 * struct {
9378 * NameType name_type;
9379 * select (name_type) {
9380 * case host_name: HostName;
9381 * } name;
9382 * } ServerName;
9383 * struct {
9384 * ServerName server_name_list<1..2^16-1>
9385 * } ServerNameList;
9386 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009387MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009388int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9389 const unsigned char *buf,
9390 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009391{
9392 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9393 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009394 size_t server_name_list_len, hostname_len;
9395 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009396
Gilles Peskine449bd832023-01-11 14:50:10 +01009397 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009398
Gilles Peskine449bd832023-01-11 14:50:10 +01009399 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9400 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009401 p += 2;
9402
Gilles Peskine449bd832023-01-11 14:50:10 +01009403 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009404 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009405 while (p < server_name_list_end) {
9406 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9407 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9408 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9409 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009410
Gilles Peskine449bd832023-01-11 14:50:10 +01009411 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009412 /* sni_name is intended to be used only during the parsing of the
9413 * ClientHello message (it is reset to NULL before the end of
9414 * the message parsing). Thus it is ok to just point to the
9415 * reception buffer and not make a copy of it.
9416 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009417 ssl->handshake->sni_name = p + 3;
9418 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009419 if (ssl->conf->f_sni == NULL) {
9420 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009421 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009422 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9423 ssl, p + 3, hostname_len);
9424 if (ret != 0) {
9425 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9426 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9427 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9428 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9429 }
9430 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009431 }
9432
9433 p += hostname_len + 3;
9434 }
9435
Gilles Peskine449bd832023-01-11 14:50:10 +01009436 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009437}
9438#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9439
XiaokangQianacb39922022-06-17 10:18:48 +00009440#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009441MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009442int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9443 const unsigned char *buf,
9444 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009445{
9446 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009447 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009448 const unsigned char *protocol_name_list;
9449 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009450 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009451
9452 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009453 if (ssl->conf->alpn_list == NULL) {
9454 return 0;
9455 }
XiaokangQianacb39922022-06-17 10:18:48 +00009456
9457 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009458 * RFC7301, section 3.1
9459 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009460 *
XiaokangQianc7403452022-06-23 03:24:12 +00009461 * struct {
9462 * ProtocolName protocol_name_list<2..2^16-1>
9463 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009464 */
9465
XiaokangQianc7403452022-06-23 03:24:12 +00009466 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009467 * protocol_name_list_len 2 bytes
9468 * protocol_name_len 1 bytes
9469 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009471 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009472
Gilles Peskine449bd832023-01-11 14:50:10 +01009473 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009474 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009475 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009476 protocol_name_list = p;
9477 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009478
9479 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009480 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009481 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009482 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9483 protocol_name_len);
9484 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009485 MBEDTLS_SSL_PEND_FATAL_ALERT(
9486 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009487 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9488 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009489 }
9490
9491 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009492 }
9493
9494 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009495 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9496 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009497 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009498 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009499 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009500 if (protocol_name_len == alpn_len &&
9501 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009502 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009503 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009504 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009505
9506 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009507 }
9508 }
9509
XiaokangQian95d5f542022-06-24 02:29:26 +00009510 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009511 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009512 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9513 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9514 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009515}
9516
Gilles Peskine449bd832023-01-11 14:50:10 +01009517int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9518 unsigned char *buf,
9519 unsigned char *end,
9520 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009521{
9522 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009523 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009524 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009525
Gilles Peskine449bd832023-01-11 14:50:10 +01009526 if (ssl->alpn_chosen == NULL) {
9527 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009528 }
9529
Gilles Peskine449bd832023-01-11 14:50:10 +01009530 protocol_name_len = strlen(ssl->alpn_chosen);
9531 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009532
Gilles Peskine449bd832023-01-11 14:50:10 +01009533 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009534 /*
9535 * 0 . 1 ext identifier
9536 * 2 . 3 ext length
9537 * 4 . 5 protocol list length
9538 * 6 . 6 protocol name length
9539 * 7 . 7+n protocol name
9540 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009541 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009542
XiaokangQian95d5f542022-06-24 02:29:26 +00009543 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009544
Gilles Peskine449bd832023-01-11 14:50:10 +01009545 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9546 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009547 /* Note: the length of the chosen protocol has been checked to be less
9548 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9549 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009550 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009551
Gilles Peskine449bd832023-01-11 14:50:10 +01009552 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009553
9554#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009555 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009556#endif
9557
Gilles Peskine449bd832023-01-11 14:50:10 +01009558 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009559}
9560#endif /* MBEDTLS_SSL_ALPN */
9561
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009562#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009563 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009564 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009565 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009566int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9567 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009568{
9569 /* Initialize to suppress unnecessary compiler warning */
9570 size_t hostname_len = 0;
9571
9572 /* Check if new hostname is valid before
9573 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009574 if (hostname != NULL) {
9575 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009576
Gilles Peskine449bd832023-01-11 14:50:10 +01009577 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9578 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9579 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009580 }
9581
9582 /* Now it's clear that we will overwrite the old hostname,
9583 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009584 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009585 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009586 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009587 }
9588
9589 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009590 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009591 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009592 } else {
9593 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9594 if (session->hostname == NULL) {
9595 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9596 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009597
Gilles Peskine449bd832023-01-11 14:50:10 +01009598 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009599 }
9600
Gilles Peskine449bd832023-01-11 14:50:10 +01009601 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009602}
Xiaokang Qian03409292022-10-12 02:49:52 +00009603#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9604 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009605 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009606 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009607
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009608#endif /* MBEDTLS_SSL_TLS_C */