blob: 0476a9f73e448fe40083ccddd72a68c9b992727b [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>;
2469 * select ( endpoint ) {
2470 * case client: ClientOnlyData;
2471 * case server: uint64 start_time;
2472 * };
2473 * } serialized_session_tls13;
2474 *
2475 */
2476#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002477MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002478static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2479 unsigned char *buf,
2480 size_t buf_len,
2481 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002482{
2483 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002484#if defined(MBEDTLS_SSL_CLI_C) && \
2485 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 size_t hostname_len = (session->hostname == NULL) ?
2487 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002488#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002489 size_t needed = 1 /* endpoint */
2490 + 2 /* ciphersuite */
2491 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002492 + 1 /* ticket_flags */
2493 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002494 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2497 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2498 }
Jerry Yu34191072022-08-18 10:32:09 +08002499 needed += session->resumption_key_len; /* resumption_key */
2500
Jerry Yu438ddd82022-07-07 06:55:50 +00002501#if defined(MBEDTLS_HAVE_TIME)
2502 needed += 8; /* start_time or ticket_received */
2503#endif
2504
2505#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002507#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002508 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002510#endif
2511
Jerry Yu438ddd82022-07-07 06:55:50 +00002512 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002513 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002514
2515 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 if (session->ticket_len > SIZE_MAX - needed) {
2517 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2518 }
Jerry Yu34191072022-08-18 10:32:09 +08002519
Jerry Yue28d9742022-08-18 15:44:03 +08002520 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002521 }
2522#endif /* MBEDTLS_SSL_CLI_C */
2523
Jerry Yue36fdd62022-08-17 21:31:36 +08002524 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 if (needed > buf_len) {
2526 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2527 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002528
2529 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2531 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002532 p[7] = session->ticket_flags;
2533
2534 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002535 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002536 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002537 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002538 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002539
2540#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2542 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002543 p += 8;
2544 }
2545#endif /* MBEDTLS_HAVE_TIME */
2546
2547#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002549#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002551 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002553 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002555 p += hostname_len;
2556 }
2557#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2558
Jerry Yu438ddd82022-07-07 06:55:50 +00002559#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002561 p += 8;
2562#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002564 p += 4;
2565
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002567 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002568
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 if (session->ticket != NULL && session->ticket_len > 0) {
2570 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002571 p += session->ticket_len;
2572 }
2573 }
2574#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002576}
2577
2578MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002579static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2580 const unsigned char *buf,
2581 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002582{
2583 const unsigned char *p = buf;
2584 const unsigned char *end = buf + len;
2585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 if (end - p < 9) {
2587 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2588 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002589 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2591 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002592 session->ticket_flags = p[7];
2593
2594 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002595 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002596 p += 9;
2597
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 if (end - p < session->resumption_key_len) {
2599 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2600 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002601
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2603 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2604 }
2605 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002606 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002607
2608#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2610 if (end - p < 8) {
2611 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2612 }
2613 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002614 p += 8;
2615 }
2616#endif /* MBEDTLS_HAVE_TIME */
2617
2618#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002620#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002622 size_t hostname_len;
2623 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 if (end - p < 2) {
2625 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2626 }
2627 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002628 p += 2;
2629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (end - p < (long int) hostname_len) {
2631 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2632 }
2633 if (hostname_len > 0) {
2634 session->hostname = mbedtls_calloc(1, hostname_len);
2635 if (session->hostname == NULL) {
2636 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2637 }
2638 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002639 p += hostname_len;
2640 }
2641#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2642 MBEDTLS_SSL_SESSION_TICKETS */
2643
Jerry Yu438ddd82022-07-07 06:55:50 +00002644#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 if (end - p < 8) {
2646 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2647 }
2648 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002649 p += 8;
2650#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 if (end - p < 4) {
2652 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2653 }
2654 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002655 p += 4;
2656
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 if (end - p < 2) {
2658 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2659 }
2660 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002661 p += 2;
2662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 if (end - p < (long int) session->ticket_len) {
2664 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2665 }
2666 if (session->ticket_len > 0) {
2667 session->ticket = mbedtls_calloc(1, session->ticket_len);
2668 if (session->ticket == NULL) {
2669 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2670 }
2671 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002672 p += session->ticket_len;
2673 }
2674 }
2675#endif /* MBEDTLS_SSL_CLI_C */
2676
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002678
2679}
2680#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002681MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002682static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2683 unsigned char *buf,
2684 size_t buf_len,
2685 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002686{
2687 ((void) session);
2688 ((void) buf);
2689 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002690 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002692}
Jerry Yu438ddd82022-07-07 06:55:50 +00002693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2695 unsigned char *buf,
2696 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002697{
2698 ((void) session);
2699 ((void) buf);
2700 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002702}
2703#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002704#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2705
Gilles Peskine449bd832023-01-11 14:50:10 +01002706psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2707 size_t taglen,
2708 psa_algorithm_t *alg,
2709 psa_key_type_t *key_type,
2710 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002711{
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002713 case MBEDTLS_CIPHER_AES_128_CBC:
2714 *alg = PSA_ALG_CBC_NO_PADDING;
2715 *key_type = PSA_KEY_TYPE_AES;
2716 *key_size = 128;
2717 break;
2718 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002720 *key_type = PSA_KEY_TYPE_AES;
2721 *key_size = 128;
2722 break;
2723 case MBEDTLS_CIPHER_AES_128_GCM:
2724 *alg = PSA_ALG_GCM;
2725 *key_type = PSA_KEY_TYPE_AES;
2726 *key_size = 128;
2727 break;
2728 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002729 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002730 *key_type = PSA_KEY_TYPE_AES;
2731 *key_size = 192;
2732 break;
2733 case MBEDTLS_CIPHER_AES_192_GCM:
2734 *alg = PSA_ALG_GCM;
2735 *key_type = PSA_KEY_TYPE_AES;
2736 *key_size = 192;
2737 break;
2738 case MBEDTLS_CIPHER_AES_256_CBC:
2739 *alg = PSA_ALG_CBC_NO_PADDING;
2740 *key_type = PSA_KEY_TYPE_AES;
2741 *key_size = 256;
2742 break;
2743 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002745 *key_type = PSA_KEY_TYPE_AES;
2746 *key_size = 256;
2747 break;
2748 case MBEDTLS_CIPHER_AES_256_GCM:
2749 *alg = PSA_ALG_GCM;
2750 *key_type = PSA_KEY_TYPE_AES;
2751 *key_size = 256;
2752 break;
2753 case MBEDTLS_CIPHER_ARIA_128_CBC:
2754 *alg = PSA_ALG_CBC_NO_PADDING;
2755 *key_type = PSA_KEY_TYPE_ARIA;
2756 *key_size = 128;
2757 break;
2758 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002760 *key_type = PSA_KEY_TYPE_ARIA;
2761 *key_size = 128;
2762 break;
2763 case MBEDTLS_CIPHER_ARIA_128_GCM:
2764 *alg = PSA_ALG_GCM;
2765 *key_type = PSA_KEY_TYPE_ARIA;
2766 *key_size = 128;
2767 break;
2768 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002770 *key_type = PSA_KEY_TYPE_ARIA;
2771 *key_size = 192;
2772 break;
2773 case MBEDTLS_CIPHER_ARIA_192_GCM:
2774 *alg = PSA_ALG_GCM;
2775 *key_type = PSA_KEY_TYPE_ARIA;
2776 *key_size = 192;
2777 break;
2778 case MBEDTLS_CIPHER_ARIA_256_CBC:
2779 *alg = PSA_ALG_CBC_NO_PADDING;
2780 *key_type = PSA_KEY_TYPE_ARIA;
2781 *key_size = 256;
2782 break;
2783 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002785 *key_type = PSA_KEY_TYPE_ARIA;
2786 *key_size = 256;
2787 break;
2788 case MBEDTLS_CIPHER_ARIA_256_GCM:
2789 *alg = PSA_ALG_GCM;
2790 *key_type = PSA_KEY_TYPE_ARIA;
2791 *key_size = 256;
2792 break;
2793 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2794 *alg = PSA_ALG_CBC_NO_PADDING;
2795 *key_type = PSA_KEY_TYPE_CAMELLIA;
2796 *key_size = 128;
2797 break;
2798 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002800 *key_type = PSA_KEY_TYPE_CAMELLIA;
2801 *key_size = 128;
2802 break;
2803 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2804 *alg = PSA_ALG_GCM;
2805 *key_type = PSA_KEY_TYPE_CAMELLIA;
2806 *key_size = 128;
2807 break;
2808 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002810 *key_type = PSA_KEY_TYPE_CAMELLIA;
2811 *key_size = 192;
2812 break;
2813 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2814 *alg = PSA_ALG_GCM;
2815 *key_type = PSA_KEY_TYPE_CAMELLIA;
2816 *key_size = 192;
2817 break;
2818 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2819 *alg = PSA_ALG_CBC_NO_PADDING;
2820 *key_type = PSA_KEY_TYPE_CAMELLIA;
2821 *key_size = 256;
2822 break;
2823 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002825 *key_type = PSA_KEY_TYPE_CAMELLIA;
2826 *key_size = 256;
2827 break;
2828 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2829 *alg = PSA_ALG_GCM;
2830 *key_type = PSA_KEY_TYPE_CAMELLIA;
2831 *key_size = 256;
2832 break;
2833 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2834 *alg = PSA_ALG_CHACHA20_POLY1305;
2835 *key_type = PSA_KEY_TYPE_CHACHA20;
2836 *key_size = 256;
2837 break;
2838 case MBEDTLS_CIPHER_NULL:
2839 *alg = MBEDTLS_SSL_NULL_CIPHER;
2840 *key_type = 0;
2841 *key_size = 0;
2842 break;
2843 default:
2844 return PSA_ERROR_NOT_SUPPORTED;
2845 }
2846
2847 return PSA_SUCCESS;
2848}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002849#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002850
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002851#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002852int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2853 const unsigned char *dhm_P, size_t P_len,
2854 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002855{
Janos Follath865b3eb2019-12-16 11:46:15 +00002856 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 mbedtls_mpi_free(&conf->dhm_P);
2859 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2862 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2863 mbedtls_mpi_free(&conf->dhm_P);
2864 mbedtls_mpi_free(&conf->dhm_G);
2865 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002866 }
2867
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002869}
Paul Bakker5121ce52009-01-03 21:22:43 +00002870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002872{
Janos Follath865b3eb2019-12-16 11:46:15 +00002873 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 mbedtls_mpi_free(&conf->dhm_P);
2876 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002877
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2879 &conf->dhm_P)) != 0 ||
2880 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2881 &conf->dhm_G)) != 0) {
2882 mbedtls_mpi_free(&conf->dhm_P);
2883 mbedtls_mpi_free(&conf->dhm_G);
2884 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002885 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002886
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002888}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002889#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002890
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002891#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2892/*
2893 * Set the minimum length for Diffie-Hellman parameters
2894 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002895void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2896 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002897{
2898 conf->dhm_min_bitlen = bitlen;
2899}
2900#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2901
Ronald Crone68ab4f2022-10-05 12:46:29 +02002902#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002903#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002904/*
2905 * Set allowed/preferred hashes for handshake signatures
2906 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002907void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2908 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002909{
2910 conf->sig_hashes = hashes;
2911}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002912#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002913
Jerry Yuf017ee42022-01-12 15:49:48 +08002914/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002915void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2916 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002917{
Jerry Yuf017ee42022-01-12 15:49:48 +08002918#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2919 conf->sig_hashes = NULL;
2920#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2921 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002922}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002923#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002924
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002925#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002926#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002927/*
2928 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002929 *
2930 * mbedtls_ssl_setup() takes the provided list
2931 * and translates it to a list of IANA TLS group identifiers,
2932 * stored in ssl->handshake->group_list.
2933 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002934 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002935void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2936 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002937{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002938 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002939 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002940}
Brett Warrene0edc842021-08-17 09:53:13 +01002941#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002942#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002943
Brett Warrene0edc842021-08-17 09:53:13 +01002944/*
2945 * Set the allowed groups
2946 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002947void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2948 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002949{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002950#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002951 conf->curve_list = NULL;
2952#endif
2953 conf->group_list = group_list;
2954}
2955
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002956#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002957int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002958{
Hanno Becker947194e2017-04-07 13:25:49 +01002959 /* Initialize to suppress unnecessary compiler warning */
2960 size_t hostname_len = 0;
2961
2962 /* Check if new hostname is valid before
2963 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 if (hostname != NULL) {
2965 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002966
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2968 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2969 }
Hanno Becker947194e2017-04-07 13:25:49 +01002970 }
2971
2972 /* Now it's clear that we will overwrite the old hostname,
2973 * so we can free it safely */
2974
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002976 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002977 }
2978
2979 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002980
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002982 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 } else {
2984 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2985 if (ssl->hostname == NULL) {
2986 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2987 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002988
Gilles Peskine449bd832023-01-11 14:50:10 +01002989 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002990
Hanno Becker947194e2017-04-07 13:25:49 +01002991 ssl->hostname[hostname_len] = '\0';
2992 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002993
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002995}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002996#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002997
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002998#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002999void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3000 int (*f_sni)(void *, mbedtls_ssl_context *,
3001 const unsigned char *, size_t),
3002 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003003{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003004 conf->f_sni = f_sni;
3005 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003006}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003010int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003011{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003012 size_t cur_len, tot_len;
3013 const char **p;
3014
3015 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003016 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3017 * MUST NOT be truncated."
3018 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003019 */
3020 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 for (p = protos; *p != NULL; p++) {
3022 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003023 tot_len += cur_len;
3024
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 if ((cur_len == 0) ||
3026 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3027 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3028 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3029 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003030 }
3031
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003032 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003033
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003035}
3036
Gilles Peskine449bd832023-01-11 14:50:10 +01003037const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003038{
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003040}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003042
Johan Pascalb62bb512015-12-03 21:56:45 +01003043#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003044void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3045 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003046{
3047 conf->dtls_srtp_mki_support = support_mki_value;
3048}
3049
Gilles Peskine449bd832023-01-11 14:50:10 +01003050int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3051 unsigned char *mki_value,
3052 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003053{
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3055 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003056 }
Ron Eldor591f1622018-01-22 12:30:04 +02003057
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3059 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003060 }
Ron Eldor591f1622018-01-22 12:30:04 +02003061
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003063 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003065}
3066
Gilles Peskine449bd832023-01-11 14:50:10 +01003067int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3068 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003069{
Johan Pascal253d0262020-09-22 13:04:45 +02003070 const mbedtls_ssl_srtp_profile *p;
3071 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003072
Johan Pascal253d0262020-09-22 13:04:45 +02003073 /* check the profiles list: all entry must be valid,
3074 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3076 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3077 p++) {
3078 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003079 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003081 /* unsupported value, stop parsing and set the size to an error value */
3082 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003083 }
3084 }
3085
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3087 conf->dtls_srtp_profile_list = NULL;
3088 conf->dtls_srtp_profile_list_len = 0;
3089 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003090 }
3091
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003092 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003093 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003094
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003096}
3097
Gilles Peskine449bd832023-01-11 14:50:10 +01003098void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3099 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003100{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003101 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3102 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003104 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003106 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3108 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003109 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003110}
Johan Pascalb62bb512015-12-03 21:56:45 +01003111#endif /* MBEDTLS_SSL_DTLS_SRTP */
3112
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303113#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003114void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003115{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003116 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003117}
3118
Gilles Peskine449bd832023-01-11 14:50:10 +01003119void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003120{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003121 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003122}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303123#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003124
Janos Follath088ce432017-04-10 12:42:31 +01003125#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003126void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3127 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003128{
3129 conf->cert_req_ca_list = cert_req_ca_list;
3130}
3131#endif
3132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003133#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003134void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003135{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003136 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003137}
3138#endif
3139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003141void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003142{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003143 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003144}
3145#endif
3146
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003148int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003149{
Gilles Peskine449bd832023-01-11 14:50:10 +01003150 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3151 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3152 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003153 }
3154
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003155 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003156
Gilles Peskine449bd832023-01-11 14:50:10 +01003157 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003158}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003159#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003160
Gilles Peskine449bd832023-01-11 14:50:10 +01003161void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003162{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003163 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003164}
3165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003166#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003167void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003168{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003169 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003170}
3171
Gilles Peskine449bd832023-01-11 14:50:10 +01003172void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003173{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003174 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003175}
3176
Gilles Peskine449bd832023-01-11 14:50:10 +01003177void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3178 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003179{
Gilles Peskine449bd832023-01-11 14:50:10 +01003180 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003181}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003182#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003184#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003185#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003186void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003187{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003188 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003189}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003190#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003191
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003192#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003193
Jerry Yud0766ec2022-09-22 10:46:57 +08003194#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003195void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3196 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003197{
Jerry Yud0766ec2022-09-22 10:46:57 +08003198 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003199}
3200#endif
3201
Gilles Peskine449bd832023-01-11 14:50:10 +01003202void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3203 mbedtls_ssl_ticket_write_t *f_ticket_write,
3204 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3205 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003206{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003207 conf->f_ticket_write = f_ticket_write;
3208 conf->f_ticket_parse = f_ticket_parse;
3209 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003210}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003211#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003213
Gilles Peskine449bd832023-01-11 14:50:10 +01003214void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3215 mbedtls_ssl_export_keys_t *f_export_keys,
3216 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003217{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003218 ssl->f_export_keys = f_export_keys;
3219 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003220}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003221
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003222#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003223void mbedtls_ssl_conf_async_private_cb(
3224 mbedtls_ssl_config *conf,
3225 mbedtls_ssl_async_sign_t *f_async_sign,
3226 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3227 mbedtls_ssl_async_resume_t *f_async_resume,
3228 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003229 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003230{
3231 conf->f_async_sign_start = f_async_sign;
3232 conf->f_async_decrypt_start = f_async_decrypt;
3233 conf->f_async_resume = f_async_resume;
3234 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003235 conf->p_async_config_data = async_config_data;
3236}
3237
Gilles Peskine449bd832023-01-11 14:50:10 +01003238void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003239{
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003241}
3242
Gilles Peskine449bd832023-01-11 14:50:10 +01003243void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003244{
Gilles Peskine449bd832023-01-11 14:50:10 +01003245 if (ssl->handshake == NULL) {
3246 return NULL;
3247 } else {
3248 return ssl->handshake->user_async_ctx;
3249 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003250}
3251
Gilles Peskine449bd832023-01-11 14:50:10 +01003252void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3253 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003254{
Gilles Peskine449bd832023-01-11 14:50:10 +01003255 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003256 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003257 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003258}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003259#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003260
Paul Bakker5121ce52009-01-03 21:22:43 +00003261/*
3262 * SSL get accessors
3263 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003264uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003265{
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 if (ssl->session != NULL) {
3267 return ssl->session->verify_result;
3268 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003269
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 if (ssl->session_negotiate != NULL) {
3271 return ssl->session_negotiate->verify_result;
3272 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003273
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003275}
3276
Gilles Peskine449bd832023-01-11 14:50:10 +01003277int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003278{
Gilles Peskine449bd832023-01-11 14:50:10 +01003279 if (ssl == NULL || ssl->session == NULL) {
3280 return 0;
3281 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003282
Gilles Peskine449bd832023-01-11 14:50:10 +01003283 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003284}
3285
Gilles Peskine449bd832023-01-11 14:50:10 +01003286const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003287{
Gilles Peskine449bd832023-01-11 14:50:10 +01003288 if (ssl == NULL || ssl->session == NULL) {
3289 return NULL;
3290 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003291
Gilles Peskine449bd832023-01-11 14:50:10 +01003292 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003293}
3294
Gilles Peskine449bd832023-01-11 14:50:10 +01003295const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003296{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003297#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3299 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003300 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003302 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003303 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003304 }
3305 }
3306#endif
3307
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003309 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003311 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003313 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003315 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003316}
3317
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003318#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003319size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003320{
David Horstmann95d516f2021-05-04 18:36:56 +01003321 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003322 size_t read_mfl;
3323
Jerry Yuddda0502022-12-01 19:43:12 +08003324#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003325 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003326 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3327 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3328 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003329 }
Jerry Yuddda0502022-12-01 19:43:12 +08003330#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003331
3332 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 if (ssl->session_out != NULL) {
3334 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3335 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003336 max_len = read_mfl;
3337 }
3338 }
3339
Jerry Yuddda0502022-12-01 19:43:12 +08003340 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003341 if (ssl->session_negotiate != NULL) {
3342 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3343 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003344 max_len = read_mfl;
3345 }
3346 }
3347
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003349}
3350
Gilles Peskine449bd832023-01-11 14:50:10 +01003351size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003352{
3353 size_t max_len;
3354
3355 /*
3356 * Assume mfl_code is correct since it was checked when set
3357 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003359
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003360 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 if (ssl->session_out != NULL &&
3362 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3363 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003364 }
3365
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003366 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003367 if (ssl->session_negotiate != NULL &&
3368 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3369 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003370 }
3371
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003373}
3374#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3375
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003376#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003377size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003378{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003379 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003380 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3381 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3382 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3383 return 0;
3384 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003385
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3387 return ssl->mtu;
3388 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003389
Gilles Peskine449bd832023-01-11 14:50:10 +01003390 if (ssl->mtu == 0) {
3391 return ssl->handshake->mtu;
3392 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003393
Gilles Peskine449bd832023-01-11 14:50:10 +01003394 return ssl->mtu < ssl->handshake->mtu ?
3395 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003396}
3397#endif /* MBEDTLS_SSL_PROTO_DTLS */
3398
Gilles Peskine449bd832023-01-11 14:50:10 +01003399int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003400{
3401 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3402
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003403#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3404 !defined(MBEDTLS_SSL_PROTO_DTLS)
3405 (void) ssl;
3406#endif
3407
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003408#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003409 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003410
Gilles Peskine449bd832023-01-11 14:50:10 +01003411 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003412 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003414#endif
3415
3416#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003417 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3418 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3419 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003420 const size_t overhead = (size_t) ret;
3421
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 if (ret < 0) {
3423 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003424 }
3425
Gilles Peskine449bd832023-01-11 14:50:10 +01003426 if (mtu <= overhead) {
3427 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3428 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3429 }
3430
3431 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003432 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003433 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003434 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003435#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003436
Hanno Becker0defedb2018-08-10 12:35:02 +01003437#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3438 !defined(MBEDTLS_SSL_PROTO_DTLS)
3439 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003440#endif
3441
Gilles Peskine449bd832023-01-11 14:50:10 +01003442 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003443}
3444
Gilles Peskine449bd832023-01-11 14:50:10 +01003445int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003446{
3447 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3448
3449#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3450 (void) ssl;
3451#endif
3452
3453#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003454 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003455
Gilles Peskine449bd832023-01-11 14:50:10 +01003456 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003457 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003459#endif
3460
Gilles Peskine449bd832023-01-11 14:50:10 +01003461 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003462}
3463
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003464#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003465const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003466{
Gilles Peskine449bd832023-01-11 14:50:10 +01003467 if (ssl == NULL || ssl->session == NULL) {
3468 return NULL;
3469 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003470
Hanno Beckere6824572019-02-07 13:18:46 +00003471#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003472 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003473#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003474 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003475#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003476}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003477#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003479#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003480int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3481 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003482{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003483 int ret;
3484
Gilles Peskine449bd832023-01-11 14:50:10 +01003485 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003486 dst == NULL ||
3487 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003488 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3489 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003490 }
3491
Hanno Beckere810bbc2021-05-14 16:01:05 +01003492 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3493 * idempotent: Each session can only be exported once.
3494 *
3495 * (This is in preparation for TLS 1.3 support where we will
3496 * need the ability to export multiple sessions (aka tickets),
3497 * which will be achieved by calling mbedtls_ssl_get_session()
3498 * multiple times until it fails.)
3499 *
3500 * Check whether we have already exported the current session,
3501 * and fail if so.
3502 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003503 if (ssl->session->exported == 1) {
3504 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3505 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003506
Gilles Peskine449bd832023-01-11 14:50:10 +01003507 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3508 if (ret != 0) {
3509 return ret;
3510 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003511
3512 /* Remember that we've exported the session. */
3513 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003514 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003515}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003516#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003517
Paul Bakker5121ce52009-01-03 21:22:43 +00003518/*
Hanno Beckera835da52019-05-16 12:39:07 +01003519 * Define ticket header determining Mbed TLS version
3520 * and structure of the ticket.
3521 */
3522
Hanno Becker94ef3b32019-05-16 12:50:45 +01003523/*
Hanno Becker50b59662019-05-28 14:30:45 +01003524 * Define bitflag determining compile-time settings influencing
3525 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003526 */
3527
Hanno Becker50b59662019-05-28 14:30:45 +01003528#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003529#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003530#else
Hanno Becker3e088662019-05-29 11:10:18 +01003531#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003532#endif /* MBEDTLS_HAVE_TIME */
3533
3534#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003535#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003536#else
Hanno Becker3e088662019-05-29 11:10:18 +01003537#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003538#endif /* MBEDTLS_X509_CRT_PARSE_C */
3539
3540#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003541#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003542#else
Hanno Becker3e088662019-05-29 11:10:18 +01003543#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003544#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3545
3546#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003547#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003548#else
Hanno Becker3e088662019-05-29 11:10:18 +01003549#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003550#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3551
Hanno Becker94ef3b32019-05-16 12:50:45 +01003552#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003553#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003554#else
Hanno Becker3e088662019-05-29 11:10:18 +01003555#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003556#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3557
Hanno Becker94ef3b32019-05-16 12:50:45 +01003558#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3559#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3560#else
3561#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3562#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3563
Hanno Becker3e088662019-05-29 11:10:18 +01003564#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3565#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3566#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3567#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003568#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3569#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003570
Hanno Becker50b59662019-05-28 14:30:45 +01003571#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003572 ((uint16_t) ( \
3573 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3574 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3575 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3576 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3577 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3578 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3579 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003580
Hanno Beckerf8787072019-05-16 12:41:07 +01003581static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003582 MBEDTLS_VERSION_MAJOR,
3583 MBEDTLS_VERSION_MINOR,
3584 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003585 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3586 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003587};
Hanno Beckera835da52019-05-16 12:39:07 +01003588
3589/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003590 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003591 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003592 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003593 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003594 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003595 * opaque mbedtls_version[3]; // library version: major, minor, patch
3596 * opaque session_format[2]; // library-version specific 16-bit field
3597 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003598 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003599 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003600 * Note: When updating the format, remember to keep
3601 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003602 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003603 * // In this version, `session_format` determines
3604 * // the setting of those compile-time
3605 * // configuration options which influence
3606 * // the structure of mbedtls_ssl_session.
3607 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003608 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003609 * // - TLS 1.2 (0x0303)
3610 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003611 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003612 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003613 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003614 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003615 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003616 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003617 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003618 *
3619 * };
3620 *
3621 * } serialized_session;
3622 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003623 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003624
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003625MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003626static int ssl_session_save(const mbedtls_ssl_session *session,
3627 unsigned char omit_header,
3628 unsigned char *buf,
3629 size_t buf_len,
3630 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003631{
3632 unsigned char *p = buf;
3633 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003634 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003635#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3636 size_t out_len;
3637 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3638#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003639 if (session == NULL) {
3640 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3641 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003642
Gilles Peskine449bd832023-01-11 14:50:10 +01003643 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003644 /*
3645 * Add Mbed TLS version identifier
3646 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003647 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003648
Gilles Peskine449bd832023-01-11 14:50:10 +01003649 if (used <= buf_len) {
3650 memcpy(p, ssl_serialized_session_header,
3651 sizeof(ssl_serialized_session_header));
3652 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003653 }
3654 }
3655
3656 /*
3657 * TLS version identifier
3658 */
3659 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003660 if (used <= buf_len) {
3661 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003662 }
3663
3664 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003665 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003666 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003667#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003668 case MBEDTLS_SSL_VERSION_TLS1_2:
3669 used += ssl_tls12_session_save(session, p, remaining_len);
3670 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003671#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3672
Jerry Yu251a12e2022-07-13 15:15:48 +08003673#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003674 case MBEDTLS_SSL_VERSION_TLS1_3:
3675 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3676 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3677 return ret;
3678 }
3679 used += out_len;
3680 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003681#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3682
Gilles Peskine449bd832023-01-11 14:50:10 +01003683 default:
3684 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003685 }
3686
3687 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003688 if (used > buf_len) {
3689 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3690 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003691
Gilles Peskine449bd832023-01-11 14:50:10 +01003692 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003693}
3694
3695/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003696 * Public wrapper for ssl_session_save()
3697 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003698int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3699 unsigned char *buf,
3700 size_t buf_len,
3701 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003702{
Gilles Peskine449bd832023-01-11 14:50:10 +01003703 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003704}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003705
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003706/*
3707 * Deserialize session, see mbedtls_ssl_session_save() for format.
3708 *
3709 * This internal version is wrapped by a public function that cleans up in
3710 * case of error, and has an extra option omit_header.
3711 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003712MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003713static int ssl_session_load(mbedtls_ssl_session *session,
3714 unsigned char omit_header,
3715 const unsigned char *buf,
3716 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003717{
3718 const unsigned char *p = buf;
3719 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003720 size_t remaining_len;
3721
3722
Gilles Peskine449bd832023-01-11 14:50:10 +01003723 if (session == NULL) {
3724 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3725 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003726
Gilles Peskine449bd832023-01-11 14:50:10 +01003727 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003728 /*
3729 * Check Mbed TLS version identifier
3730 */
3731
Gilles Peskine449bd832023-01-11 14:50:10 +01003732 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3733 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003734 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003735
3736 if (memcmp(p, ssl_serialized_session_header,
3737 sizeof(ssl_serialized_session_header)) != 0) {
3738 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3739 }
3740 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003741 }
3742
3743 /*
3744 * TLS version identifier
3745 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003746 if (1 > (size_t) (end - p)) {
3747 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3748 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003749 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003750
3751 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003752 remaining_len = (end - p);
3753 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003754#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003755 case MBEDTLS_SSL_VERSION_TLS1_2:
3756 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003757#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3758
Jerry Yu438ddd82022-07-07 06:55:50 +00003759#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003760 case MBEDTLS_SSL_VERSION_TLS1_3:
3761 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003762#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3763
Gilles Peskine449bd832023-01-11 14:50:10 +01003764 default:
3765 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003766 }
3767}
3768
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003769/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003770 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003771 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003772int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3773 const unsigned char *buf,
3774 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003775{
Gilles Peskine449bd832023-01-11 14:50:10 +01003776 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003777
Gilles Peskine449bd832023-01-11 14:50:10 +01003778 if (ret != 0) {
3779 mbedtls_ssl_session_free(session);
3780 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003781
Gilles Peskine449bd832023-01-11 14:50:10 +01003782 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003783}
3784
3785/*
Paul Bakker1961b702013-01-25 14:49:24 +01003786 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003787 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003788MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003789static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003790{
3791 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3792
Ronald Cron66dbf912022-02-02 15:33:46 +01003793 /*
3794 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003795 * that were written into the output buffer by the previous handshake step,
3796 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003797 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3798 * We proceed to the next handshake step only when all data from the
3799 * previous one have been sent to the peer, thus we make sure that this is
3800 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3801 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3802 * we have to wait before to go ahead.
3803 * In the case of TLS 1.3, handshake step handlers do not send data to the
3804 * peer. Data are only sent here and through
3805 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003806 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003807 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003808 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3809 return ret;
3810 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003811
3812#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003813 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3814 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3815 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3816 return ret;
3817 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003818 }
3819#endif /* MBEDTLS_SSL_PROTO_DTLS */
3820
Gilles Peskine449bd832023-01-11 14:50:10 +01003821 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003822}
3823
Gilles Peskine449bd832023-01-11 14:50:10 +01003824int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003825{
Hanno Becker41934dd2021-08-07 19:13:43 +01003826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003827
Gilles Peskine449bd832023-01-11 14:50:10 +01003828 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003829 ssl->conf == NULL ||
3830 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003831 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3832 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003833 }
3834
Gilles Peskine449bd832023-01-11 14:50:10 +01003835 ret = ssl_prepare_handshake_step(ssl);
3836 if (ret != 0) {
3837 return ret;
3838 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003839
Gilles Peskine449bd832023-01-11 14:50:10 +01003840 ret = mbedtls_ssl_handle_pending_alert(ssl);
3841 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003842 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003843 }
Jerry Yue7047812021-09-13 19:26:39 +08003844
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003845 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3846 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3847 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3848
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003849#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003850 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3851 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003852 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003853
Gilles Peskine449bd832023-01-11 14:50:10 +01003854 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003855 case MBEDTLS_SSL_HELLO_REQUEST:
3856 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003857 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003858 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003859
Ronald Cron9f0fba32022-02-10 16:45:15 +01003860 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003861 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003862 break;
3863
3864 default:
3865#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003866 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3867 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3868 } else {
3869 ret = mbedtls_ssl_handshake_client_step(ssl);
3870 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003871#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003872 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003873#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003874 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003875#endif
3876 }
Jerry Yub9930e72021-08-06 17:11:51 +08003877 }
Ronald Cron6291b232023-03-08 15:51:25 +01003878#endif /* MBEDTLS_SSL_CLI_C */
3879
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003880#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003881 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003882#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3883 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003884 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003885 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003886 ret = mbedtls_ssl_handshake_server_step(ssl);
3887 }
Ronald Cron6291b232023-03-08 15:51:25 +01003888#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3889 ret = mbedtls_ssl_handshake_server_step(ssl);
3890#else
3891 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003892#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003893 }
3894#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003895
Gilles Peskine449bd832023-01-11 14:50:10 +01003896 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003897 /* handshake_step return error. And it is same
3898 * with alert_reason.
3899 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003900 if (ssl->send_alert) {
3901 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003902 goto cleanup;
3903 }
3904 }
3905
3906cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003907 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003908}
3909
3910/*
3911 * Perform the SSL handshake
3912 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003913int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003914{
3915 int ret = 0;
3916
Hanno Beckera817ea42020-10-20 15:20:23 +01003917 /* Sanity checks */
3918
Gilles Peskine449bd832023-01-11 14:50:10 +01003919 if (ssl == NULL || ssl->conf == NULL) {
3920 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3921 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003922
Hanno Beckera817ea42020-10-20 15:20:23 +01003923#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003924 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3925 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3926 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3927 "mbedtls_ssl_set_timer_cb() for DTLS"));
3928 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003929 }
3930#endif /* MBEDTLS_SSL_PROTO_DTLS */
3931
Gilles Peskine449bd832023-01-11 14:50:10 +01003932 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003933
Hanno Beckera817ea42020-10-20 15:20:23 +01003934 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003935 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3936 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003937
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003939 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003940 }
Paul Bakker1961b702013-01-25 14:49:24 +01003941 }
3942
Gilles Peskine449bd832023-01-11 14:50:10 +01003943 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003944
Gilles Peskine449bd832023-01-11 14:50:10 +01003945 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003946}
3947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003948#if defined(MBEDTLS_SSL_RENEGOTIATION)
3949#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003950/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003951 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003952 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003953MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003954static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003955{
Janos Follath865b3eb2019-12-16 11:46:15 +00003956 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003957
Gilles Peskine449bd832023-01-11 14:50:10 +01003958 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003959
3960 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003961 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3962 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003963
Gilles Peskine449bd832023-01-11 14:50:10 +01003964 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3965 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3966 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003967 }
3968
Gilles Peskine449bd832023-01-11 14:50:10 +01003969 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003970
Gilles Peskine449bd832023-01-11 14:50:10 +01003971 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003972}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003973#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003974
3975/*
3976 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003977 * - any side: calling mbedtls_ssl_renegotiate(),
3978 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3979 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003980 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003981 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003982 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003983 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003984int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003985{
Janos Follath865b3eb2019-12-16 11:46:15 +00003986 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003987
Gilles Peskine449bd832023-01-11 14:50:10 +01003988 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00003989
Gilles Peskine449bd832023-01-11 14:50:10 +01003990 if ((ret = ssl_handshake_init(ssl)) != 0) {
3991 return ret;
3992 }
Paul Bakker48916f92012-09-16 19:57:18 +00003993
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003994 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3995 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003996#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003997 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3998 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
3999 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004000 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004001 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004002 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004004 }
4005#endif
4006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004007 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4008 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004009
Gilles Peskine449bd832023-01-11 14:50:10 +01004010 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4011 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4012 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004013 }
4014
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004016
Gilles Peskine449bd832023-01-11 14:50:10 +01004017 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004018}
4019
4020/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004021 * Renegotiate current connection on client,
4022 * or request renegotiation on server
4023 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004024int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004025{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004026 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004027
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 if (ssl == NULL || ssl->conf == NULL) {
4029 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4030 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004031
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004032#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004033 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4035 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4036 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4037 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004038
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004039 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004040
4041 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004042 if (ssl->out_left != 0) {
4043 return mbedtls_ssl_flush_output(ssl);
4044 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004045
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004047 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004048#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004049
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004050#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004051 /*
4052 * On client, either start the renegotiation process or,
4053 * if already in progress, continue the handshake
4054 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004055 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4056 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4057 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004058 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004059
4060 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4061 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4062 return ret;
4063 }
4064 } else {
4065 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4066 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4067 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004068 }
4069 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004070#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004071
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004073}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004074#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004075
Gilles Peskine449bd832023-01-11 14:50:10 +01004076void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004077{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004078 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4079
Gilles Peskine449bd832023-01-11 14:50:10 +01004080 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004081 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004083
Valerio Setti6f0441d2023-07-03 12:11:36 +02004084#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004085#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 if (ssl->handshake->group_list_heap_allocated) {
4087 mbedtls_free((void *) handshake->group_list);
4088 }
Brett Warrene0edc842021-08-17 09:53:13 +01004089 handshake->group_list = NULL;
4090#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004091#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004092
Ronald Crone68ab4f2022-10-05 12:46:29 +02004093#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004094#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004095 if (ssl->handshake->sig_algs_heap_allocated) {
4096 mbedtls_free((void *) handshake->sig_algs);
4097 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004098 handshake->sig_algs = NULL;
4099#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004100#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 if (ssl->handshake->certificate_request_context) {
4102 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004103 }
4104#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004105#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004106
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004107#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004108 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4109 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004110 handshake->async_in_progress = 0;
4111 }
4112#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4113
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004114#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004115#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004116 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004117#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004118 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004119#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004120#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004121#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004122#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004124#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004125 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004126#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004127#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004128
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004129#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004130 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004131#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004132#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004133 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004135#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004136
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004137#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004138#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004140 /*
4141 * Opaque keys are not stored in the handshake's data and it's the user
4142 * responsibility to destroy them. Clear ones, instead, are created by
4143 * the TLS library and should be destroyed at the same level
4144 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4146 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004147 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004148 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4149#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004151#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004152#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004154 handshake->ecjpake_cache = NULL;
4155 handshake->ecjpake_cache_len = 0;
4156#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004157#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004158
Valerio Setti7aeec542023-07-05 18:57:21 +02004159#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004160 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004161 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004162 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004164#endif
4165
Ronald Cron73fe8df2022-10-05 14:31:43 +02004166#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004167#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004168 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004169 /* The maintenance of the external PSK key slot is the
4170 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 if (ssl->handshake->psk_opaque_is_internal) {
4172 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004173 ssl->handshake->psk_opaque_is_internal = 0;
4174 }
4175 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4176 }
Neil Armstronge952a302022-05-03 10:22:14 +02004177#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004178 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004179 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004180 }
Neil Armstronge952a302022-05-03 10:22:14 +02004181#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004182#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004184#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4185 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004186 /*
4187 * Free only the linked list wrapper, not the keys themselves
4188 * since the belong to the SNI callback
4189 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004190 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004191#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004192
Gilles Peskineeccd8882020-03-10 12:19:08 +01004193#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004194 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4195 if (handshake->ecrs_peer_cert != NULL) {
4196 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4197 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004198 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004199#endif
4200
Hanno Becker75173122019-02-06 16:18:31 +00004201#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4202 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004204#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4205
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004206#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4208 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004209#endif /* MBEDTLS_SSL_CLI_C &&
4210 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004211
4212#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 mbedtls_ssl_flight_free(handshake->flight);
4214 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004215#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004216
Valerio Settiea59c432023-07-25 11:14:03 +02004217#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004218 if (handshake->xxdh_psa_privkey_is_external == 0) {
4219 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 }
Valerio Settiea59c432023-07-25 11:14:03 +02004221#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004222
Ronald Cron6f135e12021-12-08 16:57:54 +01004223#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004224 mbedtls_ssl_transform_free(handshake->transform_handshake);
4225 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004226#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4228 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004229#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004230#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004231
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004232
4233#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4234 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4235 * processes datagrams and the fact that a datagram is allowed to have
4236 * several records in it, it is possible that the I/O buffers are not
4237 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4239 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004240#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004241
Jerry Yuba9c7272021-10-30 11:54:10 +08004242 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 mbedtls_platform_zeroize(handshake,
4244 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004245}
4246
Gilles Peskine449bd832023-01-11 14:50:10 +01004247void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004248{
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004250 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004252
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004253#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004255#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004256
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004257#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004258#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4259 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004261#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004263#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004264
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004266}
4267
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004268#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004269
4270#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4271#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4272#else
4273#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4274#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4275
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004276#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004277
4278#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4279#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4280#else
4281#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4282#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4283
4284#if defined(MBEDTLS_SSL_ALPN)
4285#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4286#else
4287#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4288#endif /* MBEDTLS_SSL_ALPN */
4289
4290#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4291#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4292#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4293#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4294
4295#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 ((uint32_t) ( \
4297 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4298 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4299 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4300 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4301 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4302 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4303 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4304 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004305
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004306static unsigned char ssl_serialized_context_header[] = {
4307 MBEDTLS_VERSION_MAJOR,
4308 MBEDTLS_VERSION_MINOR,
4309 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4311 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4312 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4313 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4314 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004315};
4316
Paul Bakker5121ce52009-01-03 21:22:43 +00004317/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004318 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004319 *
4320 * The format of the serialized data is:
4321 * (in the presentation language of TLS, RFC 8446 section 3)
4322 *
4323 * // header
4324 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004325 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004326 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004327 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004328 * Note: When updating the format, remember to keep these
4329 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004330 *
4331 * // session sub-structure
4332 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4333 * // transform sub-structure
4334 * uint8 random[64]; // ServerHello.random+ClientHello.random
4335 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4336 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4337 * // fields from ssl_context
4338 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4339 * uint64 in_window_top; // DTLS: last validated record seq_num
4340 * uint64 in_window; // DTLS: bitmask for replay protection
4341 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4342 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4343 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4344 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4345 *
4346 * Note that many fields of the ssl_context or sub-structures are not
4347 * serialized, as they fall in one of the following categories:
4348 *
4349 * 1. forced value (eg in_left must be 0)
4350 * 2. pointer to dynamically-allocated memory (eg session, transform)
4351 * 3. value can be re-derived from other data (eg session keys from MS)
4352 * 4. value was temporary (eg content of input buffer)
4353 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004355int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4356 unsigned char *buf,
4357 size_t buf_len,
4358 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004359{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004360 unsigned char *p = buf;
4361 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004362 size_t session_len;
4363 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004364
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004365 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004366 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4367 * this function's documentation.
4368 *
4369 * These are due to assumptions/limitations in the implementation. Some of
4370 * them are likely to stay (no handshake in progress) some might go away
4371 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004372 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004373 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4375 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4376 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004377 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 if (ssl->handshake != NULL) {
4379 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4380 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004381 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004382 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (ssl->transform == NULL || ssl->session == NULL) {
4384 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4385 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004386 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004387 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 if (mbedtls_ssl_check_pending(ssl) != 0) {
4389 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4390 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004391 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 if (ssl->out_left != 0) {
4393 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4394 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004395 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004396 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4398 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4399 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004400 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004401 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4403 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4404 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004405 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004406 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4408 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4409 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004410 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004411 /* Renegotiation must not be enabled */
4412#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4414 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4415 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004416 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004417#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004418
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004419 /*
4420 * Version and format identifier
4421 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004423
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 if (used <= buf_len) {
4425 memcpy(p, ssl_serialized_context_header,
4426 sizeof(ssl_serialized_context_header));
4427 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004428 }
4429
4430 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004431 * Session (length + data)
4432 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4434 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4435 return ret;
4436 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004437
4438 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 if (used <= buf_len) {
4440 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004441 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004442
Gilles Peskine449bd832023-01-11 14:50:10 +01004443 ret = ssl_session_save(ssl->session, 1,
4444 p, session_len, &session_len);
4445 if (ret != 0) {
4446 return ret;
4447 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004448
4449 p += session_len;
4450 }
4451
4452 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004453 * Transform
4454 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 used += sizeof(ssl->transform->randbytes);
4456 if (used <= buf_len) {
4457 memcpy(p, ssl->transform->randbytes,
4458 sizeof(ssl->transform->randbytes));
4459 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004460 }
4461
4462#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4463 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004465 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004467 p += ssl->transform->in_cid_len;
4468
4469 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004471 p += ssl->transform->out_cid_len;
4472 }
4473#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4474
4475 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004476 * Saved fields from top-level ssl_context structure
4477 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004478 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 if (used <= buf_len) {
4480 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004481 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004482 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004483
4484#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4485 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 if (used <= buf_len) {
4487 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004488 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004489
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004491 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004492 }
4493#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4494
4495#if defined(MBEDTLS_SSL_PROTO_DTLS)
4496 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004498 *p++ = ssl->disable_datagram_packing;
4499 }
4500#endif /* MBEDTLS_SSL_PROTO_DTLS */
4501
Jerry Yuae0b2e22021-10-08 15:21:19 +08004502 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 if (used <= buf_len) {
4504 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004505 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004506 }
4507
4508#if defined(MBEDTLS_SSL_PROTO_DTLS)
4509 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 if (used <= buf_len) {
4511 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004512 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004513 }
4514#endif /* MBEDTLS_SSL_PROTO_DTLS */
4515
4516#if defined(MBEDTLS_SSL_ALPN)
4517 {
4518 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004520 : 0;
4521
4522 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004524 *p++ = alpn_len;
4525
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 if (ssl->alpn_chosen != NULL) {
4527 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004528 p += alpn_len;
4529 }
4530 }
4531 }
4532#endif /* MBEDTLS_SSL_ALPN */
4533
4534 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004535 * Done
4536 */
4537 *olen = used;
4538
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 if (used > buf_len) {
4540 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4541 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004542
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004544
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004546}
4547
4548/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004549 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004550 *
4551 * This internal version is wrapped by a public function that cleans up in
4552 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004553 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004554MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004555static int ssl_context_load(mbedtls_ssl_context *ssl,
4556 const unsigned char *buf,
4557 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004558{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004559 const unsigned char *p = buf;
4560 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004561 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004562 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004563#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004564 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004565#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004566
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004567 /*
4568 * The context should have been freshly setup or reset.
4569 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004570 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004571 * renegotiating, or if the user mistakenly loaded a session first.)
4572 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4574 ssl->session != NULL) {
4575 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004576 }
4577
4578 /*
4579 * We can't check that the config matches the initial one, but we can at
4580 * least check it matches the requirements for serializing.
4581 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004582 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004583#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004584 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004585#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004586 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4587 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4588 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4589 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004591 }
4592
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004594
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004595 /*
4596 * Check version identifier
4597 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4599 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004600 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004601
4602 if (memcmp(p, ssl_serialized_context_header,
4603 sizeof(ssl_serialized_context_header)) != 0) {
4604 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4605 }
4606 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004607
4608 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004609 * Session
4610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 if ((size_t) (end - p) < 4) {
4612 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4613 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004614
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004615 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004616 p += 4;
4617
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004618 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004619 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004620 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004621 ssl->session_in = ssl->session;
4622 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004623 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004624
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 if ((size_t) (end - p) < session_len) {
4626 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4627 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 ret = ssl_session_load(ssl->session, 1, p, session_len);
4630 if (ret != 0) {
4631 mbedtls_ssl_session_free(ssl->session);
4632 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004633 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004634
4635 p += session_len;
4636
4637 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004638 * Transform
4639 */
4640
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004641 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004642 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004643#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004644 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004645 ssl->transform_in = ssl->transform;
4646 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004647 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004648#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004649
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004650#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4652 if (prf_func == NULL) {
4653 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4654 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004655
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004656 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4658 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4659 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004660
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 ret = ssl_tls12_populate_transform(ssl->transform,
4662 ssl->session->ciphersuite,
4663 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004664#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004666#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 prf_func,
4668 p, /* currently pointing to randbytes */
4669 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4670 ssl->conf->endpoint,
4671 ssl);
4672 if (ret != 0) {
4673 return ret;
4674 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004675#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004677
4678#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4679 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 if ((size_t) (end - p) < 1) {
4681 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4682 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004683
4684 ssl->transform->in_cid_len = *p++;
4685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4687 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4688 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004689
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004691 p += ssl->transform->in_cid_len;
4692
4693 ssl->transform->out_cid_len = *p++;
4694
Gilles Peskine449bd832023-01-11 14:50:10 +01004695 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4696 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4697 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004698
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004700 p += ssl->transform->out_cid_len;
4701#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4702
4703 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004704 * Saved fields from top-level ssl_context structure
4705 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 if ((size_t) (end - p) < 4) {
4707 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4708 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004709
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004710 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004711 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004712
4713#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 if ((size_t) (end - p) < 16) {
4715 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4716 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004717
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004718 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004719 p += 8;
4720
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004721 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004722 p += 8;
4723#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4724
4725#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 if ((size_t) (end - p) < 1) {
4727 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4728 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004729
4730 ssl->disable_datagram_packing = *p++;
4731#endif /* MBEDTLS_SSL_PROTO_DTLS */
4732
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4734 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4735 }
4736 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4737 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004738
4739#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 if ((size_t) (end - p) < 2) {
4741 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4742 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004743
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004745 p += 2;
4746#endif /* MBEDTLS_SSL_PROTO_DTLS */
4747
4748#if defined(MBEDTLS_SSL_ALPN)
4749 {
4750 uint8_t alpn_len;
4751 const char **cur;
4752
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 if ((size_t) (end - p) < 1) {
4754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4755 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004756
4757 alpn_len = *p++;
4758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004760 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4762 if (strlen(*cur) == alpn_len &&
4763 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004764 ssl->alpn_chosen = *cur;
4765 break;
4766 }
4767 }
4768 }
4769
4770 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4772 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4773 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004774
4775 p += alpn_len;
4776 }
4777#endif /* MBEDTLS_SSL_ALPN */
4778
4779 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004780 * Forced fields from top-level ssl_context structure
4781 *
4782 * Most of them already set to the correct value by mbedtls_ssl_init() and
4783 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4784 */
4785 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004786 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004787
Hanno Becker361b10d2019-08-30 10:42:49 +01004788 /* Adjust pointers for header fields of outgoing records to
4789 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004791
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004792#if defined(MBEDTLS_SSL_PROTO_DTLS)
4793 ssl->in_epoch = 1;
4794#endif
4795
4796 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4797 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004798 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4799 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 if (ssl->handshake != NULL) {
4801 mbedtls_ssl_handshake_free(ssl);
4802 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004803 ssl->handshake = NULL;
4804 }
4805
4806 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004807 * Done - should have consumed entire buffer
4808 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004809 if (p != end) {
4810 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4811 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004812
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004814}
4815
4816/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004817 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004818 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004819int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4820 const unsigned char *buf,
4821 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004822{
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004824
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 if (ret != 0) {
4826 mbedtls_ssl_free(context);
4827 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004828
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004830}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004831#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004832
4833/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004834 * Free an SSL context
4835 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004836void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004837{
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004839 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004841
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004843
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004845#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4846 size_t out_buf_len = ssl->out_buf_len;
4847#else
4848 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4849#endif
4850
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004851 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004852 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004853 }
4854
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004856#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4857 size_t in_buf_len = ssl->in_buf_len;
4858#else
4859 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4860#endif
4861
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004862 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004863 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004864 }
4865
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 if (ssl->transform) {
4867 mbedtls_ssl_transform_free(ssl->transform);
4868 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004869 }
4870
Gilles Peskine449bd832023-01-11 14:50:10 +01004871 if (ssl->handshake) {
4872 mbedtls_ssl_handshake_free(ssl);
4873 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004874
4875#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4877 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004878#endif
4879
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 mbedtls_ssl_session_free(ssl->session_negotiate);
4881 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004882 }
4883
Ronald Cron6f135e12021-12-08 16:57:54 +01004884#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 mbedtls_ssl_transform_free(ssl->transform_application);
4886 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004887#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004888
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 if (ssl->session) {
4890 mbedtls_ssl_session_free(ssl->session);
4891 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004892 }
4893
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004894#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004896 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00004897 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004898#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004899
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004900#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004902#endif
4903
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004905
Paul Bakker86f04f42013-02-14 11:20:09 +01004906 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004908}
4909
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004910/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004911 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004912 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004913void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004914{
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004916}
4917
Gilles Peskineae270bf2021-06-02 00:05:29 +02004918/* The selection should be the same as mbedtls_x509_crt_profile_default in
4919 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004920 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004921 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004922 * about this list.
4923 */
Brett Warrene0edc842021-08-17 09:53:13 +01004924static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02004925#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01004926 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004927#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004928#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004929 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004930#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004931#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004932 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004933#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004934#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01004935 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004936#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004937#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004938 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004939#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004940#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004941 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004942#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004943#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004944 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004945#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004946#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004947 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004948#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02004949#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01004950 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
4951 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
4952 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
4953 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
4954 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
4955#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004956 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004957};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004958
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03004959static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004960 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4961 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4962 0
4963};
4964
Ronald Crone68ab4f2022-10-05 12:46:29 +02004965#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004966
Jerry Yu909df7b2022-01-22 11:56:27 +08004967/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004968 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004969 * rules SHOULD be upheld.
4970 * - No duplicate entries.
4971 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004972 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004973 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004974 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004975static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004976
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004977#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004978 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02004979 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08004980 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004981 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
4982#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004983
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004984#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004985 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02004986 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08004987 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004988 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
4989#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004990
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004991#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004992 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02004993 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08004994 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004995 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
4996#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004997
Gilles Peskine449bd832023-01-11 14:50:10 +01004998#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004999 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005000 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005001#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005002 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005003
Gilles Peskine449bd832023-01-11 14:50:10 +01005004#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005005 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005006 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005007#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005008 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005011 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005012 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005013#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005014 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005015
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005016#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005017 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005018#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005019
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005020#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005021 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005022#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005023
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005024#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005025 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005026#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005027
Gabor Mezei15b95a62022-05-09 16:37:58 +02005028 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005029};
5030
5031/* NOTICE: see above */
5032#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5033static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005034#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005035#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005037#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005038#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5039 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5040#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005041#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005043#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005044#endif /* MBEDTLS_MD_CAN_SHA512*/
5045#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005046#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005047 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005048#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005049#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5050 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5051#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005052#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005054#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005055#endif /* MBEDTLS_MD_CAN_SHA384*/
5056#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005057#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005059#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005060#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5061 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5062#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005063#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005065#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005066#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005067 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005068};
5069#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5070/* NOTICE: see above */
5071static uint16_t ssl_preset_suiteb_sig_algs[] = {
5072
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005073#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005074 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005075 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005076 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005077 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5078#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005079
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005080#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005081 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005082 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005083 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005084 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5085#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005086
Gilles Peskine449bd832023-01-11 14:50:10 +01005087#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005088 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005089 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005090#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005091 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005092
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005093#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005094 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005095#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005096
Gabor Mezei15b95a62022-05-09 16:37:58 +02005097 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005098};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005099
Jerry Yu909df7b2022-01-22 11:56:27 +08005100/* NOTICE: see above */
5101#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5102static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005103#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005104#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005106#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005107#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005109#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005110#endif /* MBEDTLS_MD_CAN_SHA256*/
5111#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005112#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005114#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005115#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005117#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005118#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005119 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005120};
Jerry Yu909df7b2022-01-22 11:56:27 +08005121#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5122
Ronald Crone68ab4f2022-10-05 12:46:29 +02005123#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005124
Brett Warrene0edc842021-08-17 09:53:13 +01005125static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005126#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005127 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005128#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005129#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005130 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005131#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005132 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005133};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005134
Ronald Crone68ab4f2022-10-05 12:46:29 +02005135#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005136/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005137 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005138MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005139static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005140{
5141 size_t i, j;
5142 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005143
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5145 for (j = 0; j < i; j++) {
5146 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005147 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 }
5149 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5150 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5151 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005152 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005153 }
5154 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005156}
5157
Ronald Crone68ab4f2022-10-05 12:46:29 +02005158#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005159
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005160/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005161 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005162 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005163int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5164 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005165{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005166#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005167 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005168#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005169
Ronald Crone68ab4f2022-10-05 12:46:29 +02005170#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5172 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5173 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005174 }
5175
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5177 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5178 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005179 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005180
5181#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5183 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5184 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005185 }
5186
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5188 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5189 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005190 }
5191#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005192#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005193
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005194 /* Use the functions here so that they are covered in tests,
5195 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 mbedtls_ssl_conf_endpoint(conf, endpoint);
5197 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005198
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005199 /*
5200 * Things that are common to all presets
5201 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005202#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005204 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5205#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5206 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5207#endif
5208 }
5209#endif
5210
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005211#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5212 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5213#endif
5214
5215#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5216 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5217#endif
5218
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005219#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005220 conf->f_cookie_write = ssl_cookie_write_dummy;
5221 conf->f_cookie_check = ssl_cookie_check_dummy;
5222#endif
5223
5224#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5225 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5226#endif
5227
Janos Follath088ce432017-04-10 12:42:31 +01005228#if defined(MBEDTLS_SSL_SRV_C)
5229 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005230 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005231#endif
5232
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005233#if defined(MBEDTLS_SSL_PROTO_DTLS)
5234 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5235 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5236#endif
5237
5238#if defined(MBEDTLS_SSL_RENEGOTIATION)
5239 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 memset(conf->renego_period, 0x00, 2);
5241 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005242#endif
5243
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005244#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005246 const unsigned char dhm_p[] =
5247 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5248 const unsigned char dhm_g[] =
5249 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005250
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5252 dhm_p, sizeof(dhm_p),
5253 dhm_g, sizeof(dhm_g))) != 0) {
5254 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005255 }
5256 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005257#endif
5258
Ronald Cron6f135e12021-12-08 16:57:54 +01005259#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005260
5261#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005262 mbedtls_ssl_tls13_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005263#if defined(MBEDTLS_SSL_SRV_C)
5264 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005266#endif
5267#endif /* MBEDTLS_SSL_EARLY_DATA */
5268
Jerry Yud0766ec2022-09-22 10:46:57 +08005269#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005270 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005272#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005273 /*
5274 * Allow all TLS 1.3 key exchange modes by default.
5275 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005276 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005277#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005278
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005280#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005281 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005282 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005283#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005284 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005285#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005287#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005288 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5289 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005290#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5291 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5292 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5293#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5294 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5295 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5296#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005298#endif
5299 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005300
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005301 /*
5302 * Preset-specific defaults
5303 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005305 /*
5306 * NSA Suite B
5307 */
5308 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005309
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005310 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005311
5312#if defined(MBEDTLS_X509_CRT_PARSE_C)
5313 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005314#endif
5315
Ronald Crone68ab4f2022-10-05 12:46:29 +02005316#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005317#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005319 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005320 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005321#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005323#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005324
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005325#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005326 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005327#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005328 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005329 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005330
5331 /*
5332 * Default
5333 */
5334 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005335
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005336 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005337
5338#if defined(MBEDTLS_X509_CRT_PARSE_C)
5339 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5340#endif
5341
Ronald Crone68ab4f2022-10-05 12:46:29 +02005342#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005343#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005345 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005347#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005349#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005350
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005351#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005352 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005353#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005354 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005355
5356#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5357 conf->dhm_min_bitlen = 1024;
5358#endif
5359 }
5360
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005362}
5363
5364/*
5365 * Free mbedtls_ssl_config
5366 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005367void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005368{
5369#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 mbedtls_mpi_free(&conf->dhm_P);
5371 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005372#endif
5373
Ronald Cron73fe8df2022-10-05 14:31:43 +02005374#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005375#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005377 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5378 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005379#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005381 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005382 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005383 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005384 }
5385
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005387 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005388 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005389 conf->psk_identity_len = 0;
5390 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005391#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005392
5393#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005395#endif
5396
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005398}
5399
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005400#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005401 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005402/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005403 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005404 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005405unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005406{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005407#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5409 return MBEDTLS_SSL_SIG_RSA;
5410 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005411#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005412#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5414 return MBEDTLS_SSL_SIG_ECDSA;
5415 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005416#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005418}
5419
Gilles Peskine449bd832023-01-11 14:50:10 +01005420unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005421{
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005423 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005425 case MBEDTLS_PK_ECDSA:
5426 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005428 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005430 }
5431}
5432
Gilles Peskine449bd832023-01-11 14:50:10 +01005433mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005434{
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005436#if defined(MBEDTLS_RSA_C)
5437 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005439#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005440#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005441 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005443#endif
5444 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005446 }
5447}
Valerio Settie9646ec2023-08-02 20:02:28 +02005448#endif /* MBEDTLS_PK_C &&
5449 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005450
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005451/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005452 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005453 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005454mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005455{
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005457#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005458 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005460#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005461#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005462 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005464#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005465#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005466 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005468#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005469#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005470 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005472#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005473#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005474 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005476#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005477#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005478 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005480#endif
5481 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005483 }
5484}
5485
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005486/*
5487 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5488 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005489unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005490{
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005492#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005493 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005495#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005496#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005497 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005499#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005500#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005501 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005503#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005504#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005505 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005507#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005508#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005509 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005510 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005511#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005512#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005513 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005515#endif
5516 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005518 }
5519}
5520
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005521/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005522 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005523 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005524 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005525int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005526{
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005528
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 if (group_list == NULL) {
5530 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005531 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005532
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 for (; *group_list != 0; group_list++) {
5534 if (*group_list == tls_id) {
5535 return 0;
5536 }
5537 }
5538
5539 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005540}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005541
Valerio Setti49e69072023-06-27 17:27:51 +02005542#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005543/*
5544 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5545 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005546int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005547{
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005549
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005551 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005552 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005553
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005555}
Valerio Setti49e69072023-06-27 17:27:51 +02005556#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005557
Valerio Setti18c9fed2022-12-30 17:44:24 +01005558static const struct {
5559 uint16_t tls_id;
5560 mbedtls_ecp_group_id ecp_group_id;
5561 psa_ecc_family_t psa_family;
5562 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005563} tls_id_match_table[] =
5564{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005565#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005566 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005567#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005568#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005569 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005570#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005571#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005572 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005573#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005574#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005575 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005576#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005577#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005578 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005579#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005580#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005581 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005582#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005583#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005584 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005585#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005586#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005587 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005588#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005589#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005590 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005591#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005592#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005593 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005594#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005595#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005596 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005597#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005598#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005599 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005600#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005601#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005602 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005603#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005604 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005605};
5606
Gilles Peskine449bd832023-01-11 14:50:10 +01005607int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005608 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005610{
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5612 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005613 if (type != NULL) {
5614 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 }
5616 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005617 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005619 return PSA_SUCCESS;
5620 }
5621 }
5622
5623 return PSA_ERROR_NOT_SUPPORTED;
5624}
5625
Gilles Peskine449bd832023-01-11 14:50:10 +01005626mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005627{
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5629 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005630 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005632 }
5633
5634 return MBEDTLS_ECP_DP_NONE;
5635}
5636
Gilles Peskine449bd832023-01-11 14:50:10 +01005637uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005638{
Gilles Peskine449bd832023-01-11 14:50:10 +01005639 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5640 i++) {
5641 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005642 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005644 }
5645
5646 return 0;
5647}
5648
Valerio Setti67419f02023-01-04 16:12:42 +01005649#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005650static const struct {
5651 uint16_t tls_id;
5652 const char *name;
5653} tls_id_curve_name_table[] =
5654{
Valerio Setti54e23792023-07-07 10:49:27 +02005655 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5656 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5657 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5658 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5659 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5660 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5661 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5662 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5663 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5664 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5665 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5666 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5667 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005668 { 0, NULL },
5669};
5670
Gilles Peskine449bd832023-01-11 14:50:10 +01005671const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005672{
Valerio Settiacd32c02023-06-29 18:06:29 +02005673 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5674 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5675 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005677 }
5678
5679 return NULL;
5680}
Valerio Setti67419f02023-01-04 16:12:42 +01005681#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005682
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005683#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005684int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5685 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5686 int cert_endpoint,
5687 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005688{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005689 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005690 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005691 const char *ext_oid;
5692 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005693
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005695 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005697 case MBEDTLS_KEY_EXCHANGE_RSA:
5698 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005699 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005700 break;
5701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005702 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5703 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5704 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5705 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005706 break;
5707
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005708 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5709 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005710 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005711 break;
5712
5713 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005714 case MBEDTLS_KEY_EXCHANGE_NONE:
5715 case MBEDTLS_KEY_EXCHANGE_PSK:
5716 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5717 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005718 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005719 usage = 0;
5720 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005722 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5723 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005724 }
5725
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005727 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005728 ret = -1;
5729 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005730
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005732 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5734 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005735 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005737 }
5738
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005740 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005741 ret = -1;
5742 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005743
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005745}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005746#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005747
Jerry Yu148165c2021-09-24 23:20:59 +08005748#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005749int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5750 const mbedtls_md_type_t md,
5751 unsigned char *dst,
5752 size_t dst_len,
5753 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005754{
Ronald Cronf6893e12022-01-07 22:09:01 +01005755 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5756 psa_hash_operation_t *hash_operation_to_clone;
5757 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5758
Jerry Yu148165c2021-09-24 23:20:59 +08005759 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005760
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005762#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005763 case MBEDTLS_MD_SHA384:
5764 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5765 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005766#endif
5767
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005768#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 case MBEDTLS_MD_SHA256:
5770 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5771 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005772#endif
5773
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 default:
5775 goto exit;
5776 }
5777
5778 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5779 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005780 goto exit;
5781 }
5782
Gilles Peskine449bd832023-01-11 14:50:10 +01005783 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5784 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005785 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005787
5788exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005789#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5790 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005791 (void) ssl;
5792#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005793 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005794}
5795#else /* MBEDTLS_USE_PSA_CRYPTO */
5796
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005797#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005798MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005799static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5800 unsigned char *dst,
5801 size_t dst_len,
5802 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005803{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005804 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005805 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005806
Gilles Peskine449bd832023-01-11 14:50:10 +01005807 if (dst_len < 48) {
5808 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5809 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005810
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005811 mbedtls_md_init(&sha384);
5812 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005813 if (ret != 0) {
5814 goto exit;
5815 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005816 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005817 if (ret != 0) {
5818 goto exit;
5819 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005820
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005821 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005822 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005823 goto exit;
5824 }
5825
5826 *olen = 48;
5827
5828exit:
5829
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005830 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005832}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005833#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005834
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005835#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005836MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005837static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5838 unsigned char *dst,
5839 size_t dst_len,
5840 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005841{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005842 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005843 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005844
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 if (dst_len < 32) {
5846 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5847 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005848
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005849 mbedtls_md_init(&sha256);
5850 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5851 if (ret != 0) {
5852 goto exit;
5853 }
5854 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5855 if (ret != 0) {
5856 goto exit;
5857 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005858
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005859 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5860 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005861 goto exit;
5862 }
5863
5864 *olen = 32;
5865
5866exit:
5867
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005868 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005870}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005871#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005872
Gilles Peskine449bd832023-01-11 14:50:10 +01005873int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5874 const mbedtls_md_type_t md,
5875 unsigned char *dst,
5876 size_t dst_len,
5877 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005878{
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005880
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005881#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 case MBEDTLS_MD_SHA384:
5883 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005884#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005885
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005886#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 case MBEDTLS_MD_SHA256:
5888 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005889#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005890
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005892#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5893 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 (void) ssl;
5895 (void) dst;
5896 (void) dst_len;
5897 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005898#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005899 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005900 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005901 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005902}
XiaokangQian647719a2021-12-07 09:16:29 +00005903
Jerry Yu148165c2021-09-24 23:20:59 +08005904#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005905
Ronald Crone68ab4f2022-10-05 12:46:29 +02005906#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005907/* mbedtls_ssl_parse_sig_alg_ext()
5908 *
5909 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5910 * value (TLS 1.3 RFC8446):
5911 * enum {
5912 * ....
5913 * ecdsa_secp256r1_sha256( 0x0403 ),
5914 * ecdsa_secp384r1_sha384( 0x0503 ),
5915 * ecdsa_secp521r1_sha512( 0x0603 ),
5916 * ....
5917 * } SignatureScheme;
5918 *
5919 * struct {
5920 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5921 * } SignatureSchemeList;
5922 *
5923 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5924 * value (TLS 1.2 RFC5246):
5925 * enum {
5926 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5927 * sha512(6), (255)
5928 * } HashAlgorithm;
5929 *
5930 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5931 * SignatureAlgorithm;
5932 *
5933 * struct {
5934 * HashAlgorithm hash;
5935 * SignatureAlgorithm signature;
5936 * } SignatureAndHashAlgorithm;
5937 *
5938 * SignatureAndHashAlgorithm
5939 * supported_signature_algorithms<2..2^16-2>;
5940 *
5941 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5942 * generalization of the TLS 1.2 signature algorithm extension.
5943 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5944 * `SignatureScheme` field of TLS 1.3
5945 *
5946 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005947int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5948 const unsigned char *buf,
5949 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005950{
5951 const unsigned char *p = buf;
5952 size_t supported_sig_algs_len = 0;
5953 const unsigned char *supported_sig_algs_end;
5954 uint16_t sig_alg;
5955 uint32_t common_idx = 0;
5956
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5958 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005959 p += 2;
5960
Gilles Peskine449bd832023-01-11 14:50:10 +01005961 memset(ssl->handshake->received_sig_algs, 0,
5962 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005963
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005965 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 while (p < supported_sig_algs_end) {
5967 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5968 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005969 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5971 sig_alg,
5972 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005973#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005974 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5975 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5976 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005977 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005978 }
5979#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005980
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5982 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005983
Gilles Peskine449bd832023-01-11 14:50:10 +01005984 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005985 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5986 common_idx += 1;
5987 }
5988 }
5989 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 if (p != end) {
5991 MBEDTLS_SSL_DEBUG_MSG(1,
5992 ("Signature algorithms extension length misaligned"));
5993 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5994 MBEDTLS_ERR_SSL_DECODE_ERROR);
5995 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02005996 }
5997
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 if (common_idx == 0) {
5999 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6000 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6001 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6002 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006003 }
6004
Gabor Mezei15b95a62022-05-09 16:37:58 +02006005 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006007}
6008
Ronald Crone68ab4f2022-10-05 12:46:29 +02006009#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006010
Jerry Yudc7bd172022-02-17 13:44:15 +08006011#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6012
6013#if defined(MBEDTLS_USE_PSA_CRYPTO)
6014
Gilles Peskine449bd832023-01-11 14:50:10 +01006015static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6016 mbedtls_svc_key_id_t key,
6017 psa_algorithm_t alg,
6018 const unsigned char *raw_psk, size_t raw_psk_length,
6019 const unsigned char *seed, size_t seed_length,
6020 const unsigned char *label, size_t label_length,
6021 const unsigned char *other_secret,
6022 size_t other_secret_length,
6023 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006024{
6025 psa_status_t status;
6026
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 status = psa_key_derivation_setup(derivation, alg);
6028 if (status != PSA_SUCCESS) {
6029 return status;
6030 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006031
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6033 status = psa_key_derivation_input_bytes(derivation,
6034 PSA_KEY_DERIVATION_INPUT_SEED,
6035 seed, seed_length);
6036 if (status != PSA_SUCCESS) {
6037 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006038 }
6039
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 if (other_secret != NULL) {
6041 status = psa_key_derivation_input_bytes(derivation,
6042 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6043 other_secret, other_secret_length);
6044 if (status != PSA_SUCCESS) {
6045 return status;
6046 }
6047 }
6048
6049 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006050 status = psa_key_derivation_input_bytes(
6051 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 raw_psk, raw_psk_length);
6053 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006054 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006055 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006056 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 if (status != PSA_SUCCESS) {
6058 return status;
6059 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006060
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 status = psa_key_derivation_input_bytes(derivation,
6062 PSA_KEY_DERIVATION_INPUT_LABEL,
6063 label, label_length);
6064 if (status != PSA_SUCCESS) {
6065 return status;
6066 }
6067 } else {
6068 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006069 }
6070
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 status = psa_key_derivation_set_capacity(derivation, capacity);
6072 if (status != PSA_SUCCESS) {
6073 return status;
6074 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006077}
6078
Andrzej Kurek57d10632022-10-24 10:32:01 -04006079#if defined(PSA_WANT_ALG_SHA_384) || \
6080 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006081MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006082static int tls_prf_generic(mbedtls_md_type_t md_type,
6083 const unsigned char *secret, size_t slen,
6084 const char *label,
6085 const unsigned char *random, size_t rlen,
6086 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006087{
6088 psa_status_t status;
6089 psa_algorithm_t alg;
6090 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6091 psa_key_derivation_operation_t derivation =
6092 PSA_KEY_DERIVATION_OPERATION_INIT;
6093
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006095 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006097 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006099
6100 /* Normally a "secret" should be long enough to be impossible to
6101 * find by brute force, and in particular should not be empty. But
6102 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6103 * and for this use case it makes sense to have a 0-length "secret".
6104 * Since the key API doesn't allow importing a key of length 0,
6105 * keep master_key=0, which setup_psa_key_derivation() understands
6106 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006108 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6110 psa_set_key_algorithm(&key_attributes, alg);
6111 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006112
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6114 if (status != PSA_SUCCESS) {
6115 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6116 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006117 }
6118
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 status = setup_psa_key_derivation(&derivation,
6120 master_key, alg,
6121 NULL, 0,
6122 random, rlen,
6123 (unsigned char const *) label,
6124 (size_t) strlen(label),
6125 NULL, 0,
6126 dlen);
6127 if (status != PSA_SUCCESS) {
6128 psa_key_derivation_abort(&derivation);
6129 psa_destroy_key(master_key);
6130 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006131 }
6132
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6134 if (status != PSA_SUCCESS) {
6135 psa_key_derivation_abort(&derivation);
6136 psa_destroy_key(master_key);
6137 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006138 }
6139
Gilles Peskine449bd832023-01-11 14:50:10 +01006140 status = psa_key_derivation_abort(&derivation);
6141 if (status != PSA_SUCCESS) {
6142 psa_destroy_key(master_key);
6143 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006144 }
6145
Gilles Peskine449bd832023-01-11 14:50:10 +01006146 if (!mbedtls_svc_key_id_is_null(master_key)) {
6147 status = psa_destroy_key(master_key);
6148 }
6149 if (status != PSA_SUCCESS) {
6150 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6151 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006152
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006154}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006155#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006156#else /* MBEDTLS_USE_PSA_CRYPTO */
6157
Andrzej Kurek57d10632022-10-24 10:32:01 -04006158#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006159 (defined(MBEDTLS_MD_CAN_SHA256) || \
6160 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006161MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006162static int tls_prf_generic(mbedtls_md_type_t md_type,
6163 const unsigned char *secret, size_t slen,
6164 const char *label,
6165 const unsigned char *random, size_t rlen,
6166 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006167{
6168 size_t nb;
6169 size_t i, j, k, md_len;
6170 unsigned char *tmp;
6171 size_t tmp_len = 0;
6172 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6173 const mbedtls_md_info_t *md_info;
6174 mbedtls_md_context_t md_ctx;
6175 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6176
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006178
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6180 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6181 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006182
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006184
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 tmp_len = md_len + strlen(label) + rlen;
6186 tmp = mbedtls_calloc(1, tmp_len);
6187 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006188 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6189 goto exit;
6190 }
6191
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 nb = strlen(label);
6193 memcpy(tmp + md_len, label, nb);
6194 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006195 nb += rlen;
6196
6197 /*
6198 * Compute P_<hash>(secret, label + random)[0..dlen]
6199 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006200 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006201 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006203
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6205 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006206 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 }
6208 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6209 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006210 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 }
6212 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6213 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006214 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006216
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 for (i = 0; i < dlen; i += md_len) {
6218 ret = mbedtls_md_hmac_reset(&md_ctx);
6219 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006220 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006221 }
6222 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
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_finish(&md_ctx, h_i);
6227 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006228 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006230
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 ret = mbedtls_md_hmac_reset(&md_ctx);
6232 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006233 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 }
6235 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6236 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006237 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 }
6239 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6240 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006241 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006243
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006245
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006247 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006249 }
6250
6251exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006252 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006253
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 if (tmp != NULL) {
6255 mbedtls_platform_zeroize(tmp, tmp_len);
6256 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006257
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006259
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006261
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006263}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006264#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006265#endif /* MBEDTLS_USE_PSA_CRYPTO */
6266
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006267#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006268MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006269static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6270 const char *label,
6271 const unsigned char *random, size_t rlen,
6272 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006273{
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6275 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006276}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006277#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006278
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006279#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006280MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006281static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6282 const char *label,
6283 const unsigned char *random, size_t rlen,
6284 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006285{
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6287 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006288}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006289#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006290
Jerry Yuf009d862022-02-17 14:01:37 +08006291/*
6292 * Set appropriate PRF function and other SSL / TLS1.2 functions
6293 *
6294 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006295 * - hash associated with the ciphersuite (only used by TLS 1.2)
6296 *
6297 * Outputs:
6298 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6299 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006300MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006301static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6302 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006303{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006304#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006305 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006306 handshake->tls_prf = tls_prf_sha384;
6307 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6308 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006310#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006311#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006312 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006313 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006314 handshake->tls_prf = tls_prf_sha256;
6315 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6316 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6317 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006318#else
Jerry Yuf009d862022-02-17 14:01:37 +08006319 {
Jerry Yuf009d862022-02-17 14:01:37 +08006320 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006321 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006322 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006323 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006324#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006325
Gilles Peskine449bd832023-01-11 14:50:10 +01006326 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006327}
Jerry Yud6ab2352022-02-17 14:03:43 +08006328
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006329/*
6330 * Compute master secret if needed
6331 *
6332 * Parameters:
6333 * [in/out] handshake
6334 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6335 * (PSA-PSK) ciphersuite_info, psk_opaque
6336 * [out] premaster (cleared)
6337 * [out] master
6338 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6339 * debug: conf->f_dbg, conf->p_dbg
6340 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006341 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006342 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006343MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006344static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6345 unsigned char *master,
6346 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006347{
6348 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6349
6350 /* cf. RFC 5246, Section 8.1:
6351 * "The master secret is always exactly 48 bytes in length." */
6352 size_t const master_secret_len = 48;
6353
6354#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6355 unsigned char session_hash[48];
6356#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6357
6358 /* The label for the KDF used for key expansion.
6359 * This is either "master secret" or "extended master secret"
6360 * depending on whether the Extended Master Secret extension
6361 * is used. */
6362 char const *lbl = "master secret";
6363
Przemek Stekielae4ed302022-04-05 17:15:55 +02006364 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006365 * - If the Extended Master Secret extension is not used,
6366 * this is ClientHello.Random + ServerHello.Random
6367 * (see Sect. 8.1 in RFC 5246).
6368 * - If the Extended Master Secret extension is used,
6369 * this is the transcript of the handshake so far.
6370 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006371 unsigned char const *seed = handshake->randbytes;
6372 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006373
6374#if !defined(MBEDTLS_DEBUG_C) && \
6375 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6376 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006377 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006378 ssl = NULL; /* make sure we don't use it except for those cases */
6379 (void) ssl;
6380#endif
6381
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 if (handshake->resume != 0) {
6383 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6384 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006385 }
6386
6387#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006389 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006390 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006391 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6392 if (ret != 0) {
6393 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6394 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006395
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6397 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006398 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006399#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006400
Przemek Stekiel99114f32022-04-22 11:20:09 +02006401#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006402 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006403 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006404 /* Perform PSK-to-MS expansion in a single step. */
6405 psa_status_t status;
6406 psa_algorithm_t alg;
6407 mbedtls_svc_key_id_t psk;
6408 psa_key_derivation_operation_t derivation =
6409 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006410 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006411
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006413
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006415
Gilles Peskine449bd832023-01-11 14:50:10 +01006416 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006417 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006418 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006419 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006421
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006422 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006424
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006426 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006427 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006428 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006429 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006430 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006431 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006432 other_secret_len = 48;
6433 other_secret = handshake->premaster + 2;
6434 break;
6435 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006436 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006437 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6438 other_secret = handshake->premaster + 2;
6439 break;
6440 default:
6441 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006442 }
6443
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 status = setup_psa_key_derivation(&derivation, psk, alg,
6445 ssl->conf->psk, ssl->conf->psk_len,
6446 seed, seed_len,
6447 (unsigned char const *) lbl,
6448 (size_t) strlen(lbl),
6449 other_secret, other_secret_len,
6450 master_secret_len);
6451 if (status != PSA_SUCCESS) {
6452 psa_key_derivation_abort(&derivation);
6453 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006454 }
6455
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 status = psa_key_derivation_output_bytes(&derivation,
6457 master,
6458 master_secret_len);
6459 if (status != PSA_SUCCESS) {
6460 psa_key_derivation_abort(&derivation);
6461 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006462 }
6463
Gilles Peskine449bd832023-01-11 14:50:10 +01006464 status = psa_key_derivation_abort(&derivation);
6465 if (status != PSA_SUCCESS) {
6466 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6467 }
6468 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006469#endif
6470 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006471#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6473 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006474 psa_status_t status;
6475 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6476 psa_key_derivation_operation_t derivation =
6477 PSA_KEY_DERIVATION_OPERATION_INIT;
6478
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006480
6481 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6482
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 status = psa_key_derivation_setup(&derivation, alg);
6484 if (status != PSA_SUCCESS) {
6485 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006486 }
6487
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 status = psa_key_derivation_set_capacity(&derivation,
6489 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6490 if (status != PSA_SUCCESS) {
6491 psa_key_derivation_abort(&derivation);
6492 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006493 }
6494
Gilles Peskine449bd832023-01-11 14:50:10 +01006495 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6496 &derivation);
6497 if (status != PSA_SUCCESS) {
6498 psa_key_derivation_abort(&derivation);
6499 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006500 }
6501
Gilles Peskine449bd832023-01-11 14:50:10 +01006502 status = psa_key_derivation_output_bytes(&derivation,
6503 handshake->premaster,
6504 handshake->pmslen);
6505 if (status != PSA_SUCCESS) {
6506 psa_key_derivation_abort(&derivation);
6507 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6508 }
6509
6510 status = psa_key_derivation_abort(&derivation);
6511 if (status != PSA_SUCCESS) {
6512 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006513 }
6514 }
6515#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006516 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6517 lbl, seed, seed_len,
6518 master,
6519 master_secret_len);
6520 if (ret != 0) {
6521 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6522 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006523 }
6524
Gilles Peskine449bd832023-01-11 14:50:10 +01006525 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6526 handshake->premaster,
6527 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006528
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 mbedtls_platform_zeroize(handshake->premaster,
6530 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006531 }
6532
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006534}
6535
Gilles Peskine449bd832023-01-11 14:50:10 +01006536int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006537{
6538 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6539 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6540 ssl->handshake->ciphersuite_info;
6541
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006543
6544 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006546 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 if (ret != 0) {
6548 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6549 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006550 }
6551
6552 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 ret = ssl_compute_master(ssl->handshake,
6554 ssl->session_negotiate->master,
6555 ssl);
6556 if (ret != 0) {
6557 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6558 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006559 }
6560
6561 /* Swap the client and server random values:
6562 * - MS derivation wanted client+server (RFC 5246 8.1)
6563 * - key derivation wants server+client (RFC 5246 6.3) */
6564 {
6565 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 memcpy(tmp, ssl->handshake->randbytes, 64);
6567 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6568 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6569 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006570 }
6571
6572 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006573 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6574 ssl->session_negotiate->ciphersuite,
6575 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006576#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006577 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006578#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 ssl->handshake->tls_prf,
6580 ssl->handshake->randbytes,
6581 ssl->tls_version,
6582 ssl->conf->endpoint,
6583 ssl);
6584 if (ret != 0) {
6585 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6586 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006587 }
6588
6589 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6591 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006592
Gilles Peskine449bd832023-01-11 14:50:10 +01006593 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006594
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006596}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006597
Gilles Peskine449bd832023-01-11 14:50:10 +01006598int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006599{
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006601#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006602 case MBEDTLS_SSL_HASH_SHA384:
6603 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6604 break;
6605#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006606#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006607 case MBEDTLS_SSL_HASH_SHA256:
6608 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6609 break;
6610#endif
6611 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006613 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006614#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6615 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006616 (void) ssl;
6617#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006618 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006619}
6620
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006621#if defined(MBEDTLS_USE_PSA_CRYPTO)
6622static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6623 const psa_hash_operation_t *hs_op,
6624 size_t buffer_size,
6625 unsigned char *hash,
6626 size_t *hlen)
6627{
6628 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006629 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006630
6631#if !defined(MBEDTLS_DEBUG_C)
6632 (void) ssl;
6633#endif
6634 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006635 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006636 if (status != PSA_SUCCESS) {
6637 goto exit;
6638 }
6639
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006640 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006641 if (status != PSA_SUCCESS) {
6642 goto exit;
6643 }
6644
6645 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6646 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6647
6648exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006649 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006650 return mbedtls_md_error_from_psa(status);
6651}
6652#else
6653static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6654 const mbedtls_md_context_t *hs_ctx,
6655 unsigned char *hash,
6656 size_t *hlen)
6657{
6658 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006659 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006660
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006661 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006662
6663#if !defined(MBEDTLS_DEBUG_C)
6664 (void) ssl;
6665#endif
6666 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6667
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006668 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006669 if (ret != 0) {
6670 goto exit;
6671 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006672 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006673 if (ret != 0) {
6674 goto exit;
6675 }
6676
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006677 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006678 if (ret != 0) {
6679 goto exit;
6680 }
6681
6682 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6683
6684 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6685 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6686
6687exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006688 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006689 return ret;
6690}
6691#endif /* MBEDTLS_USE_PSA_CRYPTO */
6692
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006693#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006694int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6695 unsigned char *hash,
6696 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006697{
6698#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006699 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6700 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006701#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006702 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6703 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006704#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006705}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006706#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006707
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006708#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006709int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6710 unsigned char *hash,
6711 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006712{
6713#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006714 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6715 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006716#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006717 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6718 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006719#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006720}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006721#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006722
Neil Armstrong80f6f322022-05-03 17:56:38 +02006723#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6724 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006725int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006726{
6727 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006729 const unsigned char *psk = NULL;
6730 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006731 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006732
Gilles Peskine449bd832023-01-11 14:50:10 +01006733 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006734 /*
6735 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006736 * checked before calling this function.
6737 *
6738 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006739 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006740 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006741 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6742 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6743 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006744 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006745 }
6746
6747 /*
6748 * PMS = struct {
6749 * opaque other_secret<0..2^16-1>;
6750 * opaque psk<0..2^16-1>;
6751 * };
6752 * with "other_secret" depending on the particular key exchange
6753 */
6754#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006755 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6756 if (end - p < 2) {
6757 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6758 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006759
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006761 p += 2;
6762
Gilles Peskine449bd832023-01-11 14:50:10 +01006763 if (end < p || (size_t) (end - p) < psk_len) {
6764 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6765 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006766
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006768 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006770#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6771#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006773 /*
6774 * other_secret already set by the ClientKeyExchange message,
6775 * and is 48 bytes long
6776 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006777 if (end - p < 2) {
6778 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6779 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006780
6781 *p++ = 0;
6782 *p++ = 48;
6783 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006785#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6786#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006788 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6789 size_t len;
6790
6791 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6793 p + 2, end - (p + 2), &len,
6794 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6795 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6796 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006797 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006798 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006799 p += 2 + len;
6800
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6802 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006803#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006804#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006805 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006806 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6807 size_t zlen;
6808
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6810 p + 2, end - (p + 2),
6811 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6812 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6813 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006814 }
6815
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006817 p += 2 + zlen;
6818
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6820 MBEDTLS_DEBUG_ECDH_Z);
6821 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006822#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006823 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6825 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006826 }
6827
6828 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 if (end - p < 2) {
6830 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6831 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006832
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006834 p += 2;
6835
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 if (end < p || (size_t) (end - p) < psk_len) {
6837 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6838 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006839
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006841 p += psk_len;
6842
6843 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6844
Gilles Peskine449bd832023-01-11 14:50:10 +01006845 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006846}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006847#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006848
6849#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006850MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006851static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006852
6853#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006854int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006855{
6856 /* If renegotiation is not enforced, retransmit until we would reach max
6857 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006859 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6860 unsigned char doublings = 1;
6861
Gilles Peskine449bd832023-01-11 14:50:10 +01006862 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006863 ++doublings;
6864 ratio >>= 1;
6865 }
6866
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 if (++ssl->renego_records_seen > doublings) {
6868 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6869 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006870 }
6871 }
6872
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006874}
6875#endif
6876#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006877
Jerry Yud9526692022-02-17 14:23:47 +08006878/*
6879 * Handshake functions
6880 */
6881#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6882/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006883int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006884{
6885 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6886 ssl->handshake->ciphersuite_info;
6887
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006889
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6891 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006892 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006894 }
6895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6897 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006898}
6899
Gilles Peskine449bd832023-01-11 14:50:10 +01006900int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006901{
6902 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6903 ssl->handshake->ciphersuite_info;
6904
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006906
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6908 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006909 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006911 }
6912
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6914 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006915}
6916
6917#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6918/* Some certificate support -> implement write and parse */
6919
Gilles Peskine449bd832023-01-11 14:50:10 +01006920int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006921{
6922 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6923 size_t i, n;
6924 const mbedtls_x509_crt *crt;
6925 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6926 ssl->handshake->ciphersuite_info;
6927
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006929
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6931 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006932 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006934 }
6935
6936#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006937 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6938 if (ssl->handshake->client_auth == 0) {
6939 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006940 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006941 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006942 }
6943 }
6944#endif /* MBEDTLS_SSL_CLI_C */
6945#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6947 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006948 /* Should never happen because we shouldn't have picked the
6949 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006951 }
6952 }
6953#endif
6954
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006956
6957 /*
6958 * 0 . 0 handshake type
6959 * 1 . 3 handshake length
6960 * 4 . 6 length of all certs
6961 * 7 . 9 length of cert. 1
6962 * 10 . n-1 peer certificate
6963 * n . n+2 length of cert. 2
6964 * n+3 . ... upper level cert, etc.
6965 */
6966 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006967 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006968
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006970 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6972 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6973 " > %" MBEDTLS_PRINTF_SIZET,
6974 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6975 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006976 }
6977
Gilles Peskine449bd832023-01-11 14:50:10 +01006978 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6979 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6980 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006981
Gilles Peskine449bd832023-01-11 14:50:10 +01006982 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006983 i += n; crt = crt->next;
6984 }
6985
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6987 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6988 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006989
6990 ssl->out_msglen = i;
6991 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6992 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6993
6994 ssl->state++;
6995
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6997 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6998 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006999 }
7000
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007002
Gilles Peskine449bd832023-01-11 14:50:10 +01007003 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007004}
7005
7006#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7007
7008#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007009MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007010static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7011 unsigned char *crt_buf,
7012 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007013{
7014 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7015
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 if (peer_crt == NULL) {
7017 return -1;
7018 }
Jerry Yud9526692022-02-17 14:23:47 +08007019
Gilles Peskine449bd832023-01-11 14:50:10 +01007020 if (peer_crt->raw.len != crt_buf_len) {
7021 return -1;
7022 }
Jerry Yud9526692022-02-17 14:23:47 +08007023
Gilles Peskine449bd832023-01-11 14:50:10 +01007024 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007025}
7026#else /* 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 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7033 unsigned char const * const peer_cert_digest =
7034 ssl->session->peer_cert_digest;
7035 mbedtls_md_type_t const peer_cert_digest_type =
7036 ssl->session->peer_cert_digest_type;
7037 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007039 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7040 size_t digest_len;
7041
Gilles Peskine449bd832023-01-11 14:50:10 +01007042 if (peer_cert_digest == NULL || digest_info == NULL) {
7043 return -1;
7044 }
Jerry Yud9526692022-02-17 14:23:47 +08007045
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 digest_len = mbedtls_md_get_size(digest_info);
7047 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7048 return -1;
7049 }
Jerry Yud9526692022-02-17 14:23:47 +08007050
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7052 if (ret != 0) {
7053 return -1;
7054 }
Jerry Yud9526692022-02-17 14:23:47 +08007055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007057}
7058#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7059#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7060
7061/*
7062 * Once the certificate message is read, parse it into a cert chain and
7063 * perform basic checks, but leave actual verification to the caller
7064 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007065MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007066static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7067 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007068{
7069 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7070#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007072#endif
7073 size_t i, n;
7074 uint8_t alert;
7075
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7077 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7078 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7079 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7080 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007081 }
7082
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7084 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7085 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7086 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007087 }
7088
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7090 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7091 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7092 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7093 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007094 }
7095
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007097
7098 /*
7099 * Same message structure as in mbedtls_ssl_write_certificate()
7100 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007102
Gilles Peskine449bd832023-01-11 14:50:10 +01007103 if (ssl->in_msg[i] != 0 ||
7104 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7105 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7106 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7107 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7108 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007109 }
7110
7111 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7112 i += 3;
7113
7114 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007116 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 if (i + 3 > ssl->in_hslen) {
7118 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7119 mbedtls_ssl_send_alert_message(ssl,
7120 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7121 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7122 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007123 }
7124 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7125 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007126 if (ssl->in_msg[i] != 0) {
7127 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7128 mbedtls_ssl_send_alert_message(ssl,
7129 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7130 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7131 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007132 }
7133
7134 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007136 | (unsigned int) ssl->in_msg[i + 2];
7137 i += 3;
7138
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 if (n < 128 || i + n > ssl->in_hslen) {
7140 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7141 mbedtls_ssl_send_alert_message(ssl,
7142 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7143 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7144 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007145 }
7146
7147 /* Check if we're handling the first CRT in the chain. */
7148#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007150 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007152 /* During client-side renegotiation, check that the server's
7153 * end-CRTs hasn't changed compared to the initial handshake,
7154 * mitigating the triple handshake attack. On success, reuse
7155 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7157 if (ssl_check_peer_crt_unchanged(ssl,
7158 &ssl->in_msg[i],
7159 n) != 0) {
7160 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7161 mbedtls_ssl_send_alert_message(ssl,
7162 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7163 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7164 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007165 }
7166
7167 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007169 }
7170#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7171
7172 /* Parse the next certificate in the chain. */
7173#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007175#else
7176 /* If we don't need to store the CRT chain permanently, parse
7177 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007178 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007179#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007181 case 0: /*ok*/
7182 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7183 /* Ignore certificate with an unknown algorithm: maybe a
7184 prior certificate was already trusted. */
7185 break;
7186
7187 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7188 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7189 goto crt_parse_der_failed;
7190
7191 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7192 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7193 goto crt_parse_der_failed;
7194
7195 default:
7196 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007197crt_parse_der_failed:
7198 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7199 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7200 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007201 }
7202
7203 i += n;
7204 }
7205
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7207 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007208}
7209
7210#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007211MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007212static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007213{
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7215 return -1;
7216 }
Jerry Yud9526692022-02-17 14:23:47 +08007217
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007219 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7220 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007221 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7222 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7223 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007224 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007225 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007226}
7227#endif /* MBEDTLS_SSL_SRV_C */
7228
7229/* Check if a certificate message is expected.
7230 * Return either
7231 * - SSL_CERTIFICATE_EXPECTED, or
7232 * - SSL_CERTIFICATE_SKIP
7233 * indicating whether a Certificate message is expected or not.
7234 */
7235#define SSL_CERTIFICATE_EXPECTED 0
7236#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007237MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007238static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7239 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007240{
7241 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7242 ssl->handshake->ciphersuite_info;
7243
Gilles Peskine449bd832023-01-11 14:50:10 +01007244 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7245 return SSL_CERTIFICATE_SKIP;
7246 }
Jerry Yud9526692022-02-17 14:23:47 +08007247
7248#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7250 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7251 return SSL_CERTIFICATE_SKIP;
7252 }
Jerry Yud9526692022-02-17 14:23:47 +08007253
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007255 ssl->session_negotiate->verify_result =
7256 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007258 }
7259 }
7260#else
7261 ((void) authmode);
7262#endif /* MBEDTLS_SSL_SRV_C */
7263
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007265}
7266
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007267MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007268static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7269 int authmode,
7270 mbedtls_x509_crt *chain,
7271 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007272{
7273 int ret = 0;
7274 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7275 ssl->handshake->ciphersuite_info;
7276 int have_ca_chain = 0;
7277
7278 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7279 void *p_vrfy;
7280
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7282 return 0;
7283 }
Jerry Yud9526692022-02-17 14:23:47 +08007284
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 if (ssl->f_vrfy != NULL) {
7286 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007287 f_vrfy = ssl->f_vrfy;
7288 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007289 } else {
7290 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007291 f_vrfy = ssl->conf->f_vrfy;
7292 p_vrfy = ssl->conf->p_vrfy;
7293 }
7294
7295 /*
7296 * Main check: verify certificate
7297 */
7298#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007300 ((void) rs_ctx);
7301 have_ca_chain = 1;
7302
Gilles Peskine449bd832023-01-11 14:50:10 +01007303 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007304 ret = mbedtls_x509_crt_verify_with_ca_cb(
7305 chain,
7306 ssl->conf->f_ca_cb,
7307 ssl->conf->p_ca_cb,
7308 ssl->conf->cert_profile,
7309 ssl->hostname,
7310 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007311 f_vrfy, p_vrfy);
7312 } else
Jerry Yud9526692022-02-17 14:23:47 +08007313#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7314 {
7315 mbedtls_x509_crt *ca_chain;
7316 mbedtls_x509_crl *ca_crl;
7317
7318#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007320 ca_chain = ssl->handshake->sni_ca_chain;
7321 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 } else
Jerry Yud9526692022-02-17 14:23:47 +08007323#endif
7324 {
7325 ca_chain = ssl->conf->ca_chain;
7326 ca_crl = ssl->conf->ca_crl;
7327 }
7328
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007330 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 }
Jerry Yud9526692022-02-17 14:23:47 +08007332
7333 ret = mbedtls_x509_crt_verify_restartable(
7334 chain,
7335 ca_chain, ca_crl,
7336 ssl->conf->cert_profile,
7337 ssl->hostname,
7338 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007339 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007340 }
7341
Gilles Peskine449bd832023-01-11 14:50:10 +01007342 if (ret != 0) {
7343 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007344 }
7345
7346#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7348 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7349 }
Jerry Yud9526692022-02-17 14:23:47 +08007350#endif
7351
7352 /*
7353 * Secondary checks: always done, but change 'ret' only if it was 0
7354 */
7355
Valerio Settiacd32c02023-06-29 18:06:29 +02007356#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007357 {
7358 const mbedtls_pk_context *pk = &chain->pk;
7359
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007360 /* If certificate uses an EC key, make sure the curve is OK.
7361 * This is a public key, so it can't be opaque, so can_do() is a good
7362 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007363 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007364 /* and in the unlikely case the above assumption no longer holds
7365 * we are making sure that pk_ec() here does not return a NULL
7366 */
Valerio Settid0405092023-05-24 13:16:40 +02007367 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7368 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7369 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007371 }
Valerio Setti97207782023-05-18 18:59:06 +02007372 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007373 ssl->session_negotiate->verify_result |=
7374 MBEDTLS_X509_BADCERT_BAD_KEY;
7375
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7377 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007378 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007380 }
Jerry Yud9526692022-02-17 14:23:47 +08007381 }
7382 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007383#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007384
Gilles Peskine449bd832023-01-11 14:50:10 +01007385 if (mbedtls_ssl_check_cert_usage(chain,
7386 ciphersuite_info,
7387 !ssl->conf->endpoint,
7388 &ssl->session_negotiate->verify_result) != 0) {
7389 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7390 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007391 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 }
Jerry Yud9526692022-02-17 14:23:47 +08007393 }
7394
7395 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7396 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7397 * with details encoded in the verification flags. All other kinds
7398 * of error codes, including those from the user provided f_vrfy
7399 * functions, are treated as fatal and lead to a failure of
7400 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7402 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7403 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007404 ret = 0;
7405 }
7406
Gilles Peskine449bd832023-01-11 14:50:10 +01007407 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7408 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007409 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7410 }
7411
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007413 uint8_t alert;
7414
7415 /* The certificate may have been rejected for several reasons.
7416 Pick one and send the corresponding alert. Which alert to send
7417 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007419 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007421 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007423 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007425 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007427 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007429 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007431 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007433 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007435 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007437 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007439 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 }
7441 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7442 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007443 }
7444
7445#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 if (ssl->session_negotiate->verify_result != 0) {
7447 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7448 (unsigned int) ssl->session_negotiate->verify_result));
7449 } else {
7450 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007451 }
7452#endif /* MBEDTLS_DEBUG_C */
7453
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007455}
7456
7457#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007458MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007459static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7460 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007461{
7462 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7463 /* Remember digest of the peer's end-CRT. */
7464 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7466 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7467 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7468 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7469 mbedtls_ssl_send_alert_message(ssl,
7470 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7471 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007472
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007474 }
7475
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 ret = mbedtls_md(mbedtls_md_info_from_type(
7477 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7478 start, len,
7479 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007480
7481 ssl->session_negotiate->peer_cert_digest_type =
7482 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7483 ssl->session_negotiate->peer_cert_digest_len =
7484 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7485
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007487}
7488
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007489MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007490static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7491 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007492{
7493 unsigned char *end = start + len;
7494 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7495
7496 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7498 ret = mbedtls_pk_parse_subpubkey(&start, end,
7499 &ssl->handshake->peer_pubkey);
7500 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007501 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007503 }
7504
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007506}
7507#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7508
Gilles Peskine449bd832023-01-11 14:50:10 +01007509int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007510{
7511 int ret = 0;
7512 int crt_expected;
7513#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7514 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7515 ? ssl->handshake->sni_authmode
7516 : ssl->conf->authmode;
7517#else
7518 const int authmode = ssl->conf->authmode;
7519#endif
7520 void *rs_ctx = NULL;
7521 mbedtls_x509_crt *chain = NULL;
7522
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007524
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7526 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7527 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007528 goto exit;
7529 }
7530
7531#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 if (ssl->handshake->ecrs_enabled &&
7533 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007534 chain = ssl->handshake->ecrs_peer_cert;
7535 ssl->handshake->ecrs_peer_cert = NULL;
7536 goto crt_verify;
7537 }
7538#endif
7539
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007541 /* mbedtls_ssl_read_record may have sent an alert already. We
7542 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007544 goto exit;
7545 }
7546
7547#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007549 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7550
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007552 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 }
Jerry Yud9526692022-02-17 14:23:47 +08007554
7555 goto exit;
7556 }
7557#endif /* MBEDTLS_SSL_SRV_C */
7558
7559 /* Clear existing peer CRT structure in case we tried to
7560 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007562
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7564 if (chain == NULL) {
7565 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7566 sizeof(mbedtls_x509_crt)));
7567 mbedtls_ssl_send_alert_message(ssl,
7568 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7569 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007570
7571 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7572 goto exit;
7573 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007575
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 ret = ssl_parse_certificate_chain(ssl, chain);
7577 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007578 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 }
Jerry Yud9526692022-02-17 14:23:47 +08007580
7581#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007583 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 }
Jerry Yud9526692022-02-17 14:23:47 +08007585
7586crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007588 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 }
Jerry Yud9526692022-02-17 14:23:47 +08007590#endif
7591
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 ret = ssl_parse_certificate_verify(ssl, authmode,
7593 chain, rs_ctx);
7594 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007595 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007596 }
Jerry Yud9526692022-02-17 14:23:47 +08007597
7598#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7599 {
7600 unsigned char *crt_start, *pk_start;
7601 size_t crt_len, pk_len;
7602
7603 /* We parse the CRT chain without copying, so
7604 * these pointers point into the input buffer,
7605 * and are hence still valid after freeing the
7606 * CRT chain. */
7607
7608 crt_start = chain->raw.p;
7609 crt_len = chain->raw.len;
7610
7611 pk_start = chain->pk_raw.p;
7612 pk_len = chain->pk_raw.len;
7613
7614 /* Free the CRT structures before computing
7615 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 mbedtls_x509_crt_free(chain);
7617 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007618 chain = NULL;
7619
Gilles Peskine449bd832023-01-11 14:50:10 +01007620 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7621 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007622 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 }
Jerry Yud9526692022-02-17 14:23:47 +08007624
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7626 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007627 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 }
Jerry Yud9526692022-02-17 14:23:47 +08007629 }
7630#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7631 /* Pass ownership to session structure. */
7632 ssl->session_negotiate->peer_cert = chain;
7633 chain = NULL;
7634#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7635
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007637
7638exit:
7639
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007641 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 }
Jerry Yud9526692022-02-17 14:23:47 +08007643
7644#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007646 ssl->handshake->ecrs_peer_cert = chain;
7647 chain = NULL;
7648 }
7649#endif
7650
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 if (chain != NULL) {
7652 mbedtls_x509_crt_free(chain);
7653 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007654 }
7655
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007657}
7658#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7659
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007660static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7661 unsigned char *padbuf, size_t hlen,
7662 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007663{
7664 int len = 12;
7665 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007666#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007667 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007668 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007669 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007670 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007671#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007672 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007673 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007674 mbedtls_md_context_t cloned_ctx;
7675 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007676#endif
7677
7678 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007680 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007681 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007682
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007684 ? "client finished"
7685 : "server finished";
7686
7687#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007688 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007689
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007690 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007692 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007693 }
7694
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007695 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007697 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007698 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007699 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007700#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007701 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007702
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007703 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007704 if (ret != 0) {
7705 goto exit;
7706 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007707 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007708 if (ret != 0) {
7709 goto exit;
7710 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007711
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007712 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007713 if (ret != 0) {
7714 goto exit;
7715 }
7716#endif /* MBEDTLS_USE_PSA_CRYPTO */
7717
7718 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7719
Jerry Yu615bd6f2022-02-17 14:25:15 +08007720 /*
7721 * TLSv1.2:
7722 * hash = PRF( master, finished_label,
7723 * Hash( handshake ) )[0.11]
7724 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007726 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007727
Gilles Peskine449bd832023-01-11 14:50:10 +01007728 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007729
Paul Elliottecb95be2023-08-11 16:41:04 +01007730 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007731
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007732 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007733
7734exit:
7735#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007736 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007737 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007738#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007739 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007740 return ret;
7741#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007742}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007743
7744#if defined(MBEDTLS_MD_CAN_SHA256)
7745static int ssl_calc_finished_tls_sha256(
7746 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7747{
7748 unsigned char padbuf[32];
7749 return ssl_calc_finished_tls_generic(ssl,
7750#if defined(MBEDTLS_USE_PSA_CRYPTO)
7751 &ssl->handshake->fin_sha256_psa,
7752#else
7753 &ssl->handshake->fin_sha256,
7754#endif
7755 padbuf, sizeof(padbuf),
7756 buf, from);
7757}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007758#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007759
Jerry Yub7ba49e2022-02-17 14:25:53 +08007760
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007761#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007762static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007763 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007764{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007765 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007766 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007767#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007768 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007769#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007770 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007771#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007772 padbuf, sizeof(padbuf),
7773 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007774}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007775#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007776
Gilles Peskine449bd832023-01-11 14:50:10 +01007777void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007778{
Gilles Peskine449bd832023-01-11 14:50:10 +01007779 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007780
7781 /*
7782 * Free our handshake params
7783 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 mbedtls_ssl_handshake_free(ssl);
7785 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007786 ssl->handshake = NULL;
7787
7788 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007789 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007790 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007791 if (ssl->transform) {
7792 mbedtls_ssl_transform_free(ssl->transform);
7793 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007794 }
7795 ssl->transform = ssl->transform_negotiate;
7796 ssl->transform_negotiate = NULL;
7797
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007799}
7800
Gilles Peskine449bd832023-01-11 14:50:10 +01007801void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007802{
7803 int resume = ssl->handshake->resume;
7804
Gilles Peskine449bd832023-01-11 14:50:10 +01007805 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007806
7807#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007809 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7810 ssl->renego_records_seen = 0;
7811 }
7812#endif
7813
7814 /*
7815 * Free the previous session and switch in the current one
7816 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007818#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7819 /* RFC 7366 3.1: keep the EtM state */
7820 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007822#endif
7823
Gilles Peskine449bd832023-01-11 14:50:10 +01007824 mbedtls_ssl_session_free(ssl->session);
7825 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007826 }
7827 ssl->session = ssl->session_negotiate;
7828 ssl->session_negotiate = NULL;
7829
7830 /*
7831 * Add cache entry
7832 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007834 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007835 resume == 0) {
7836 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7837 ssl->session->id,
7838 ssl->session->id_len,
7839 ssl->session) != 0) {
7840 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7841 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007842 }
7843
7844#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007845 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7846 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007847 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007848 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007849
7850 /* Keep last flight around in case we need to resend it:
7851 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007852 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7853 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007854#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007856
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007857 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007858
Gilles Peskine449bd832023-01-11 14:50:10 +01007859 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007860}
7861
Gilles Peskine449bd832023-01-11 14:50:10 +01007862int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007863{
7864 int ret, hash_len;
7865
Gilles Peskine449bd832023-01-11 14:50:10 +01007866 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007867
Gilles Peskine449bd832023-01-11 14:50:10 +01007868 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007869
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007870 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7871 if (ret != 0) {
7872 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7873 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007874
7875 /*
7876 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7877 * may define some other value. Currently (early 2016), no defined
7878 * ciphersuite does this (and this is unlikely to change as activity has
7879 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7880 */
7881 hash_len = 12;
7882
7883#if defined(MBEDTLS_SSL_RENEGOTIATION)
7884 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007886#endif
7887
7888 ssl->out_msglen = 4 + hash_len;
7889 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7890 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7891
7892 /*
7893 * In case of session resuming, invert the client and server
7894 * ChangeCipherSpec messages order.
7895 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007896 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007897#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007899 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007901#endif
7902#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007904 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007906#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007908 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007910
7911 /*
7912 * Switch to our negotiated transform and session parameters for outbound
7913 * data.
7914 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007915 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007916
7917#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007919 unsigned char i;
7920
7921 /* Remember current epoch settings for resending */
7922 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7924 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007925
7926 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007927 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007928
7929
7930 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 for (i = 2; i > 0; i--) {
7932 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007933 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007934 }
7935 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007936
7937 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 if (i == 0) {
7939 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7940 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007941 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007943#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007945
7946 ssl->transform_out = ssl->transform_negotiate;
7947 ssl->session_out = ssl->session_negotiate;
7948
7949#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007950 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7951 mbedtls_ssl_send_flight_completed(ssl);
7952 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007953#endif
7954
Gilles Peskine449bd832023-01-11 14:50:10 +01007955 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7956 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7957 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007958 }
7959
7960#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7962 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7963 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7964 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007965 }
7966#endif
7967
Gilles Peskine449bd832023-01-11 14:50:10 +01007968 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007969
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007971}
7972
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007973#define SSL_MAX_HASH_LEN 12
7974
Gilles Peskine449bd832023-01-11 14:50:10 +01007975int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007976{
7977 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7978 unsigned int hash_len = 12;
7979 unsigned char buf[SSL_MAX_HASH_LEN];
7980
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007982
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007983 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7984 if (ret != 0) {
7985 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7986 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007987
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7989 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007990 goto exit;
7991 }
7992
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7994 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7995 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7996 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007997 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7998 goto exit;
7999 }
8000
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8002 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8003 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008004 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8005 goto exit;
8006 }
8007
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8009 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8010 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8011 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008012 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8013 goto exit;
8014 }
8015
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8017 buf, hash_len) != 0) {
8018 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8019 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8020 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008021 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8022 goto exit;
8023 }
8024
8025#if defined(MBEDTLS_SSL_RENEGOTIATION)
8026 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008028#endif
8029
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008031#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008032 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008033 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008035#endif
8036#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008038 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008039 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008040#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008041 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008042 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008043 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008044
8045#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8047 mbedtls_ssl_recv_flight_completed(ssl);
8048 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008049#endif
8050
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008052
8053exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 mbedtls_platform_zeroize(buf, hash_len);
8055 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008056}
8057
Jerry Yu392112c2022-02-17 14:34:10 +08008058#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8059/*
8060 * Helper to get TLS 1.2 PRF from ciphersuite
8061 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8062 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008063static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008064{
Jerry Yu392112c2022-02-17 14:34:10 +08008065 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008066 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008067#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008068 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8069 return tls_prf_sha384;
8070 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008071#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008072#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008073 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8075 return tls_prf_sha256;
8076 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008077 }
8078#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008079#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8080 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008081 (void) ciphersuite_info;
8082#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008083
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008085}
8086#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008087
Gilles Peskine449bd832023-01-11 14:50:10 +01008088static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008089{
8090 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008091#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 if (tls_prf == tls_prf_sha384) {
8093 return MBEDTLS_SSL_TLS_PRF_SHA384;
8094 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008095#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008096#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008097 if (tls_prf == tls_prf_sha256) {
8098 return MBEDTLS_SSL_TLS_PRF_SHA256;
8099 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008100#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008102}
8103
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008104/*
8105 * Populate a transform structure with session keys and all the other
8106 * necessary information.
8107 *
8108 * Parameters:
8109 * - [in/out]: transform: structure to populate
8110 * [in] must be just initialised with mbedtls_ssl_transform_init()
8111 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8112 * - [in] ciphersuite
8113 * - [in] master
8114 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008115 * - [in] tls_prf: pointer to PRF to use for key derivation
8116 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008117 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008118 * - [in] endpoint: client or server
8119 * - [in] ssl: used for:
8120 * - ssl->conf->{f,p}_export_keys
8121 * [in] optionally used for:
8122 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8123 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008124MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008125static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8126 int ciphersuite,
8127 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008128#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008129 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008130#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008131 ssl_tls_prf_t tls_prf,
8132 const unsigned char randbytes[64],
8133 mbedtls_ssl_protocol_version tls_version,
8134 unsigned endpoint,
8135 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008136{
8137 int ret = 0;
8138 unsigned char keyblk[256];
8139 unsigned char *key1;
8140 unsigned char *key2;
8141 unsigned char *mac_enc;
8142 unsigned char *mac_dec;
8143 size_t mac_key_len = 0;
8144 size_t iv_copy_len;
8145 size_t keylen;
8146 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008147 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008148#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008149 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008150 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008151#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008152
8153#if defined(MBEDTLS_USE_PSA_CRYPTO)
8154 psa_key_type_t key_type;
8155 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8156 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008157 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008158 size_t key_bits;
8159 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8160#endif
8161
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008162 /*
8163 * Some data just needs copying into the structure
8164 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008165#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008166 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008167#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008168 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008169
8170#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008171 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008172#endif
8173
8174#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008175 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008176 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8177 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008178 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008179 }
8180#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8181
8182 /*
8183 * Get various info structures
8184 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008185 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8186 if (ciphersuite_info == NULL) {
8187 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8188 ciphersuite));
8189 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008190 }
8191
Neil Armstrongab555e02022-04-04 11:07:59 +02008192 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008193#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008194 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008195#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008196 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008197
Gilles Peskine449bd832023-01-11 14:50:10 +01008198 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008199 transform->taglen =
8200 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008201 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008202
8203#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008204 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008205 transform->taglen,
8206 &alg,
8207 &key_type,
8208 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008209 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008211 goto end;
8212 }
8213#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008214 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008215 if (cipher_info == NULL) {
8216 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8217 ciphersuite_info->cipher));
8218 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008219 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008220#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008221
Neil Armstronge4512952022-03-08 09:08:22 +01008222#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008223 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008224 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008225 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008226 (unsigned) ciphersuite_info->mac));
8227 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008228 }
8229#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008230 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008231 if (md_info == NULL) {
8232 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8233 (unsigned) ciphersuite_info->mac));
8234 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008235 }
Neil Armstronge4512952022-03-08 09:08:22 +01008236#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008237
8238#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8239 /* Copy own and peer's CID if the use of the CID
8240 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8242 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008243
8244 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008245 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8246 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8247 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008248
8249 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008250 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8251 ssl->handshake->peer_cid_len);
8252 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8253 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008254 }
8255#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8256
8257 /*
8258 * Compute key block using the PRF
8259 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008260 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8261 if (ret != 0) {
8262 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8263 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008264 }
8265
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8267 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8268 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8269 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8270 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008271
8272 /*
8273 * Determine the appropriate key, IV and MAC length.
8274 */
8275
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008276#if defined(MBEDTLS_USE_PSA_CRYPTO)
8277 keylen = PSA_BITS_TO_BYTES(key_bits);
8278#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008280#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008281
Valerio Settie5707042023-10-11 11:54:42 +02008282#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008283 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008284 size_t explicit_ivlen;
8285
8286 transform->maclen = 0;
8287 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008288
8289 /* All modes haves 96-bit IVs, but the length of the static parts vary
8290 * with mode and version:
8291 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8292 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8293 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8294 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8295 * sequence number).
8296 */
8297 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008298
8299 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008300#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008301 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008302#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8304 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008305#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008306
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008308 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008309 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008310 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008312
8313 /* Minimum length of encrypted record */
8314 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8315 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008316 } else
Valerio Settie5707042023-10-11 11:54:42 +02008317#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008318#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008319 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008320 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008321 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008322#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008323 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008324#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008325 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008326#endif /* MBEDTLS_USE_PSA_CRYPTO */
8327
8328#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008329 /* Get MAC length */
8330 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8331#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008332 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008333 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8334 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8335 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008336 goto end;
8337 }
8338
8339 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008340 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008341#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008342 transform->maclen = mac_key_len;
8343
8344 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008345#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008346 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008347#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008348 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008349#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008350
8351 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008352 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008353 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008355 /*
8356 * GenericBlockCipher:
8357 * 1. if EtM is in use: one block plus MAC
8358 * otherwise: * first multiple of blocklen greater than maclen
8359 * 2. IV
8360 */
8361#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008362 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008363 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008364 + block_size;
8365 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008366#endif
8367 {
8368 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 + block_size
8370 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008371 }
8372
Gilles Peskine449bd832023-01-11 14:50:10 +01008373 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008374 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008375 } else {
8376 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008377 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8378 goto end;
8379 }
8380 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008381 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008382#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8383 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008384 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8385 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008386 }
8387
Gilles Peskine449bd832023-01-11 14:50:10 +01008388 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8389 (unsigned) keylen,
8390 (unsigned) transform->minlen,
8391 (unsigned) transform->ivlen,
8392 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008393
8394 /*
8395 * Finally setup the cipher contexts, IVs and MAC secrets.
8396 */
8397#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008398 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008399 key1 = keyblk + mac_key_len * 2;
8400 key2 = keyblk + mac_key_len * 2 + keylen;
8401
8402 mac_enc = keyblk;
8403 mac_dec = keyblk + mac_key_len;
8404
Gilles Peskine449bd832023-01-11 14:50:10 +01008405 iv_copy_len = (transform->fixed_ivlen) ?
8406 transform->fixed_ivlen : transform->ivlen;
8407 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8408 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8409 iv_copy_len);
8410 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008411#endif /* MBEDTLS_SSL_CLI_C */
8412#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008413 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008414 key1 = keyblk + mac_key_len * 2 + keylen;
8415 key2 = keyblk + mac_key_len * 2;
8416
8417 mac_enc = keyblk + mac_key_len;
8418 mac_dec = keyblk;
8419
Gilles Peskine449bd832023-01-11 14:50:10 +01008420 iv_copy_len = (transform->fixed_ivlen) ?
8421 transform->fixed_ivlen : transform->ivlen;
8422 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8423 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8424 iv_copy_len);
8425 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008426#endif /* MBEDTLS_SSL_SRV_C */
8427 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008429 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8430 goto end;
8431 }
8432
Paul Elliott4fb19552023-10-18 12:15:30 +01008433 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008434 ssl->f_export_keys(ssl->p_export_keys,
8435 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8436 master, 48,
8437 randbytes + 32,
8438 randbytes,
8439 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008440 }
8441
8442#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008443 transform->psa_alg = alg;
8444
Gilles Peskine449bd832023-01-11 14:50:10 +01008445 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8446 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8447 psa_set_key_algorithm(&attributes, alg);
8448 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008449
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 if ((status = psa_import_key(&attributes,
8451 key1,
8452 PSA_BITS_TO_BYTES(key_bits),
8453 &transform->psa_key_enc)) != PSA_SUCCESS) {
8454 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008455 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008456 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008457 goto end;
8458 }
8459
Gilles Peskine449bd832023-01-11 14:50:10 +01008460 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008461
Gilles Peskine449bd832023-01-11 14:50:10 +01008462 if ((status = psa_import_key(&attributes,
8463 key2,
8464 PSA_BITS_TO_BYTES(key_bits),
8465 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008466 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008467 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008468 goto end;
8469 }
8470 }
8471#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008472 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8473 cipher_info)) != 0) {
8474 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008475 goto end;
8476 }
8477
Gilles Peskine449bd832023-01-11 14:50:10 +01008478 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8479 cipher_info)) != 0) {
8480 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008481 goto end;
8482 }
8483
Gilles Peskine449bd832023-01-11 14:50:10 +01008484 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8485 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8486 MBEDTLS_ENCRYPT)) != 0) {
8487 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008488 goto end;
8489 }
8490
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8492 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8493 MBEDTLS_DECRYPT)) != 0) {
8494 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008495 goto end;
8496 }
8497
8498#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008499 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8500 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8501 MBEDTLS_PADDING_NONE)) != 0) {
8502 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", 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_set_padding_mode(&transform->cipher_ctx_dec,
8507 MBEDTLS_PADDING_NONE)) != 0) {
8508 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008509 goto end;
8510 }
8511 }
8512#endif /* MBEDTLS_CIPHER_MODE_CBC */
8513#endif /* MBEDTLS_USE_PSA_CRYPTO */
8514
Neil Armstrong29c0c042022-03-17 17:47:28 +01008515#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8516 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8517 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008518 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008519#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008520 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008521
Gilles Peskine449bd832023-01-11 14:50:10 +01008522 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8523 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8524 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008525
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 if ((status = psa_import_key(&attributes,
8527 mac_enc, mac_key_len,
8528 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008529 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008530 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008531 goto end;
8532 }
8533
Gilles Peskine449bd832023-01-11 14:50:10 +01008534 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8535 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008536#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008537 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008538#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008540 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008541 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8542 PSA_KEY_USAGE_VERIFY_HASH);
8543 } else {
8544 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8545 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008546
Gilles Peskine449bd832023-01-11 14:50:10 +01008547 if ((status = psa_import_key(&attributes,
8548 mac_dec, mac_key_len,
8549 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008550 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008552 goto end;
8553 }
8554#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8556 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008557 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008558 }
8559 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8560 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008561 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008563#endif /* MBEDTLS_USE_PSA_CRYPTO */
8564 }
8565#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8566
8567 ((void) mac_dec);
8568 ((void) mac_enc);
8569
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008570end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8572 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008573}
8574
Valerio Settia08b1a42022-11-17 15:10:02 +01008575#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8576 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008577int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008578 psa_pake_operation_t *pake_ctx,
8579 const unsigned char *buf,
8580 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008581{
8582 psa_status_t status;
8583 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008584 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008585 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8586 * At round two perform a single cycle
8587 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008589
Gilles Peskine449bd832023-01-11 14:50:10 +01008590 for (; remaining_steps > 0; remaining_steps--) {
8591 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008592 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008593 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008594 /* Length is stored at the first byte */
8595 size_t length = buf[input_offset];
8596 input_offset += 1;
8597
Gilles Peskine449bd832023-01-11 14:50:10 +01008598 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008599 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8600 }
8601
Gilles Peskine449bd832023-01-11 14:50:10 +01008602 status = psa_pake_input(pake_ctx, step,
8603 buf + input_offset, length);
8604 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008605 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008606 }
8607
8608 input_offset += length;
8609 }
8610 }
8611
Gilles Peskine449bd832023-01-11 14:50:10 +01008612 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008613 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008615
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008617}
8618
Valerio Setti6b3dab02022-11-17 17:14:54 +01008619int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008620 psa_pake_operation_t *pake_ctx,
8621 unsigned char *buf,
8622 size_t len, size_t *olen,
8623 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008624{
8625 psa_status_t status;
8626 size_t output_offset = 0;
8627 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008628 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008629 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8630 * At round two perform a single cycle
8631 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008632 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008633
Gilles Peskine449bd832023-01-11 14:50:10 +01008634 for (; remaining_steps > 0; remaining_steps--) {
8635 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8636 step <= PSA_PAKE_STEP_ZK_PROOF;
8637 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008638 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008639 * For each step, prepend 1 byte with the length of the data as
8640 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008641 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 status = psa_pake_output(pake_ctx, step,
8643 buf + output_offset + 1,
8644 len - output_offset - 1,
8645 &output_len);
8646 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008647 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008648 }
8649
Valerio Setti99d88c12022-11-22 16:03:43 +01008650 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008651
8652 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008653 }
8654 }
8655
8656 *olen = output_offset;
8657
Gilles Peskine449bd832023-01-11 14:50:10 +01008658 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008659}
Valerio Settia08b1a42022-11-17 15:10:02 +01008660#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8661
Jerry Yuee40f9d2022-02-17 14:55:16 +08008662#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008663int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8664 unsigned char *hash, size_t *hashlen,
8665 unsigned char *data, size_t data_len,
8666 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008667{
8668 psa_status_t status;
8669 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008670 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008671
Gilles Peskine449bd832023-01-11 14:50:10 +01008672 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008673
Gilles Peskine449bd832023-01-11 14:50:10 +01008674 if ((status = psa_hash_setup(&hash_operation,
8675 hash_alg)) != PSA_SUCCESS) {
8676 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008677 goto exit;
8678 }
8679
Gilles Peskine449bd832023-01-11 14:50:10 +01008680 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8681 64)) != PSA_SUCCESS) {
8682 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008683 goto exit;
8684 }
8685
Gilles Peskine449bd832023-01-11 14:50:10 +01008686 if ((status = psa_hash_update(&hash_operation,
8687 data, data_len)) != PSA_SUCCESS) {
8688 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008689 goto exit;
8690 }
8691
Gilles Peskine449bd832023-01-11 14:50:10 +01008692 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8693 hashlen)) != PSA_SUCCESS) {
8694 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8695 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008696 }
8697
8698exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 if (status != PSA_SUCCESS) {
8700 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8701 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8702 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008703 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008705 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8706 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008707 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008708 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008709 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008710 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008711 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008712 }
8713 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008714 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008715}
8716
8717#else
8718
Gilles Peskine449bd832023-01-11 14:50:10 +01008719int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8720 unsigned char *hash, size_t *hashlen,
8721 unsigned char *data, size_t data_len,
8722 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008723{
8724 int ret = 0;
8725 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008726 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8727 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008728
Gilles Peskine449bd832023-01-11 14:50:10 +01008729 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008730
Gilles Peskine449bd832023-01-11 14:50:10 +01008731 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008732
8733 /*
8734 * digitally-signed struct {
8735 * opaque client_random[32];
8736 * opaque server_random[32];
8737 * ServerDHParams params;
8738 * };
8739 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008740 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8741 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008742 goto exit;
8743 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008744 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8745 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008746 goto exit;
8747 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008748 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8749 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008750 goto exit;
8751 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008752 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8753 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008754 goto exit;
8755 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008756 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8757 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008758 goto exit;
8759 }
8760
8761exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008762 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008763
Gilles Peskine449bd832023-01-11 14:50:10 +01008764 if (ret != 0) {
8765 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8766 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8767 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008768
Gilles Peskine449bd832023-01-11 14:50:10 +01008769 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008770}
8771#endif /* MBEDTLS_USE_PSA_CRYPTO */
8772
Jerry Yud9d91da2022-02-17 14:57:06 +08008773#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8774
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008775/* Find the preferred hash for a given signature algorithm. */
8776unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008777 mbedtls_ssl_context *ssl,
8778 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008779{
Gabor Mezei078e8032022-04-27 21:17:56 +02008780 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008781 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008782
Gilles Peskine449bd832023-01-11 14:50:10 +01008783 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8784 return MBEDTLS_SSL_HASH_NONE;
8785 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008786
Gilles Peskine449bd832023-01-11 14:50:10 +01008787 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008788 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008789 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8790 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008791 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008792 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8793 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008794
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008795 mbedtls_md_type_t md_alg =
8796 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8797 if (md_alg == MBEDTLS_MD_NONE) {
8798 continue;
8799 }
8800
Gilles Peskine449bd832023-01-11 14:50:10 +01008801 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008802#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008803 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008804 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008805 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008806
Gilles Peskine449bd832023-01-11 14:50:10 +01008807 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8808 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8809 PSA_ALG_ECDSA(psa_hash_alg),
8810 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008811 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008812 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008813
Gilles Peskine449bd832023-01-11 14:50:10 +01008814 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8815 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8816 PSA_ALG_RSA_PKCS1V15_SIGN(
8817 psa_hash_alg),
8818 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008819 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008820 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008821 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008822#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008823
Gilles Peskine449bd832023-01-11 14:50:10 +01008824 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008825 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008826 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008827
Gilles Peskine449bd832023-01-11 14:50:10 +01008828 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008829}
8830
8831#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8832
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008833/* Serialization of TLS 1.2 sessions:
8834 *
8835 * struct {
8836 * uint64 start_time;
8837 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008838 * uint8 session_id_len; // at most 32
8839 * opaque session_id[32];
8840 * opaque master[48]; // fixed length in the standard
8841 * uint32 verify_result;
8842 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8843 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8844 * uint32 ticket_lifetime;
8845 * uint8 mfl_code; // up to 255 according to standard
8846 * uint8 encrypt_then_mac; // 0 or 1
8847 * } serialized_session_tls12;
8848 *
8849 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008850static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8851 unsigned char *buf,
8852 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008853{
8854 unsigned char *p = buf;
8855 size_t used = 0;
8856
8857#if defined(MBEDTLS_HAVE_TIME)
8858 uint64_t start;
8859#endif
8860#if defined(MBEDTLS_X509_CRT_PARSE_C)
8861#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8862 size_t cert_len;
8863#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8864#endif /* MBEDTLS_X509_CRT_PARSE_C */
8865
8866 /*
8867 * Time
8868 */
8869#if defined(MBEDTLS_HAVE_TIME)
8870 used += 8;
8871
Gilles Peskine449bd832023-01-11 14:50:10 +01008872 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008873 start = (uint64_t) session->start;
8874
Gilles Peskine449bd832023-01-11 14:50:10 +01008875 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008876 p += 8;
8877 }
8878#endif /* MBEDTLS_HAVE_TIME */
8879
8880 /*
8881 * Basic mandatory fields
8882 */
8883 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008884 + 1 /* id_len */
8885 + sizeof(session->id)
8886 + sizeof(session->master)
8887 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008888
Gilles Peskine449bd832023-01-11 14:50:10 +01008889 if (used <= buf_len) {
8890 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008891 p += 2;
8892
Gilles Peskine449bd832023-01-11 14:50:10 +01008893 *p++ = MBEDTLS_BYTE_0(session->id_len);
8894 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008895 p += 32;
8896
Gilles Peskine449bd832023-01-11 14:50:10 +01008897 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008898 p += 48;
8899
Gilles Peskine449bd832023-01-11 14:50:10 +01008900 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008901 p += 4;
8902 }
8903
8904 /*
8905 * Peer's end-entity certificate
8906 */
8907#if defined(MBEDTLS_X509_CRT_PARSE_C)
8908#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008909 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008910 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008911 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008912 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008913 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008914
8915 used += 3 + cert_len;
8916
Gilles Peskine449bd832023-01-11 14:50:10 +01008917 if (used <= buf_len) {
8918 *p++ = MBEDTLS_BYTE_2(cert_len);
8919 *p++ = MBEDTLS_BYTE_1(cert_len);
8920 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008921
Gilles Peskine449bd832023-01-11 14:50:10 +01008922 if (session->peer_cert != NULL) {
8923 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008924 p += cert_len;
8925 }
8926 }
8927#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008928 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008929 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008930 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008931 *p++ = (unsigned char) session->peer_cert_digest_type;
8932 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008933 memcpy(p, session->peer_cert_digest,
8934 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008935 p += session->peer_cert_digest_len;
8936 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008937 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008938 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008939 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008940 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8941 *p++ = 0;
8942 }
8943 }
8944#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8945#endif /* MBEDTLS_X509_CRT_PARSE_C */
8946
8947 /*
8948 * Session ticket if any, plus associated data
8949 */
8950#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8951 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8952
Gilles Peskine449bd832023-01-11 14:50:10 +01008953 if (used <= buf_len) {
8954 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
8955 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
8956 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008957
Gilles Peskine449bd832023-01-11 14:50:10 +01008958 if (session->ticket != NULL) {
8959 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008960 p += session->ticket_len;
8961 }
8962
Gilles Peskine449bd832023-01-11 14:50:10 +01008963 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008964 p += 4;
8965 }
8966#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8967
8968 /*
8969 * Misc extension-related info
8970 */
8971#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8972 used += 1;
8973
Gilles Peskine449bd832023-01-11 14:50:10 +01008974 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008975 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01008976 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008977#endif
8978
8979#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8980 used += 1;
8981
Gilles Peskine449bd832023-01-11 14:50:10 +01008982 if (used <= buf_len) {
8983 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
8984 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008985#endif
8986
Gilles Peskine449bd832023-01-11 14:50:10 +01008987 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008988}
8989
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008990MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008991static int ssl_tls12_session_load(mbedtls_ssl_session *session,
8992 const unsigned char *buf,
8993 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008994{
8995#if defined(MBEDTLS_HAVE_TIME)
8996 uint64_t start;
8997#endif
8998#if defined(MBEDTLS_X509_CRT_PARSE_C)
8999#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9000 size_t cert_len;
9001#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9002#endif /* MBEDTLS_X509_CRT_PARSE_C */
9003
9004 const unsigned char *p = buf;
9005 const unsigned char * const end = buf + len;
9006
9007 /*
9008 * Time
9009 */
9010#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009011 if (8 > (size_t) (end - p)) {
9012 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9013 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009014
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009015 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009016 p += 8;
9017
9018 session->start = (time_t) start;
9019#endif /* MBEDTLS_HAVE_TIME */
9020
9021 /*
9022 * Basic mandatory fields
9023 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009024 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9025 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9026 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009027
Gilles Peskine449bd832023-01-11 14:50:10 +01009028 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009029 p += 2;
9030
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009031 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009032 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009033 p += 32;
9034
Gilles Peskine449bd832023-01-11 14:50:10 +01009035 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009036 p += 48;
9037
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009038 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009039 p += 4;
9040
9041 /* Immediately clear invalid pointer values that have been read, in case
9042 * we exit early before we replaced them with valid ones. */
9043#if defined(MBEDTLS_X509_CRT_PARSE_C)
9044#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9045 session->peer_cert = NULL;
9046#else
9047 session->peer_cert_digest = NULL;
9048#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9049#endif /* MBEDTLS_X509_CRT_PARSE_C */
9050#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9051 session->ticket = NULL;
9052#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9053
9054 /*
9055 * Peer certificate
9056 */
9057#if defined(MBEDTLS_X509_CRT_PARSE_C)
9058#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9059 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009060 if (3 > (size_t) (end - p)) {
9061 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9062 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009063
Gilles Peskine449bd832023-01-11 14:50:10 +01009064 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009065 p += 3;
9066
Gilles Peskine449bd832023-01-11 14:50:10 +01009067 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009068 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9069
Gilles Peskine449bd832023-01-11 14:50:10 +01009070 if (cert_len > (size_t) (end - p)) {
9071 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9072 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009073
Gilles Peskine449bd832023-01-11 14:50:10 +01009074 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009075
Gilles Peskine449bd832023-01-11 14:50:10 +01009076 if (session->peer_cert == NULL) {
9077 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9078 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009079
Gilles Peskine449bd832023-01-11 14:50:10 +01009080 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009081
Gilles Peskine449bd832023-01-11 14:50:10 +01009082 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9083 p, cert_len)) != 0) {
9084 mbedtls_x509_crt_free(session->peer_cert);
9085 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009086 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009087 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009088 }
9089
9090 p += cert_len;
9091 }
9092#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9093 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009094 if (2 > (size_t) (end - p)) {
9095 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9096 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009097
9098 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9099 session->peer_cert_digest_len = (size_t) *p++;
9100
Gilles Peskine449bd832023-01-11 14:50:10 +01009101 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009102 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009103 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9104 if (md_info == NULL) {
9105 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9106 }
9107 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9108 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9109 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009110
Gilles Peskine449bd832023-01-11 14:50:10 +01009111 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9112 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9113 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009114
9115 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009116 mbedtls_calloc(1, session->peer_cert_digest_len);
9117 if (session->peer_cert_digest == NULL) {
9118 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9119 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009120
Gilles Peskine449bd832023-01-11 14:50:10 +01009121 memcpy(session->peer_cert_digest, p,
9122 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009123 p += session->peer_cert_digest_len;
9124 }
9125#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9126#endif /* MBEDTLS_X509_CRT_PARSE_C */
9127
9128 /*
9129 * Session ticket and associated data
9130 */
9131#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009132 if (3 > (size_t) (end - p)) {
9133 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9134 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009135
Gilles Peskine449bd832023-01-11 14:50:10 +01009136 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009137 p += 3;
9138
Gilles Peskine449bd832023-01-11 14:50:10 +01009139 if (session->ticket_len != 0) {
9140 if (session->ticket_len > (size_t) (end - p)) {
9141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9142 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009143
Gilles Peskine449bd832023-01-11 14:50:10 +01009144 session->ticket = mbedtls_calloc(1, session->ticket_len);
9145 if (session->ticket == 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->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009150 p += session->ticket_len;
9151 }
9152
Gilles Peskine449bd832023-01-11 14:50:10 +01009153 if (4 > (size_t) (end - p)) {
9154 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9155 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009156
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009157 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009158 p += 4;
9159#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9160
9161 /*
9162 * Misc extension-related info
9163 */
9164#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009165 if (1 > (size_t) (end - p)) {
9166 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9167 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009168
9169 session->mfl_code = *p++;
9170#endif
9171
9172#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009173 if (1 > (size_t) (end - p)) {
9174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9175 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009176
9177 session->encrypt_then_mac = *p++;
9178#endif
9179
9180 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009181 if (p != end) {
9182 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9183 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009184
Gilles Peskine449bd832023-01-11 14:50:10 +01009185 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009186}
Jerry Yudc7bd172022-02-17 13:44:15 +08009187#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9188
XiaokangQian75d40ef2022-04-20 11:05:24 +00009189int mbedtls_ssl_validate_ciphersuite(
9190 const mbedtls_ssl_context *ssl,
9191 const mbedtls_ssl_ciphersuite_t *suite_info,
9192 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009193 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009194{
9195 (void) ssl;
9196
Gilles Peskine449bd832023-01-11 14:50:10 +01009197 if (suite_info == NULL) {
9198 return -1;
9199 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009200
Gilles Peskine449bd832023-01-11 14:50:10 +01009201 if ((suite_info->min_tls_version > max_tls_version) ||
9202 (suite_info->max_tls_version < min_tls_version)) {
9203 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009204 }
9205
XiaokangQian060d8672022-04-21 09:24:56 +00009206#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009207#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009208#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009209 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9210 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009211#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009212 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9213 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009214#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009215 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009216 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009217 }
9218#endif
9219
9220 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9221#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009222 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9223 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9224 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009225 }
9226#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9227#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9228
Gilles Peskine449bd832023-01-11 14:50:10 +01009229 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009230}
9231
Ronald Crone68ab4f2022-10-05 12:46:29 +02009232#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009233/*
9234 * Function for writing a signature algorithm extension.
9235 *
9236 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9237 * value (TLS 1.3 RFC8446):
9238 * enum {
9239 * ....
9240 * ecdsa_secp256r1_sha256( 0x0403 ),
9241 * ecdsa_secp384r1_sha384( 0x0503 ),
9242 * ecdsa_secp521r1_sha512( 0x0603 ),
9243 * ....
9244 * } SignatureScheme;
9245 *
9246 * struct {
9247 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9248 * } SignatureSchemeList;
9249 *
9250 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9251 * value (TLS 1.2 RFC5246):
9252 * enum {
9253 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9254 * sha512(6), (255)
9255 * } HashAlgorithm;
9256 *
9257 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9258 * SignatureAlgorithm;
9259 *
9260 * struct {
9261 * HashAlgorithm hash;
9262 * SignatureAlgorithm signature;
9263 * } SignatureAndHashAlgorithm;
9264 *
9265 * SignatureAndHashAlgorithm
9266 * supported_signature_algorithms<2..2^16-2>;
9267 *
9268 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9269 * generalization of the TLS 1.2 signature algorithm extension.
9270 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9271 * `SignatureScheme` field of TLS 1.3
9272 *
9273 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009274int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9275 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009276{
9277 unsigned char *p = buf;
9278 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9279 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9280
9281 *out_len = 0;
9282
Gilles Peskine449bd832023-01-11 14:50:10 +01009283 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009284
9285 /* Check if we have space for header and length field:
9286 * - extension_type (2 bytes)
9287 * - extension_data_length (2 bytes)
9288 * - supported_signature_algorithms_length (2 bytes)
9289 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009290 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009291 p += 6;
9292
9293 /*
9294 * Write supported_signature_algorithms
9295 */
9296 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009297 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9298 if (sig_alg == NULL) {
9299 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9300 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009301
Gilles Peskine449bd832023-01-11 14:50:10 +01009302 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9303 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9304 *sig_alg,
9305 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9306 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009307 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009308 }
9309 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9310 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009311 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009312 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9313 *sig_alg,
9314 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009315 }
9316
9317 /* Length of supported_signature_algorithms */
9318 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009319 if (supported_sig_alg_len == 0) {
9320 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9321 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009322 }
9323
Gilles Peskine449bd832023-01-11 14:50:10 +01009324 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9325 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9326 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009327
XiaokangQianeaf36512022-04-24 09:07:44 +00009328 *out_len = p - buf;
9329
9330#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009331 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009332#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009333
Gilles Peskine449bd832023-01-11 14:50:10 +01009334 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009335}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009336#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009337
XiaokangQian40a35232022-05-07 09:02:40 +00009338#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009339/*
9340 * mbedtls_ssl_parse_server_name_ext
9341 *
9342 * Structure of server_name extension:
9343 *
9344 * enum {
9345 * host_name(0), (255)
9346 * } NameType;
9347 * opaque HostName<1..2^16-1>;
9348 *
9349 * struct {
9350 * NameType name_type;
9351 * select (name_type) {
9352 * case host_name: HostName;
9353 * } name;
9354 * } ServerName;
9355 * struct {
9356 * ServerName server_name_list<1..2^16-1>
9357 * } ServerNameList;
9358 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009359MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009360int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9361 const unsigned char *buf,
9362 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009363{
9364 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9365 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009366 size_t server_name_list_len, hostname_len;
9367 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009368
Gilles Peskine449bd832023-01-11 14:50:10 +01009369 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009370
Gilles Peskine449bd832023-01-11 14:50:10 +01009371 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9372 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009373 p += 2;
9374
Gilles Peskine449bd832023-01-11 14:50:10 +01009375 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009376 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009377 while (p < server_name_list_end) {
9378 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9379 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9380 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9381 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009382
Gilles Peskine449bd832023-01-11 14:50:10 +01009383 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009384 /* sni_name is intended to be used only during the parsing of the
9385 * ClientHello message (it is reset to NULL before the end of
9386 * the message parsing). Thus it is ok to just point to the
9387 * reception buffer and not make a copy of it.
9388 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009389 ssl->handshake->sni_name = p + 3;
9390 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009391 if (ssl->conf->f_sni == NULL) {
9392 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009393 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009394 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9395 ssl, p + 3, hostname_len);
9396 if (ret != 0) {
9397 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9398 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9399 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9400 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9401 }
9402 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009403 }
9404
9405 p += hostname_len + 3;
9406 }
9407
Gilles Peskine449bd832023-01-11 14:50:10 +01009408 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009409}
9410#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9411
XiaokangQianacb39922022-06-17 10:18:48 +00009412#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009413MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009414int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9415 const unsigned char *buf,
9416 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009417{
9418 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009419 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009420 const unsigned char *protocol_name_list;
9421 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009422 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009423
9424 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009425 if (ssl->conf->alpn_list == NULL) {
9426 return 0;
9427 }
XiaokangQianacb39922022-06-17 10:18:48 +00009428
9429 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009430 * RFC7301, section 3.1
9431 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009432 *
XiaokangQianc7403452022-06-23 03:24:12 +00009433 * struct {
9434 * ProtocolName protocol_name_list<2..2^16-1>
9435 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009436 */
9437
XiaokangQianc7403452022-06-23 03:24:12 +00009438 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009439 * protocol_name_list_len 2 bytes
9440 * protocol_name_len 1 bytes
9441 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009442 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009443 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009444
Gilles Peskine449bd832023-01-11 14:50:10 +01009445 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009446 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009447 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009448 protocol_name_list = p;
9449 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009450
9451 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009452 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009453 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009454 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9455 protocol_name_len);
9456 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009457 MBEDTLS_SSL_PEND_FATAL_ALERT(
9458 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009459 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9460 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009461 }
9462
9463 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009464 }
9465
9466 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009467 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9468 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009469 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009470 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009471 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009472 if (protocol_name_len == alpn_len &&
9473 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009474 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009475 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009476 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009477
9478 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009479 }
9480 }
9481
XiaokangQian95d5f542022-06-24 02:29:26 +00009482 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009483 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009484 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9485 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9486 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009487}
9488
Gilles Peskine449bd832023-01-11 14:50:10 +01009489int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9490 unsigned char *buf,
9491 unsigned char *end,
9492 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009493{
9494 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009495 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009496 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009497
Gilles Peskine449bd832023-01-11 14:50:10 +01009498 if (ssl->alpn_chosen == NULL) {
9499 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009500 }
9501
Gilles Peskine449bd832023-01-11 14:50:10 +01009502 protocol_name_len = strlen(ssl->alpn_chosen);
9503 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009504
Gilles Peskine449bd832023-01-11 14:50:10 +01009505 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009506 /*
9507 * 0 . 1 ext identifier
9508 * 2 . 3 ext length
9509 * 4 . 5 protocol list length
9510 * 6 . 6 protocol name length
9511 * 7 . 7+n protocol name
9512 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009513 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009514
XiaokangQian95d5f542022-06-24 02:29:26 +00009515 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009516
Gilles Peskine449bd832023-01-11 14:50:10 +01009517 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9518 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009519 /* Note: the length of the chosen protocol has been checked to be less
9520 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9521 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009522 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009523
Gilles Peskine449bd832023-01-11 14:50:10 +01009524 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009525
9526#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009527 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009528#endif
9529
Gilles Peskine449bd832023-01-11 14:50:10 +01009530 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009531}
9532#endif /* MBEDTLS_SSL_ALPN */
9533
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009534#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009535 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009536 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009537 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009538int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9539 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009540{
9541 /* Initialize to suppress unnecessary compiler warning */
9542 size_t hostname_len = 0;
9543
9544 /* Check if new hostname is valid before
9545 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009546 if (hostname != NULL) {
9547 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009548
Gilles Peskine449bd832023-01-11 14:50:10 +01009549 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9550 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9551 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009552 }
9553
9554 /* Now it's clear that we will overwrite the old hostname,
9555 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009556 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009557 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009558 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009559 }
9560
9561 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009562 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009563 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009564 } else {
9565 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9566 if (session->hostname == NULL) {
9567 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9568 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009569
Gilles Peskine449bd832023-01-11 14:50:10 +01009570 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009571 }
9572
Gilles Peskine449bd832023-01-11 14:50:10 +01009573 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009574}
Xiaokang Qian03409292022-10-12 02:49:52 +00009575#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9576 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009577 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009578 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009579
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009580#endif /* MBEDTLS_SSL_TLS_C */