blob: e96ce06f12f1ebbe0de5987eb0df3b0348d67914 [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
Jerry Yub476a442022-01-21 18:14:45 +080028#include <assert.h>
29
SimonBd5800b72016-04-26 07:43:27 +010030#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010031
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000032#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010033#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010034#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000035#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040036
Janos Follath73c616b2019-12-18 15:07:04 +000037#include "mbedtls/debug.h"
38#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050039#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010040#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020041#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020042
Rich Evans00ab4702015-02-06 13:43:58 +000043#include <string.h>
44
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050045#if defined(MBEDTLS_USE_PSA_CRYPTO)
46#include "mbedtls/psa_util.h"
47#include "psa/crypto.h"
48#endif
Manuel Pégourié-Gonnard07018f92022-09-15 11:29:35 +020049#include "mbedtls/legacy_or_psa.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050050
Janos Follath23bdca02016-10-07 14:47:14 +010051#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000052#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020053#endif
54
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050055#if defined(MBEDTLS_USE_PSA_CRYPTO)
56#define PSA_TO_MBEDTLS_ERR(status) PSA_TO_MBEDTLS_ERR_LIST(status, \
57 psa_to_ssl_errors, \
58 psa_generic_status_to_mbedtls)
Andrzej Kurekdaf5b562023-03-03 05:52:28 -050059#define PSA_TO_MD_ERR(status) PSA_TO_MBEDTLS_ERR_LIST(status, \
60 psa_to_md_errors, \
61 psa_generic_status_to_mbedtls)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050062#endif
63
Ronald Cronad8c17b2022-06-10 17:18:09 +020064#if defined(MBEDTLS_TEST_HOOKS)
65static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
66
67void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010068 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020069{
70 chk_buf_ptr_fail_args.cur = cur;
71 chk_buf_ptr_fail_args.end = end;
72 chk_buf_ptr_fail_args.need = need;
73}
74
Gilles Peskine449bd832023-01-11 14:50:10 +010075void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020076{
Gilles Peskine449bd832023-01-11 14:50:10 +010077 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020078}
79
Gilles Peskine449bd832023-01-11 14:50:10 +010080int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020081{
Gilles Peskine449bd832023-01-11 14:50:10 +010082 return (chk_buf_ptr_fail_args.cur != args->cur) ||
83 (chk_buf_ptr_fail_args.end != args->end) ||
84 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020085}
86#endif /* MBEDTLS_TEST_HOOKS */
87
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020088#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010089
Hanno Beckera0e20d02019-05-15 14:03:01 +010090#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010091/* Top-level Connection ID API */
92
Gilles Peskine449bd832023-01-11 14:50:10 +010093int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
94 size_t len,
95 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010096{
Gilles Peskine449bd832023-01-11 14:50:10 +010097 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
98 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
99 }
Hanno Beckerad4a1372019-05-03 13:06:44 +0100100
Gilles Peskine449bd832023-01-11 14:50:10 +0100101 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
102 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
103 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +0100104 }
105
106 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100107 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100108 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100109}
110
Gilles Peskine449bd832023-01-11 14:50:10 +0100111int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
112 int enable,
113 unsigned char const *own_cid,
114 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100115{
Gilles Peskine449bd832023-01-11 14:50:10 +0100116 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
118 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100119
Hanno Beckerca092242019-04-25 16:01:49 +0100120 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100121 if (enable == MBEDTLS_SSL_CID_DISABLED) {
122 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
123 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100124 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
126 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100127
Gilles Peskine449bd832023-01-11 14:50:10 +0100128 if (own_cid_len != ssl->conf->cid_len) {
129 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
130 (unsigned) own_cid_len,
131 (unsigned) ssl->conf->cid_len));
132 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100133 }
134
Gilles Peskine449bd832023-01-11 14:50:10 +0100135 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100136 /* Truncation is not an issue here because
137 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
138 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100139
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100141}
142
Gilles Peskine449bd832023-01-11 14:50:10 +0100143int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
144 int *enabled,
145 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
146 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000147{
148 *enabled = MBEDTLS_SSL_CID_DISABLED;
149
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
151 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
152 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000153
154 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
155 * zero as this is indistinguishable from not requesting to use
156 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100157 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
158 return 0;
159 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000160
Gilles Peskine449bd832023-01-11 14:50:10 +0100161 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000162 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100163 if (own_cid != NULL) {
164 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
165 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000166 }
167
168 *enabled = MBEDTLS_SSL_CID_ENABLED;
169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000171}
172
Gilles Peskine449bd832023-01-11 14:50:10 +0100173int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
174 int *enabled,
175 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
176 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100177{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100178 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100179
Gilles Peskine449bd832023-01-11 14:50:10 +0100180 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
181 mbedtls_ssl_is_handshake_over(ssl) == 0) {
182 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100183 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100184
Hanno Beckerc5f24222019-05-03 12:54:52 +0100185 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
186 * were used, but client and server requested the empty CID.
187 * This is indistinguishable from not using the CID extension
188 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 if (ssl->transform_in->in_cid_len == 0 &&
190 ssl->transform_in->out_cid_len == 0) {
191 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100192 }
193
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100195 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100196 if (peer_cid != NULL) {
197 memcpy(peer_cid, ssl->transform_in->out_cid,
198 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100199 }
200 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100201
202 *enabled = MBEDTLS_SSL_CID_ENABLED;
203
Gilles Peskine449bd832023-01-11 14:50:10 +0100204 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100205}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100206#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200209
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200210#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200211/*
212 * Convert max_fragment_length codes to length.
213 * RFC 6066 says:
214 * enum{
215 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
216 * } MaxFragmentLength;
217 * and we add 0 -> extension unused
218 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100219static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200220{
Gilles Peskine449bd832023-01-11 14:50:10 +0100221 switch (mfl) {
222 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
223 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
224 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
225 return 512;
226 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
227 return 1024;
228 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
229 return 2048;
230 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
231 return 4096;
232 default:
233 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000234 }
235}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200237
Gilles Peskine449bd832023-01-11 14:50:10 +0100238int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
239 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200240{
Gilles Peskine449bd832023-01-11 14:50:10 +0100241 mbedtls_ssl_session_free(dst);
242 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800243#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
244 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000245#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
246 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000247 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800248#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000249#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800250
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000252
253#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000255 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200256
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
258 if (dst->peer_cert == NULL) {
259 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
260 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200261
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200263
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
265 src->peer_cert->raw.len)) != 0) {
266 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200267 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200269 }
270 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000271#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100272 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 mbedtls_calloc(1, src->peer_cert_digest_len);
275 if (dst->peer_cert_digest == NULL) {
276 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
277 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000278
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
280 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000281 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000282 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000283 }
284#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
285
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200287
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200288#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (src->ticket != NULL) {
290 dst->ticket = mbedtls_calloc(1, src->ticket_len);
291 if (dst->ticket == NULL) {
292 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
293 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200294
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200296 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000297
298#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
299 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000301 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
303 if (ret != 0) {
304 return ret;
305 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000306 }
307#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
308 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200309#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200310
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200312}
313
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500314#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200315MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100316static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500317{
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
319 if (resized_buffer == NULL) {
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500320 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500322
323 /* We want to copy len_new bytes when downsizing the buffer, and
324 * len_old bytes when upsizing, so we choose the smaller of two sizes,
325 * to fit one buffer into another. Size checks, ensuring that no data is
326 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 memcpy(resized_buffer, *buffer,
328 (len_new < *len_old) ? len_new : *len_old);
329 mbedtls_platform_zeroize(*buffer, *len_old);
330 mbedtls_free(*buffer);
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
Andrzej Kurek25f27152022-08-17 16:09:31 -0400424#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
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
433#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
434
435#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
436MBEDTLS_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);
Gilles Peskine449bd832023-01-11 14:50:10 +0100444#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
445
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
458#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100459static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100460#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
461
462#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100463static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100464#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
465
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)
Andrzej Kurek25f27152022-08-17 16:09:31 -0400476#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
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;
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400480#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -0400481#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
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;
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400485#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
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)
753#define ARRAY_LENGTH(a) (sizeof(a) / sizeof(*(a)))
754
755static const char *ticket_flag_name_table[] =
756{
757 [0] = "ALLOW_PSK_RESUMPTION",
758 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
759 [3] = "ALLOW_EARLY_DATA",
760};
761
Pengyu Lv4938a562023-01-16 11:28:49 +0800762void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
763 int level, const char *file, int line,
764 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800765{
766 size_t i;
767
768 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800769 "print ticket_flags (0x%02x)", flags);
770
771 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800772
773 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800774 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800775 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
776 ticket_flag_name_table[i]);
777 }
778 }
779}
780#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
781
Jerry Yud25cab02022-10-31 12:48:30 +0800782#endif /* MBEDTLS_DEBUG_C */
783
Gilles Peskine449bd832023-01-11 14:50:10 +0100784void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
785 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800786{
787 ((void) ciphersuite_info);
788
Andrzej Kurek25f27152022-08-17 16:09:31 -0400789#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800791 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800793#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400794#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800796 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100797 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800798#endif
799 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100800 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800801 return;
802 }
803}
804
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100805int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100806 unsigned hs_type,
807 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100808{
809 unsigned char hs_hdr[4];
810
811 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100812 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
813 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
814 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
815 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100816
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100817 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100818}
819
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100820int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100821 unsigned hs_type,
822 unsigned char const *msg,
823 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100824{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100825 int ret;
826 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100827 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100828 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100829 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100830 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100831}
832
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100833int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800834{
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100835#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) || \
836 defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100837#if defined(MBEDTLS_USE_PSA_CRYPTO)
838 psa_status_t status;
839#else
840 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
841#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100842#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800843 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100844#endif /* SHA-256 or SHA-384 */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400845#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800846#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100847 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
848 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500849 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100850 }
851 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
852 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500853 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100854 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800855#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100856 mbedtls_md_free(&ssl->handshake->fin_sha256);
857 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100858 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
859 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
860 0);
861 if (ret != 0) {
862 return ret;
863 }
864 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100865 if (ret != 0) {
866 return ret;
867 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800868#endif
869#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400870#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800871#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100872 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
873 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500874 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100875 }
876 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
877 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500878 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100879 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800880#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100881 mbedtls_md_free(&ssl->handshake->fin_sha384);
882 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100883 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
884 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
885 if (ret != 0) {
886 return ret;
887 }
888 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100889 if (ret != 0) {
890 return ret;
891 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800892#endif
893#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100894 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800895}
896
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100897static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100898 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800899{
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100900#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) || \
901 defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100902#if defined(MBEDTLS_USE_PSA_CRYPTO)
903 psa_status_t status;
904#else
905 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
906#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100907#else /* SHA-256 or SHA-384 */
908 ((void) ssl);
909 (void) buf;
910 (void) len;
911#endif /* SHA-256 or SHA-384 */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400912#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800913#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100914 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
915 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500916 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100917 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800918#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100919 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100920 if (ret != 0) {
921 return ret;
922 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800923#endif
924#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400925#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800926#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100927 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
928 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500929 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100930 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800931#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100932 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100933 if (ret != 0) {
934 return ret;
935 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800936#endif
937#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100938 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800939}
940
Andrzej Kurek25f27152022-08-17 16:09:31 -0400941#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100942static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100943 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800944{
945#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500946 return PSA_TO_MD_ERR(psa_hash_update(
947 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800948#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100949 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800950#endif
951}
952#endif
953
Andrzej Kurek25f27152022-08-17 16:09:31 -0400954#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100955static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100956 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800957{
958#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500959 return PSA_TO_MD_ERR(psa_hash_update(
960 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800961#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100962 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800963#endif
964}
965#endif
966
Gilles Peskine449bd832023-01-11 14:50:10 +0100967static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200968{
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200970
Andrzej Kurek25f27152022-08-17 16:09:31 -0400971#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500972#if defined(MBEDTLS_USE_PSA_CRYPTO)
973 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500974#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100975 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200976#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500977#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400978#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500979#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500980 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500981#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100982 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200983#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500984#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200985
986 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100987
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100989 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200990#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200991#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200993#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200994#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200995#if defined(MBEDTLS_USE_PSA_CRYPTO)
996 handshake->psa_pake_ctx = psa_pake_operation_init();
997 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
998#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02001000#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02001001#if defined(MBEDTLS_SSL_CLI_C)
1002 handshake->ecjpake_cache = NULL;
1003 handshake->ecjpake_cache_len = 0;
1004#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001005#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001006
Gilles Peskineeccd8882020-03-10 12:19:08 +01001007#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001009#endif
1010
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001011#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1012 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1013#endif
Hanno Becker75173122019-02-06 16:18:31 +00001014
1015#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1016 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001018#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001019}
1020
Gilles Peskine449bd832023-01-11 14:50:10 +01001021void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001022{
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001024
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001025#if defined(MBEDTLS_USE_PSA_CRYPTO)
1026 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1027 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001028#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001029 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1030 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001031#endif
1032
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001033#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001034#if defined(MBEDTLS_USE_PSA_CRYPTO)
1035 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1036 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001037#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001038 mbedtls_md_init(&transform->md_ctx_enc);
1039 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001040#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001041#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001042}
1043
Gilles Peskine449bd832023-01-11 14:50:10 +01001044void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001045{
Gilles Peskine449bd832023-01-11 14:50:10 +01001046 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001047}
1048
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001049MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001050static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001051{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001052 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1053
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001054 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001055#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 if (ssl->transform_negotiate) {
1057 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1058 }
Jerry Yu2e199812022-12-01 18:57:19 +08001059#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 if (ssl->session_negotiate) {
1061 mbedtls_ssl_session_free(ssl->session_negotiate);
1062 }
1063 if (ssl->handshake) {
1064 mbedtls_ssl_handshake_free(ssl);
1065 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001066
Jerry Yu2e199812022-12-01 18:57:19 +08001067#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001068 /*
1069 * Either the pointers are now NULL or cleared properly and can be freed.
1070 * Now allocate missing structures.
1071 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 if (ssl->transform_negotiate == NULL) {
1073 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001074 }
Jerry Yu2e199812022-12-01 18:57:19 +08001075#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001076
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 if (ssl->session_negotiate == NULL) {
1078 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001079 }
Paul Bakker48916f92012-09-16 19:57:18 +00001080
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 if (ssl->handshake == NULL) {
1082 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001083 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001084#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1085 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001086
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1088 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001089#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001090
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001091 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001093#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001094 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001095#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 ssl->session_negotiate == NULL) {
1097 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001098
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001100 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001101
1102#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001104 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001105#endif
1106
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001108 ssl->session_negotiate = NULL;
1109
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001111 }
1112
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001113 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 mbedtls_ssl_session_init(ssl->session_negotiate);
1115 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001116
Jerry Yu2e199812022-12-01 18:57:19 +08001117#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001119#endif
1120
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001121 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001122 ret = mbedtls_ssl_reset_checksum(ssl);
1123 if (ret != 0) {
1124 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1125 return ret;
1126 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001127
Jerry Yud0766ec2022-09-22 10:46:57 +08001128#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1129 defined(MBEDTLS_SSL_SRV_C) && \
1130 defined(MBEDTLS_SSL_SESSION_TICKETS)
1131 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001133#endif
1134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001135#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001137 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001138
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001140 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001142 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001144
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001146 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001147#endif
1148
Brett Warrene0edc842021-08-17 09:53:13 +01001149/*
1150 * curve_list is translated to IANA TLS group identifiers here because
1151 * mbedtls_ssl_conf_curves returns void and so can't return
1152 * any error codes.
1153 */
1154#if defined(MBEDTLS_ECP_C)
1155#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1156 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001158 size_t length;
1159 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1160
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE) &&
1162 (length < MBEDTLS_ECP_DP_MAX); length++) {
1163 }
Brett Warrene0edc842021-08-17 09:53:13 +01001164
1165 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1167 if (group_list == NULL) {
1168 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1169 }
Brett Warrene0edc842021-08-17 09:53:13 +01001170
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001172 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 curve_list[i]);
1174 if (tls_id == 0) {
1175 mbedtls_free(group_list);
1176 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001177 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001178 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001179 }
1180
1181 group_list[length] = 0;
1182
1183 ssl->handshake->group_list = group_list;
1184 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001185 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001186 ssl->handshake->group_list = ssl->conf->group_list;
1187 ssl->handshake->group_list_heap_allocated = 0;
1188 }
1189#endif /* MBEDTLS_DEPRECATED_REMOVED */
1190#endif /* MBEDTLS_ECP_C */
1191
Ronald Crone68ab4f2022-10-05 12:46:29 +02001192#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001193#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001194#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001195 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1196 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1198 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001199 const int *md;
1200 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001201 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001202 uint16_t *p;
1203
Jerry Yub476a442022-01-21 18:14:45 +08001204#if defined(static_assert)
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 static_assert(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1206 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1207 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001208#endif
1209
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1211 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001212 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 }
Valerio Setti75fba322023-02-23 17:35:09 +01001214#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001216#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001217
Jerry Yub476a442022-01-21 18:14:45 +08001218#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001220#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1222 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1223 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001224 }
1225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1227 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1228 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001229
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1231 sizeof(uint16_t));
1232 if (ssl->handshake->sig_algs == NULL) {
1233 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1234 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 p = (uint16_t *) ssl->handshake->sig_algs;
1237 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1238 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1239 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001241 }
Valerio Setti75fba322023-02-23 17:35:09 +01001242#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001244 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001245#endif
1246#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001248 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001249#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001250 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001251 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001252 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001253 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001254#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001255 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001256 ssl->handshake->sig_algs_heap_allocated = 0;
1257 }
Jerry Yucc539102022-06-27 16:27:35 +08001258#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001259#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001261}
1262
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001263#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001264/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001265MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001266static int ssl_cookie_write_dummy(void *ctx,
1267 unsigned char **p, unsigned char *end,
1268 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001269{
1270 ((void) ctx);
1271 ((void) p);
1272 ((void) end);
1273 ((void) cli_id);
1274 ((void) cli_id_len);
1275
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001277}
1278
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001279MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001280static int ssl_cookie_check_dummy(void *ctx,
1281 const unsigned char *cookie, size_t cookie_len,
1282 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001283{
1284 ((void) ctx);
1285 ((void) cookie);
1286 ((void) cookie_len);
1287 ((void) cli_id);
1288 ((void) cli_id_len);
1289
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001291}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001292#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001293
Paul Bakker5121ce52009-01-03 21:22:43 +00001294/*
1295 * Initialize an SSL context
1296 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001297void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001298{
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001300}
1301
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001302MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001303static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001304{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001305 const mbedtls_ssl_config *conf = ssl->conf;
1306
Ronald Cron6f135e12021-12-08 16:57:54 +01001307#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001308 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1309 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1310 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1311 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001312 }
1313
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1315 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001316 }
1317#endif
1318
1319#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001320 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1321 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1322 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001323 }
1324#endif
1325
Ronald Cron6f135e12021-12-08 16:57:54 +01001326#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1328 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1329 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1330 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001331 }
1332
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 if (conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
1334 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS 1.3 server is not supported yet."));
1335 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian8f9dfe42022-04-15 02:52:39 +00001336 }
1337
1338
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1340 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001341 }
1342#endif
1343
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1345 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001346}
1347
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001348MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001349static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1350{
1351 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 ret = ssl_conf_version_check(ssl);
1353 if (ret != 0) {
1354 return ret;
1355 }
Jerry Yu60835a82021-08-04 10:13:52 +08001356
Jerry Yudef7ae42022-10-30 14:13:19 +08001357#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1358 /* RFC 8446 section 4.4.3
1359 *
1360 * If the verification fails, the receiver MUST terminate the handshake with
1361 * a "decrypt_error" alert.
1362 *
1363 * If the client is configured as TLS 1.3 only with optional verify, return
1364 * bad config.
1365 *
1366 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001367 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1368 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001369 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1370 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1371 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001373 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 1, ("Optional verify auth mode "
1375 "is not available for TLS 1.3 client"));
1376 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001377 }
1378#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1379
Jerry Yu60835a82021-08-04 10:13:52 +08001380 /* Space for further checks */
1381
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001383}
1384
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001385/*
1386 * Setup an SSL context
1387 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001388
Gilles Peskine449bd832023-01-11 14:50:10 +01001389int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1390 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001391{
Janos Follath865b3eb2019-12-16 11:46:15 +00001392 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001393 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1394 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001395
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001396 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001397
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 if ((ret = ssl_conf_check(ssl)) != 0) {
1399 return ret;
1400 }
Jerry Yu60835a82021-08-04 10:13:52 +08001401
Paul Bakker62f2dee2012-09-28 07:31:51 +00001402 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001403 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001404 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001405
1406 /* Set to NULL in case of an error condition */
1407 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001408
Darryl Greenb33cc762019-11-28 14:29:44 +00001409#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1410 ssl->in_buf_len = in_buf_len;
1411#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1413 if (ssl->in_buf == NULL) {
1414 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001415 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001416 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001417 }
1418
Darryl Greenb33cc762019-11-28 14:29:44 +00001419#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1420 ssl->out_buf_len = out_buf_len;
1421#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1423 if (ssl->out_buf == NULL) {
1424 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001425 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001426 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001427 }
1428
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001430
Johan Pascalb62bb512015-12-03 21:56:45 +01001431#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001433#endif
1434
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001436 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001438
Gilles Peskine449bd832023-01-11 14:50:10 +01001439 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001440
1441error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 mbedtls_free(ssl->in_buf);
1443 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001444
1445 ssl->conf = NULL;
1446
Darryl Greenb33cc762019-11-28 14:29:44 +00001447#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1448 ssl->in_buf_len = 0;
1449 ssl->out_buf_len = 0;
1450#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001451 ssl->in_buf = NULL;
1452 ssl->out_buf = NULL;
1453
1454 ssl->in_hdr = NULL;
1455 ssl->in_ctr = NULL;
1456 ssl->in_len = NULL;
1457 ssl->in_iv = NULL;
1458 ssl->in_msg = NULL;
1459
1460 ssl->out_hdr = NULL;
1461 ssl->out_ctr = NULL;
1462 ssl->out_len = NULL;
1463 ssl->out_iv = NULL;
1464 ssl->out_msg = NULL;
1465
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001467}
1468
1469/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001470 * Reset an initialized and used SSL context for re-use while retaining
1471 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001472 *
1473 * If partial is non-zero, keep data in the input buffer and client ID.
1474 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001475 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001476void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1477 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001478{
Darryl Greenb33cc762019-11-28 14:29:44 +00001479#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1480 size_t in_buf_len = ssl->in_buf_len;
1481 size_t out_buf_len = ssl->out_buf_len;
1482#else
1483 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1484 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1485#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001486
Hanno Beckerb0302c42021-08-03 09:39:42 +01001487#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1488 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001489#endif
1490
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001491 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001493
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001495
1496 /* Reset incoming message parsing */
1497 ssl->in_offt = NULL;
1498 ssl->nb_zero = 0;
1499 ssl->in_msgtype = 0;
1500 ssl->in_msglen = 0;
1501 ssl->in_hslen = 0;
1502 ssl->keep_current_message = 0;
1503 ssl->transform_in = NULL;
1504
1505#if defined(MBEDTLS_SSL_PROTO_DTLS)
1506 ssl->next_record_offset = 0;
1507 ssl->in_epoch = 0;
1508#endif
1509
1510 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001512 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001514 }
1515
Ronald Cronad8c17b2022-06-10 17:18:09 +02001516 ssl->send_alert = 0;
1517
Hanno Beckerb0302c42021-08-03 09:39:42 +01001518 /* Reset outgoing message writing */
1519 ssl->out_msgtype = 0;
1520 ssl->out_msglen = 0;
1521 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 memset(ssl->out_buf, 0, out_buf_len);
1523 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001524 ssl->transform_out = NULL;
1525
1526#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001528#endif
1529
XiaokangQian2b01dc32022-01-21 02:53:13 +00001530#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 if (ssl->transform) {
1532 mbedtls_ssl_transform_free(ssl->transform);
1533 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001534 ssl->transform = NULL;
1535 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001536#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1537
XiaokangQian2b01dc32022-01-21 02:53:13 +00001538#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 mbedtls_ssl_transform_free(ssl->transform_application);
1540 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001541 ssl->transform_application = NULL;
1542
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001544#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1546 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001547 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001548#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001549
Gilles Peskine449bd832023-01-11 14:50:10 +01001550 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1551 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001552 ssl->handshake->transform_handshake = NULL;
1553 }
1554
XiaokangQian2b01dc32022-01-21 02:53:13 +00001555#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001556}
1557
Gilles Peskine449bd832023-01-11 14:50:10 +01001558int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001559{
1560 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1561
1562 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1563
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001565
1566 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001567#if defined(MBEDTLS_SSL_RENEGOTIATION)
1568 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001569 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001570
1571 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001572 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1573 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001574#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001575 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001576
Hanno Beckerb0302c42021-08-03 09:39:42 +01001577 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001578 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001579 if (ssl->session) {
1580 mbedtls_ssl_session_free(ssl->session);
1581 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001582 ssl->session = NULL;
1583 }
1584
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001586 ssl->alpn_chosen = NULL;
1587#endif
1588
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001589#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001590 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001591#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001593#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 if (free_cli_id) {
1595 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001596 ssl->cli_id = NULL;
1597 ssl->cli_id_len = 0;
1598 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001599#endif
1600
Gilles Peskine449bd832023-01-11 14:50:10 +01001601 if ((ret = ssl_handshake_init(ssl)) != 0) {
1602 return ret;
1603 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001604
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001606}
1607
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001608/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001609 * Reset an initialized and used SSL context for re-use while retaining
1610 * all application-set variables, function pointers and data.
1611 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001612int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001613{
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001615}
1616
1617/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001618 * SSL set accessors
1619 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001620void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001621{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001622 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001623}
1624
Gilles Peskine449bd832023-01-11 14:50:10 +01001625void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001626{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001627 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001628}
1629
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001630#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001631void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001632{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001633 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001634}
1635#endif
1636
Gilles Peskine449bd832023-01-11 14:50:10 +01001637void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001638{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001639 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001640}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001642#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001643
Gilles Peskine449bd832023-01-11 14:50:10 +01001644void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1645 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001646{
1647 ssl->disable_datagram_packing = !allow_packing;
1648}
1649
Gilles Peskine449bd832023-01-11 14:50:10 +01001650void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1651 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001652{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001653 conf->hs_timeout_min = min;
1654 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001655}
1656#endif
1657
Gilles Peskine449bd832023-01-11 14:50:10 +01001658void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001659{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001660 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001661}
1662
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001663#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001664void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1665 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1666 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001667{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001668 conf->f_vrfy = f_vrfy;
1669 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001670}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001671#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001672
Gilles Peskine449bd832023-01-11 14:50:10 +01001673void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1674 int (*f_rng)(void *, unsigned char *, size_t),
1675 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001676{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001677 conf->f_rng = f_rng;
1678 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001679}
1680
Gilles Peskine449bd832023-01-11 14:50:10 +01001681void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1682 void (*f_dbg)(void *, int, const char *, int, const char *),
1683 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001684{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001685 conf->f_dbg = f_dbg;
1686 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001687}
1688
Gilles Peskine449bd832023-01-11 14:50:10 +01001689void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1690 void *p_bio,
1691 mbedtls_ssl_send_t *f_send,
1692 mbedtls_ssl_recv_t *f_recv,
1693 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001694{
1695 ssl->p_bio = p_bio;
1696 ssl->f_send = f_send;
1697 ssl->f_recv = f_recv;
1698 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001699}
1700
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001701#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001702void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001703{
1704 ssl->mtu = mtu;
1705}
1706#endif
1707
Gilles Peskine449bd832023-01-11 14:50:10 +01001708void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001709{
1710 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001711}
1712
Gilles Peskine449bd832023-01-11 14:50:10 +01001713void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1714 void *p_timer,
1715 mbedtls_ssl_set_timer_t *f_set_timer,
1716 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001717{
1718 ssl->p_timer = p_timer;
1719 ssl->f_set_timer = f_set_timer;
1720 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001721
1722 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001723 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001724}
1725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001726#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001727void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1728 void *p_cache,
1729 mbedtls_ssl_cache_get_t *f_get_cache,
1730 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001731{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001732 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001733 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001734 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001735}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001739int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001740{
Janos Follath865b3eb2019-12-16 11:46:15 +00001741 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001742
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001744 session == NULL ||
1745 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1747 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001748 }
1749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (ssl->handshake->resume == 1) {
1751 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1752 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001753
Jerry Yu21092062022-10-10 21:21:31 +08001754#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001756 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001758
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001760 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1762 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1763 session->ciphersuite));
1764 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001765 }
Jerry Yu40afab62022-10-08 10:42:13 +08001766 }
Jerry Yu21092062022-10-10 21:21:31 +08001767#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001768
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1770 session)) != 0) {
1771 return ret;
1772 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001773
Paul Bakker0a597072012-09-25 21:55:46 +00001774 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001775
Gilles Peskine449bd832023-01-11 14:50:10 +01001776 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001777}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001778#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001779
Gilles Peskine449bd832023-01-11 14:50:10 +01001780void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1781 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001782{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001783 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001784}
1785
Ronald Cron6f135e12021-12-08 16:57:54 +01001786#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001787void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1788 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001789{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001790 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001791}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001792
1793#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001794void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
1795 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001796{
1797 conf->early_data_enabled = early_data_enabled;
1798}
Jerry Yucc4e0072022-11-22 17:22:22 +08001799
1800#if defined(MBEDTLS_SSL_SRV_C)
1801void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001802 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001803{
Jerry Yu39da9852022-12-06 16:58:36 +08001804 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001805}
1806#endif /* MBEDTLS_SSL_SRV_C */
1807
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001808#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001809#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001810
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001812void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1813 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001814{
1815 conf->cert_profile = profile;
1816}
1817
Gilles Peskine449bd832023-01-11 14:50:10 +01001818static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001819{
1820 mbedtls_ssl_key_cert *cur = key_cert, *next;
1821
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001823 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001824 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001825 cur = next;
1826 }
1827}
1828
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001829/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001830MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001831static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1832 mbedtls_x509_crt *cert,
1833 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001834{
niisato8ee24222018-06-25 19:05:48 +09001835 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001836
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001838 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001840 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001842 }
1843
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1845 if (new_cert == NULL) {
1846 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1847 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001848
niisato8ee24222018-06-25 19:05:48 +09001849 new_cert->cert = cert;
1850 new_cert->key = key;
1851 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001852
Glenn Strauss36872db2022-01-22 05:06:31 -05001853 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001855 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001857 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001858 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001859 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 }
niisato8ee24222018-06-25 19:05:48 +09001861 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001862 }
1863
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001865}
1866
Gilles Peskine449bd832023-01-11 14:50:10 +01001867int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001868 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001870{
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001872}
1873
Gilles Peskine449bd832023-01-11 14:50:10 +01001874void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001875 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001877{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001878 conf->ca_chain = ca_chain;
1879 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001880
1881#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1882 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1883 * cannot be used together. */
1884 conf->f_ca_cb = NULL;
1885 conf->p_ca_cb = NULL;
1886#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001887}
Hanno Becker5adaad92019-03-27 16:54:37 +00001888
1889#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001890void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1891 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1892 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001893{
1894 conf->f_ca_cb = f_ca_cb;
1895 conf->p_ca_cb = p_ca_cb;
1896
1897 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1898 * cannot be used together. */
1899 conf->ca_chain = NULL;
1900 conf->ca_crl = NULL;
1901}
1902#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001904
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001905#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001906const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1907 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001908{
1909 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001910 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001911}
1912
Gilles Peskine449bd832023-01-11 14:50:10 +01001913int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1914 mbedtls_x509_crt *own_cert,
1915 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001916{
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1918 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001919}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001920
Gilles Peskine449bd832023-01-11 14:50:10 +01001921void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1922 mbedtls_x509_crt *ca_chain,
1923 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001924{
1925 ssl->handshake->sni_ca_chain = ca_chain;
1926 ssl->handshake->sni_ca_crl = ca_crl;
1927}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001928
Glenn Strauss999ef702022-03-11 01:37:23 -05001929#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001930void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1931 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001932{
1933 ssl->handshake->dn_hints = crt;
1934}
1935#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1936
Gilles Peskine449bd832023-01-11 14:50:10 +01001937void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1938 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001939{
1940 ssl->handshake->sni_authmode = authmode;
1941}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001942#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1943
Hanno Becker8927c832019-04-03 12:52:50 +01001944#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001945void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1946 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1947 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001948{
1949 ssl->f_vrfy = f_vrfy;
1950 ssl->p_vrfy = p_vrfy;
1951}
1952#endif
1953
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001954#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001955
Valerio Setti016f6822022-12-09 14:17:50 +01001956#if defined(MBEDTLS_USE_PSA_CRYPTO)
1957static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 mbedtls_ssl_context *ssl,
1959 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001960{
1961 psa_status_t status;
1962 psa_pake_role_t psa_role;
1963 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
1964
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1966 psa_pake_cs_set_primitive(&cipher_suite,
1967 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1968 PSA_ECC_FAMILY_SECP_R1,
1969 256));
1970 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001971
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1973 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001974 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001976
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02001978 psa_role = PSA_PAKE_ROLE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 } else {
Neil Armstrongca7d5062022-05-31 14:43:23 +02001980 psa_role = PSA_PAKE_ROLE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001982
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 status = psa_pake_set_role(&ssl->handshake->psa_pake_ctx, psa_role);
1984 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001985 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 }
Valerio Setti016f6822022-12-09 14:17:50 +01001987
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1989 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001990 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 }
Valerio Setti016f6822022-12-09 14:17:50 +01001992
1993 ssl->handshake->psa_pake_ctx_is_ok = 1;
1994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001996}
1997
Gilles Peskine449bd832023-01-11 14:50:10 +01001998int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1999 const unsigned char *pw,
2000 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002001{
2002 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2003 psa_status_t status;
2004
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 if (ssl->handshake == NULL || ssl->conf == NULL) {
2006 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002007 }
2008
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 /* Empty password is not valid */
2010 if ((pw == NULL) || (pw_len == 0)) {
2011 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2012 }
2013
2014 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2015 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2016 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2017
2018 status = psa_import_key(&attributes, pw, pw_len,
2019 &ssl->handshake->psa_pake_password);
2020 if (status != PSA_SUCCESS) {
2021 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2022 }
2023
2024 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2025 ssl->handshake->psa_pake_password);
2026 if (status != PSA_SUCCESS) {
2027 psa_destroy_key(ssl->handshake->psa_pake_password);
2028 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2029 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2030 }
2031
2032 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002033}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2036 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002037{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002038 psa_status_t status;
2039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 if (ssl->handshake == NULL || ssl->conf == NULL) {
2041 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002042 }
2043
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 if (mbedtls_svc_key_id_is_null(pwd)) {
2045 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2046 }
2047
2048 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2049 if (status != PSA_SUCCESS) {
2050 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2051 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2052 }
2053
2054 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002055}
2056#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002057int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2058 const unsigned char *pw,
2059 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002060{
2061 mbedtls_ecjpake_role role;
2062
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 if (ssl->handshake == NULL || ssl->conf == NULL) {
2064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2065 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002066
Valerio Settic689ed82022-12-07 14:40:38 +01002067 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 if ((pw == NULL) || (pw_len == 0)) {
2069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2070 }
Valerio Settic689ed82022-12-07 14:40:38 +01002071
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002073 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002075 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2079 role,
2080 MBEDTLS_MD_SHA256,
2081 MBEDTLS_ECP_DP_SECP256R1,
2082 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002083}
Valerio Setti02c25b52022-11-15 14:08:42 +01002084#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002085#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002086
Ronald Cron73fe8df2022-10-05 14:31:43 +02002087#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002088int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002089{
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 if (conf->psk_identity == NULL ||
2091 conf->psk_identity_len == 0) {
2092 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002093 }
2094
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002095#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2097 return 1;
2098 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002099#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002100
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 if (conf->psk != NULL && conf->psk_len != 0) {
2102 return 1;
2103 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002104
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002106}
2107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002109{
2110 /* Remove reference to existing PSK, if any. */
2111#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002113 /* The maintenance of the PSK key slot is the
2114 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002115 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002116 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002117#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 if (conf->psk != NULL) {
2119 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002120
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 mbedtls_free(conf->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122 conf->psk = NULL;
2123 conf->psk_len = 0;
2124 }
2125
2126 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 if (conf->psk_identity != NULL) {
2128 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002129 conf->psk_identity = NULL;
2130 conf->psk_identity_len = 0;
2131 }
2132}
2133
Hanno Becker7390c712018-11-15 13:33:04 +00002134/* This function assumes that PSK identity in the SSL config is unset.
2135 * It checks that the provided identity is well-formed and attempts
2136 * to make a copy of it in the SSL config.
2137 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002138MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002139static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2140 unsigned char const *psk_identity,
2141 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002142{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002143 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002145 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 (psk_identity_len >> 16) != 0 ||
2147 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2148 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002149 }
2150
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2152 if (conf->psk_identity == NULL) {
2153 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2154 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002155
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002156 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002158
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002160}
2161
Gilles Peskine449bd832023-01-11 14:50:10 +01002162int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2163 const unsigned char *psk, size_t psk_len,
2164 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002165{
Janos Follath865b3eb2019-12-16 11:46:15 +00002166 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002167
2168 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2170 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2171 }
Hanno Becker7390c712018-11-15 13:33:04 +00002172
2173 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (psk == NULL) {
2175 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2176 }
2177 if (psk_len == 0) {
2178 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2179 }
2180 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2181 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2182 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002183
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2185 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2186 }
Hanno Becker7390c712018-11-15 13:33:04 +00002187 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002189
2190 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2192 if (ret != 0) {
2193 ssl_conf_remove_psk(conf);
2194 }
Hanno Becker7390c712018-11-15 13:33:04 +00002195
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002197}
2198
Gilles Peskine449bd832023-01-11 14:50:10 +01002199static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002200{
2201#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002203 /* The maintenance of the external PSK key slot is the
2204 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 if (ssl->handshake->psk_opaque_is_internal) {
2206 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002207 ssl->handshake->psk_opaque_is_internal = 0;
2208 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002209 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002210 }
Neil Armstronge952a302022-05-03 10:22:14 +02002211#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 if (ssl->handshake->psk != NULL) {
2213 mbedtls_platform_zeroize(ssl->handshake->psk,
2214 ssl->handshake->psk_len);
2215 mbedtls_free(ssl->handshake->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002216 ssl->handshake->psk_len = 0;
2217 }
Neil Armstronge952a302022-05-03 10:22:14 +02002218#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002219}
2220
Gilles Peskine449bd832023-01-11 14:50:10 +01002221int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2222 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002223{
Neil Armstrong501c9322022-05-03 09:35:09 +02002224#if defined(MBEDTLS_USE_PSA_CRYPTO)
2225 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002226 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002227 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002228 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002229#endif /* MBEDTLS_USE_PSA_CRYPTO */
2230
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 if (psk == NULL || ssl->handshake == NULL) {
2232 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2233 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002234
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
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 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002240
Neil Armstrong501c9322022-05-03 09:35:09 +02002241#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002242#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2244 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2245 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2246 } else {
2247 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2248 }
2249 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002250 }
2251#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002252
Jerry Yu568ec252022-07-22 21:27:34 +08002253#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2255 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2256 psa_set_key_usage_flags(&key_attributes,
2257 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002258 }
2259#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 psa_set_key_algorithm(&key_attributes, alg);
2262 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002263
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2265 if (status != PSA_SUCCESS) {
2266 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2267 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002268
2269 /* Allow calling psa_destroy_key() on psk remove */
2270 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002272#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2274 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2275 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002276
2277 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002279
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002281#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002282}
2283
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002284#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002285int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2286 mbedtls_svc_key_id_t psk,
2287 const unsigned char *psk_identity,
2288 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002289{
Janos Follath865b3eb2019-12-16 11:46:15 +00002290 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002291
2292 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2294 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2295 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002296
Hanno Becker7390c712018-11-15 13:33:04 +00002297 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 if (mbedtls_svc_key_id_is_null(psk)) {
2299 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2300 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002301 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002302
2303 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2305 psk_identity_len);
2306 if (ret != 0) {
2307 ssl_conf_remove_psk(conf);
2308 }
Hanno Becker7390c712018-11-15 13:33:04 +00002309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002311}
2312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2314 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002315{
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 if ((mbedtls_svc_key_id_is_null(psk)) ||
2317 (ssl->handshake == NULL)) {
2318 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2319 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002322 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002324}
2325#endif /* MBEDTLS_USE_PSA_CRYPTO */
2326
Jerry Yu8897c072022-08-12 13:56:53 +08002327#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002328void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2329 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2330 size_t),
2331 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002332{
2333 conf->f_psk = f_psk;
2334 conf->p_psk = p_psk;
2335}
Jerry Yu8897c072022-08-12 13:56:53 +08002336#endif /* MBEDTLS_SSL_SRV_C */
2337
Ronald Cron73fe8df2022-10-05 14:31:43 +02002338#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002339
2340#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002341static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002343{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002344#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 if (alg == PSA_ALG_CBC_NO_PADDING) {
2346 return MBEDTLS_SSL_MODE_CBC;
2347 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002348#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 if (PSA_ALG_IS_AEAD(alg)) {
2350 return MBEDTLS_SSL_MODE_AEAD;
2351 }
2352 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002353}
2354
2355#else /* MBEDTLS_USE_PSA_CRYPTO */
2356
2357static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002359{
2360#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (mode == MBEDTLS_MODE_CBC) {
2362 return MBEDTLS_SSL_MODE_CBC;
2363 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002364#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2365
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002366#if defined(MBEDTLS_GCM_C) || \
2367 defined(MBEDTLS_CCM_C) || \
2368 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002370 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 mode == MBEDTLS_MODE_CHACHAPOLY) {
2372 return MBEDTLS_SSL_MODE_AEAD;
2373 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002374#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002375
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002377}
Gilles Peskine301711e2022-04-26 16:57:05 +02002378#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002379
Gilles Peskinee108d982022-04-26 16:50:40 +02002380static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2381 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002383{
2384#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2386 base_mode == MBEDTLS_SSL_MODE_CBC) {
2387 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002388 }
2389#else
2390 (void) encrypt_then_mac;
2391#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002393}
2394
Neil Armstrongab555e02022-04-04 11:07:59 +02002395mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002397{
Gilles Peskinee108d982022-04-26 16:50:40 +02002398 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002399#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002401#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002403#endif
2404 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002405
Gilles Peskinee108d982022-04-26 16:50:40 +02002406 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002407#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002408 encrypt_then_mac = transform->encrypt_then_mac;
2409#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002411}
2412
Neil Armstrongab555e02022-04-04 11:07:59 +02002413mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002414#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002416#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002418{
Gilles Peskinee108d982022-04-26 16:50:40 +02002419 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2420
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002421#if defined(MBEDTLS_USE_PSA_CRYPTO)
2422 psa_status_t status;
2423 psa_algorithm_t alg;
2424 psa_key_type_t type;
2425 size_t size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 status = mbedtls_ssl_cipher_to_psa(suite->cipher, 0, &alg, &type, &size);
2427 if (status == PSA_SUCCESS) {
2428 base_mode = mbedtls_ssl_get_base_mode(alg);
2429 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002430#else
2431 const mbedtls_cipher_info_t *cipher =
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 mbedtls_cipher_info_from_type(suite->cipher);
2433 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002434 base_mode =
2435 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002437 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002438#endif /* MBEDTLS_USE_PSA_CRYPTO */
2439
Gilles Peskinee108d982022-04-26 16:50:40 +02002440#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2441 int encrypt_then_mac = 0;
2442#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002444}
2445
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002446#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002447
2448#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002449/* Serialization of TLS 1.3 sessions:
2450 *
2451 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002452 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002453 * uint64 ticket_received;
2454 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002455 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002456 * } ClientOnlyData;
2457 *
2458 * struct {
2459 * uint8 endpoint;
2460 * uint8 ciphersuite[2];
2461 * uint32 ticket_age_add;
2462 * uint8 ticket_flags;
2463 * opaque resumption_key<0..255>;
2464 * select ( endpoint ) {
2465 * case client: ClientOnlyData;
2466 * case server: uint64 start_time;
2467 * };
2468 * } serialized_session_tls13;
2469 *
2470 */
2471#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002472MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002473static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2474 unsigned char *buf,
2475 size_t buf_len,
2476 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002477{
2478 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002479#if defined(MBEDTLS_SSL_CLI_C) && \
2480 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002481 size_t hostname_len = (session->hostname == NULL) ?
2482 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002483#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002484 size_t needed = 1 /* endpoint */
2485 + 2 /* ciphersuite */
2486 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002487 + 1 /* ticket_flags */
2488 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002489 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002490
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2492 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2493 }
Jerry Yu34191072022-08-18 10:32:09 +08002494 needed += session->resumption_key_len; /* resumption_key */
2495
Jerry Yu438ddd82022-07-07 06:55:50 +00002496#if defined(MBEDTLS_HAVE_TIME)
2497 needed += 8; /* start_time or ticket_received */
2498#endif
2499
2500#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002502#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002503 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002505#endif
2506
Jerry Yu438ddd82022-07-07 06:55:50 +00002507 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002508 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002509
2510 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 if (session->ticket_len > SIZE_MAX - needed) {
2512 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2513 }
Jerry Yu34191072022-08-18 10:32:09 +08002514
Jerry Yue28d9742022-08-18 15:44:03 +08002515 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002516 }
2517#endif /* MBEDTLS_SSL_CLI_C */
2518
Jerry Yue36fdd62022-08-17 21:31:36 +08002519 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 if (needed > buf_len) {
2521 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2522 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002523
2524 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2526 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002527 p[7] = session->ticket_flags;
2528
2529 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002530 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002531 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002533 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002534
2535#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2537 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002538 p += 8;
2539 }
2540#endif /* MBEDTLS_HAVE_TIME */
2541
2542#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002543 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002544#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002546 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002548 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002550 p += hostname_len;
2551 }
2552#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2553
Jerry Yu438ddd82022-07-07 06:55:50 +00002554#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002556 p += 8;
2557#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002559 p += 4;
2560
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002562 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 if (session->ticket != NULL && session->ticket_len > 0) {
2565 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002566 p += session->ticket_len;
2567 }
2568 }
2569#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002571}
2572
2573MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002574static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2575 const unsigned char *buf,
2576 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002577{
2578 const unsigned char *p = buf;
2579 const unsigned char *end = buf + len;
2580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 if (end - p < 9) {
2582 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2583 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002584 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2586 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002587 session->ticket_flags = p[7];
2588
2589 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002590 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002591 p += 9;
2592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 if (end - p < session->resumption_key_len) {
2594 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2595 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002596
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2598 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2599 }
2600 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002601 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002602
2603#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2605 if (end - p < 8) {
2606 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2607 }
2608 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002609 p += 8;
2610 }
2611#endif /* MBEDTLS_HAVE_TIME */
2612
2613#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002615#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002617 size_t hostname_len;
2618 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 if (end - p < 2) {
2620 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2621 }
2622 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002623 p += 2;
2624
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 if (end - p < (long int) hostname_len) {
2626 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2627 }
2628 if (hostname_len > 0) {
2629 session->hostname = mbedtls_calloc(1, hostname_len);
2630 if (session->hostname == NULL) {
2631 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2632 }
2633 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002634 p += hostname_len;
2635 }
2636#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2637 MBEDTLS_SSL_SESSION_TICKETS */
2638
Jerry Yu438ddd82022-07-07 06:55:50 +00002639#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 if (end - p < 8) {
2641 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2642 }
2643 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002644 p += 8;
2645#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 if (end - p < 4) {
2647 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2648 }
2649 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002650 p += 4;
2651
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 if (end - p < 2) {
2653 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2654 }
2655 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002656 p += 2;
2657
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 if (end - p < (long int) session->ticket_len) {
2659 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2660 }
2661 if (session->ticket_len > 0) {
2662 session->ticket = mbedtls_calloc(1, session->ticket_len);
2663 if (session->ticket == NULL) {
2664 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2665 }
2666 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002667 p += session->ticket_len;
2668 }
2669 }
2670#endif /* MBEDTLS_SSL_CLI_C */
2671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002673
2674}
2675#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002676MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002677static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2678 unsigned char *buf,
2679 size_t buf_len,
2680 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002681{
2682 ((void) session);
2683 ((void) buf);
2684 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002685 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002687}
Jerry Yu438ddd82022-07-07 06:55:50 +00002688
Gilles Peskine449bd832023-01-11 14:50:10 +01002689static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2690 unsigned char *buf,
2691 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002692{
2693 ((void) session);
2694 ((void) buf);
2695 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002697}
2698#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002699#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2702 size_t taglen,
2703 psa_algorithm_t *alg,
2704 psa_key_type_t *key_type,
2705 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002706{
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002708 case MBEDTLS_CIPHER_AES_128_CBC:
2709 *alg = PSA_ALG_CBC_NO_PADDING;
2710 *key_type = PSA_KEY_TYPE_AES;
2711 *key_size = 128;
2712 break;
2713 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002715 *key_type = PSA_KEY_TYPE_AES;
2716 *key_size = 128;
2717 break;
2718 case MBEDTLS_CIPHER_AES_128_GCM:
2719 *alg = PSA_ALG_GCM;
2720 *key_type = PSA_KEY_TYPE_AES;
2721 *key_size = 128;
2722 break;
2723 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002725 *key_type = PSA_KEY_TYPE_AES;
2726 *key_size = 192;
2727 break;
2728 case MBEDTLS_CIPHER_AES_192_GCM:
2729 *alg = PSA_ALG_GCM;
2730 *key_type = PSA_KEY_TYPE_AES;
2731 *key_size = 192;
2732 break;
2733 case MBEDTLS_CIPHER_AES_256_CBC:
2734 *alg = PSA_ALG_CBC_NO_PADDING;
2735 *key_type = PSA_KEY_TYPE_AES;
2736 *key_size = 256;
2737 break;
2738 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002740 *key_type = PSA_KEY_TYPE_AES;
2741 *key_size = 256;
2742 break;
2743 case MBEDTLS_CIPHER_AES_256_GCM:
2744 *alg = PSA_ALG_GCM;
2745 *key_type = PSA_KEY_TYPE_AES;
2746 *key_size = 256;
2747 break;
2748 case MBEDTLS_CIPHER_ARIA_128_CBC:
2749 *alg = PSA_ALG_CBC_NO_PADDING;
2750 *key_type = PSA_KEY_TYPE_ARIA;
2751 *key_size = 128;
2752 break;
2753 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002755 *key_type = PSA_KEY_TYPE_ARIA;
2756 *key_size = 128;
2757 break;
2758 case MBEDTLS_CIPHER_ARIA_128_GCM:
2759 *alg = PSA_ALG_GCM;
2760 *key_type = PSA_KEY_TYPE_ARIA;
2761 *key_size = 128;
2762 break;
2763 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002765 *key_type = PSA_KEY_TYPE_ARIA;
2766 *key_size = 192;
2767 break;
2768 case MBEDTLS_CIPHER_ARIA_192_GCM:
2769 *alg = PSA_ALG_GCM;
2770 *key_type = PSA_KEY_TYPE_ARIA;
2771 *key_size = 192;
2772 break;
2773 case MBEDTLS_CIPHER_ARIA_256_CBC:
2774 *alg = PSA_ALG_CBC_NO_PADDING;
2775 *key_type = PSA_KEY_TYPE_ARIA;
2776 *key_size = 256;
2777 break;
2778 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002780 *key_type = PSA_KEY_TYPE_ARIA;
2781 *key_size = 256;
2782 break;
2783 case MBEDTLS_CIPHER_ARIA_256_GCM:
2784 *alg = PSA_ALG_GCM;
2785 *key_type = PSA_KEY_TYPE_ARIA;
2786 *key_size = 256;
2787 break;
2788 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2789 *alg = PSA_ALG_CBC_NO_PADDING;
2790 *key_type = PSA_KEY_TYPE_CAMELLIA;
2791 *key_size = 128;
2792 break;
2793 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002795 *key_type = PSA_KEY_TYPE_CAMELLIA;
2796 *key_size = 128;
2797 break;
2798 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2799 *alg = PSA_ALG_GCM;
2800 *key_type = PSA_KEY_TYPE_CAMELLIA;
2801 *key_size = 128;
2802 break;
2803 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002805 *key_type = PSA_KEY_TYPE_CAMELLIA;
2806 *key_size = 192;
2807 break;
2808 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2809 *alg = PSA_ALG_GCM;
2810 *key_type = PSA_KEY_TYPE_CAMELLIA;
2811 *key_size = 192;
2812 break;
2813 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2814 *alg = PSA_ALG_CBC_NO_PADDING;
2815 *key_type = PSA_KEY_TYPE_CAMELLIA;
2816 *key_size = 256;
2817 break;
2818 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002820 *key_type = PSA_KEY_TYPE_CAMELLIA;
2821 *key_size = 256;
2822 break;
2823 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2824 *alg = PSA_ALG_GCM;
2825 *key_type = PSA_KEY_TYPE_CAMELLIA;
2826 *key_size = 256;
2827 break;
2828 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2829 *alg = PSA_ALG_CHACHA20_POLY1305;
2830 *key_type = PSA_KEY_TYPE_CHACHA20;
2831 *key_size = 256;
2832 break;
2833 case MBEDTLS_CIPHER_NULL:
2834 *alg = MBEDTLS_SSL_NULL_CIPHER;
2835 *key_type = 0;
2836 *key_size = 0;
2837 break;
2838 default:
2839 return PSA_ERROR_NOT_SUPPORTED;
2840 }
2841
2842 return PSA_SUCCESS;
2843}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002844#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002845
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002846#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002847int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2848 const unsigned char *dhm_P, size_t P_len,
2849 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002850{
Janos Follath865b3eb2019-12-16 11:46:15 +00002851 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002852
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 mbedtls_mpi_free(&conf->dhm_P);
2854 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2857 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2858 mbedtls_mpi_free(&conf->dhm_P);
2859 mbedtls_mpi_free(&conf->dhm_G);
2860 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002861 }
2862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002864}
Paul Bakker5121ce52009-01-03 21:22:43 +00002865
Gilles Peskine449bd832023-01-11 14:50:10 +01002866int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002867{
Janos Follath865b3eb2019-12-16 11:46:15 +00002868 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002869
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 mbedtls_mpi_free(&conf->dhm_P);
2871 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002872
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2874 &conf->dhm_P)) != 0 ||
2875 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2876 &conf->dhm_G)) != 0) {
2877 mbedtls_mpi_free(&conf->dhm_P);
2878 mbedtls_mpi_free(&conf->dhm_G);
2879 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002880 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002881
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002883}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002884#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002885
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002886#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2887/*
2888 * Set the minimum length for Diffie-Hellman parameters
2889 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002890void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2891 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002892{
2893 conf->dhm_min_bitlen = bitlen;
2894}
2895#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2896
Ronald Crone68ab4f2022-10-05 12:46:29 +02002897#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002898#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002899/*
2900 * Set allowed/preferred hashes for handshake signatures
2901 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002902void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2903 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002904{
2905 conf->sig_hashes = hashes;
2906}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002907#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002908
Jerry Yuf017ee42022-01-12 15:49:48 +08002909/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002910void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2911 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002912{
Jerry Yuf017ee42022-01-12 15:49:48 +08002913#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2914 conf->sig_hashes = NULL;
2915#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2916 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002917}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002918#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002919
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002920#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002921#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002922/*
2923 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002924 *
2925 * mbedtls_ssl_setup() takes the provided list
2926 * and translates it to a list of IANA TLS group identifiers,
2927 * stored in ssl->handshake->group_list.
2928 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002929 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002930void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2931 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002932{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002933 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002934 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002935}
Brett Warrene0edc842021-08-17 09:53:13 +01002936#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002937#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002938
Brett Warrene0edc842021-08-17 09:53:13 +01002939/*
2940 * Set the allowed groups
2941 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002942void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2943 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002944{
2945#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2946 conf->curve_list = NULL;
2947#endif
2948 conf->group_list = group_list;
2949}
2950
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002951#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002952int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002953{
Hanno Becker947194e2017-04-07 13:25:49 +01002954 /* Initialize to suppress unnecessary compiler warning */
2955 size_t hostname_len = 0;
2956
2957 /* Check if new hostname is valid before
2958 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 if (hostname != NULL) {
2960 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002961
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2963 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2964 }
Hanno Becker947194e2017-04-07 13:25:49 +01002965 }
2966
2967 /* Now it's clear that we will overwrite the old hostname,
2968 * so we can free it safely */
2969
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 if (ssl->hostname != NULL) {
2971 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
2972 mbedtls_free(ssl->hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002973 }
2974
2975 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002978 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 } else {
2980 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2981 if (ssl->hostname == NULL) {
2982 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2983 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002986
Hanno Becker947194e2017-04-07 13:25:49 +01002987 ssl->hostname[hostname_len] = '\0';
2988 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002989
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002991}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002992#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002993
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002994#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002995void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2996 int (*f_sni)(void *, mbedtls_ssl_context *,
2997 const unsigned char *, size_t),
2998 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002999{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003000 conf->f_sni = f_sni;
3001 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003002}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003003#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003006int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003007{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003008 size_t cur_len, tot_len;
3009 const char **p;
3010
3011 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003012 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3013 * MUST NOT be truncated."
3014 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003015 */
3016 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 for (p = protos; *p != NULL; p++) {
3018 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003019 tot_len += cur_len;
3020
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 if ((cur_len == 0) ||
3022 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3023 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3024 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3025 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003026 }
3027
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003028 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003029
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003031}
3032
Gilles Peskine449bd832023-01-11 14:50:10 +01003033const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003034{
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003036}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003038
Johan Pascalb62bb512015-12-03 21:56:45 +01003039#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003040void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3041 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003042{
3043 conf->dtls_srtp_mki_support = support_mki_value;
3044}
3045
Gilles Peskine449bd832023-01-11 14:50:10 +01003046int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3047 unsigned char *mki_value,
3048 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003049{
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3051 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003052 }
Ron Eldor591f1622018-01-22 12:30:04 +02003053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3055 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003056 }
Ron Eldor591f1622018-01-22 12:30:04 +02003057
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003059 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003061}
3062
Gilles Peskine449bd832023-01-11 14:50:10 +01003063int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3064 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003065{
Johan Pascal253d0262020-09-22 13:04:45 +02003066 const mbedtls_ssl_srtp_profile *p;
3067 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003068
Johan Pascal253d0262020-09-22 13:04:45 +02003069 /* check the profiles list: all entry must be valid,
3070 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003071 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3072 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3073 p++) {
3074 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003075 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003076 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003077 /* unsupported value, stop parsing and set the size to an error value */
3078 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003079 }
3080 }
3081
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3083 conf->dtls_srtp_profile_list = NULL;
3084 conf->dtls_srtp_profile_list_len = 0;
3085 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003086 }
3087
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003088 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003089 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003092}
3093
Gilles Peskine449bd832023-01-11 14:50:10 +01003094void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3095 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003096{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003097 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3098 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003100 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003102 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3104 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003105 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003106}
Johan Pascalb62bb512015-12-03 21:56:45 +01003107#endif /* MBEDTLS_SSL_DTLS_SRTP */
3108
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303109#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003110void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003111{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003112 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00003113}
3114
Gilles Peskine449bd832023-01-11 14:50:10 +01003115void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003116{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003117 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00003118}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303119#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003120
Janos Follath088ce432017-04-10 12:42:31 +01003121#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003122void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3123 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003124{
3125 conf->cert_req_ca_list = cert_req_ca_list;
3126}
3127#endif
3128
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003130void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003131{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003132 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003133}
3134#endif
3135
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003137void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003138{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003139 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003140}
3141#endif
3142
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003143#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003144int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003145{
Gilles Peskine449bd832023-01-11 14:50:10 +01003146 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3147 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3148 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003149 }
3150
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003151 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003152
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003154}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003155#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003156
Gilles Peskine449bd832023-01-11 14:50:10 +01003157void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003158{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003159 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003160}
3161
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003162#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003163void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003164{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003165 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003166}
3167
Gilles Peskine449bd832023-01-11 14:50:10 +01003168void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003169{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003170 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003171}
3172
Gilles Peskine449bd832023-01-11 14:50:10 +01003173void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3174 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003175{
Gilles Peskine449bd832023-01-11 14:50:10 +01003176 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003177}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003178#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003180#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003181#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003182void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003183{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003184 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003185}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003186#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003187
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003188#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003189
Jerry Yud0766ec2022-09-22 10:46:57 +08003190#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003191void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3192 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003193{
Jerry Yud0766ec2022-09-22 10:46:57 +08003194 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003195}
3196#endif
3197
Gilles Peskine449bd832023-01-11 14:50:10 +01003198void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3199 mbedtls_ssl_ticket_write_t *f_ticket_write,
3200 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3201 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003202{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003203 conf->f_ticket_write = f_ticket_write;
3204 conf->f_ticket_parse = f_ticket_parse;
3205 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003206}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003207#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003208#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3211 mbedtls_ssl_export_keys_t *f_export_keys,
3212 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003213{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003214 ssl->f_export_keys = f_export_keys;
3215 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003216}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003217
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003218#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003219void mbedtls_ssl_conf_async_private_cb(
3220 mbedtls_ssl_config *conf,
3221 mbedtls_ssl_async_sign_t *f_async_sign,
3222 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3223 mbedtls_ssl_async_resume_t *f_async_resume,
3224 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003225 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003226{
3227 conf->f_async_sign_start = f_async_sign;
3228 conf->f_async_decrypt_start = f_async_decrypt;
3229 conf->f_async_resume = f_async_resume;
3230 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003231 conf->p_async_config_data = async_config_data;
3232}
3233
Gilles Peskine449bd832023-01-11 14:50:10 +01003234void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003235{
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003237}
3238
Gilles Peskine449bd832023-01-11 14:50:10 +01003239void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003240{
Gilles Peskine449bd832023-01-11 14:50:10 +01003241 if (ssl->handshake == NULL) {
3242 return NULL;
3243 } else {
3244 return ssl->handshake->user_async_ctx;
3245 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003246}
3247
Gilles Peskine449bd832023-01-11 14:50:10 +01003248void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3249 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003250{
Gilles Peskine449bd832023-01-11 14:50:10 +01003251 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003252 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003253 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003254}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003255#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003256
Paul Bakker5121ce52009-01-03 21:22:43 +00003257/*
3258 * SSL get accessors
3259 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003260uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003261{
Gilles Peskine449bd832023-01-11 14:50:10 +01003262 if (ssl->session != NULL) {
3263 return ssl->session->verify_result;
3264 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003265
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 if (ssl->session_negotiate != NULL) {
3267 return ssl->session_negotiate->verify_result;
3268 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003269
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003271}
3272
Gilles Peskine449bd832023-01-11 14:50:10 +01003273int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003274{
Gilles Peskine449bd832023-01-11 14:50:10 +01003275 if (ssl == NULL || ssl->session == NULL) {
3276 return 0;
3277 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003278
Gilles Peskine449bd832023-01-11 14:50:10 +01003279 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003280}
3281
Gilles Peskine449bd832023-01-11 14:50:10 +01003282const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003283{
Gilles Peskine449bd832023-01-11 14:50:10 +01003284 if (ssl == NULL || ssl->session == NULL) {
3285 return NULL;
3286 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003287
Gilles Peskine449bd832023-01-11 14:50:10 +01003288 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003289}
3290
Gilles Peskine449bd832023-01-11 14:50:10 +01003291const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003292{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003293#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3295 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003296 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003298 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003300 }
3301 }
3302#endif
3303
Gilles Peskine449bd832023-01-11 14:50:10 +01003304 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003305 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003307 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003309 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003311 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003312}
3313
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003314#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003315size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003316{
David Horstmann95d516f2021-05-04 18:36:56 +01003317 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003318 size_t read_mfl;
3319
Jerry Yuddda0502022-12-01 19:43:12 +08003320#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003321 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003322 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3323 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3324 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003325 }
Jerry Yuddda0502022-12-01 19:43:12 +08003326#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003327
3328 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003329 if (ssl->session_out != NULL) {
3330 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3331 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003332 max_len = read_mfl;
3333 }
3334 }
3335
Jerry Yuddda0502022-12-01 19:43:12 +08003336 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003337 if (ssl->session_negotiate != NULL) {
3338 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3339 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003340 max_len = read_mfl;
3341 }
3342 }
3343
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003345}
3346
Gilles Peskine449bd832023-01-11 14:50:10 +01003347size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003348{
3349 size_t max_len;
3350
3351 /*
3352 * Assume mfl_code is correct since it was checked when set
3353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003354 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003355
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003356 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003357 if (ssl->session_out != NULL &&
3358 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3359 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003360 }
3361
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003362 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003363 if (ssl->session_negotiate != NULL &&
3364 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3365 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003366 }
3367
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003369}
3370#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3371
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003372#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003373size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003374{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003375 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003376 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3377 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3378 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3379 return 0;
3380 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003381
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3383 return ssl->mtu;
3384 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003385
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 if (ssl->mtu == 0) {
3387 return ssl->handshake->mtu;
3388 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003389
Gilles Peskine449bd832023-01-11 14:50:10 +01003390 return ssl->mtu < ssl->handshake->mtu ?
3391 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003392}
3393#endif /* MBEDTLS_SSL_PROTO_DTLS */
3394
Gilles Peskine449bd832023-01-11 14:50:10 +01003395int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003396{
3397 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3398
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003399#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3400 !defined(MBEDTLS_SSL_PROTO_DTLS)
3401 (void) ssl;
3402#endif
3403
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003404#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003406
Gilles Peskine449bd832023-01-11 14:50:10 +01003407 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003408 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003409 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003410#endif
3411
3412#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3414 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3415 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003416 const size_t overhead = (size_t) ret;
3417
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 if (ret < 0) {
3419 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003420 }
3421
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 if (mtu <= overhead) {
3423 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3424 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3425 }
3426
3427 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003428 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003430 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003431#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003432
Hanno Becker0defedb2018-08-10 12:35:02 +01003433#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3434 !defined(MBEDTLS_SSL_PROTO_DTLS)
3435 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003436#endif
3437
Gilles Peskine449bd832023-01-11 14:50:10 +01003438 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003439}
3440
Gilles Peskine449bd832023-01-11 14:50:10 +01003441int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003442{
3443 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3444
3445#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3446 (void) ssl;
3447#endif
3448
3449#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003450 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003451
Gilles Peskine449bd832023-01-11 14:50:10 +01003452 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003453 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003454 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003455#endif
3456
Gilles Peskine449bd832023-01-11 14:50:10 +01003457 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003458}
3459
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003460#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003461const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003462{
Gilles Peskine449bd832023-01-11 14:50:10 +01003463 if (ssl == NULL || ssl->session == NULL) {
3464 return NULL;
3465 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003466
Hanno Beckere6824572019-02-07 13:18:46 +00003467#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003468 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003469#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003470 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003471#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003472}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003473#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003474
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003475#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003476int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3477 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003478{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003479 int ret;
3480
Gilles Peskine449bd832023-01-11 14:50:10 +01003481 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003482 dst == NULL ||
3483 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003484 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3485 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003486 }
3487
Hanno Beckere810bbc2021-05-14 16:01:05 +01003488 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3489 * idempotent: Each session can only be exported once.
3490 *
3491 * (This is in preparation for TLS 1.3 support where we will
3492 * need the ability to export multiple sessions (aka tickets),
3493 * which will be achieved by calling mbedtls_ssl_get_session()
3494 * multiple times until it fails.)
3495 *
3496 * Check whether we have already exported the current session,
3497 * and fail if so.
3498 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003499 if (ssl->session->exported == 1) {
3500 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3501 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003502
Gilles Peskine449bd832023-01-11 14:50:10 +01003503 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3504 if (ret != 0) {
3505 return ret;
3506 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003507
3508 /* Remember that we've exported the session. */
3509 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003510 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003511}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003513
Paul Bakker5121ce52009-01-03 21:22:43 +00003514/*
Hanno Beckera835da52019-05-16 12:39:07 +01003515 * Define ticket header determining Mbed TLS version
3516 * and structure of the ticket.
3517 */
3518
Hanno Becker94ef3b32019-05-16 12:50:45 +01003519/*
Hanno Becker50b59662019-05-28 14:30:45 +01003520 * Define bitflag determining compile-time settings influencing
3521 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003522 */
3523
Hanno Becker50b59662019-05-28 14:30:45 +01003524#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003525#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003526#else
Hanno Becker3e088662019-05-29 11:10:18 +01003527#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003528#endif /* MBEDTLS_HAVE_TIME */
3529
3530#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003531#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003532#else
Hanno Becker3e088662019-05-29 11:10:18 +01003533#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003534#endif /* MBEDTLS_X509_CRT_PARSE_C */
3535
3536#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003537#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003538#else
Hanno Becker3e088662019-05-29 11:10:18 +01003539#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003540#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3541
3542#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003543#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003544#else
Hanno Becker3e088662019-05-29 11:10:18 +01003545#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003546#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3547
Hanno Becker94ef3b32019-05-16 12:50:45 +01003548#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003549#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003550#else
Hanno Becker3e088662019-05-29 11:10:18 +01003551#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003552#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3553
Hanno Becker94ef3b32019-05-16 12:50:45 +01003554#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3555#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3556#else
3557#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3558#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3559
Hanno Becker3e088662019-05-29 11:10:18 +01003560#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3561#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3562#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3563#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003564#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3565#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003566
Hanno Becker50b59662019-05-28 14:30:45 +01003567#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003568 ((uint16_t) ( \
3569 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3570 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3571 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3572 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3573 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3574 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3575 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003576
Hanno Beckerf8787072019-05-16 12:41:07 +01003577static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003578 MBEDTLS_VERSION_MAJOR,
3579 MBEDTLS_VERSION_MINOR,
3580 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003581 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3582 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003583};
Hanno Beckera835da52019-05-16 12:39:07 +01003584
3585/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003586 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003587 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003588 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003589 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003590 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003591 * opaque mbedtls_version[3]; // library version: major, minor, patch
3592 * opaque session_format[2]; // library-version specific 16-bit field
3593 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003594 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003595 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003596 * Note: When updating the format, remember to keep
3597 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003598 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003599 * // In this version, `session_format` determines
3600 * // the setting of those compile-time
3601 * // configuration options which influence
3602 * // the structure of mbedtls_ssl_session.
3603 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003604 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003605 * // - TLS 1.2 (0x0303)
3606 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003607 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003608 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003609 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003610 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003611 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003612 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003613 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003614 *
3615 * };
3616 *
3617 * } serialized_session;
3618 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003619 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003620
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003621MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003622static int ssl_session_save(const mbedtls_ssl_session *session,
3623 unsigned char omit_header,
3624 unsigned char *buf,
3625 size_t buf_len,
3626 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003627{
3628 unsigned char *p = buf;
3629 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003630 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003631#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3632 size_t out_len;
3633 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3634#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003635 if (session == NULL) {
3636 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3637 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003638
Gilles Peskine449bd832023-01-11 14:50:10 +01003639 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003640 /*
3641 * Add Mbed TLS version identifier
3642 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003643 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003644
Gilles Peskine449bd832023-01-11 14:50:10 +01003645 if (used <= buf_len) {
3646 memcpy(p, ssl_serialized_session_header,
3647 sizeof(ssl_serialized_session_header));
3648 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003649 }
3650 }
3651
3652 /*
3653 * TLS version identifier
3654 */
3655 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003656 if (used <= buf_len) {
3657 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003658 }
3659
3660 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003661 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003662 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003663#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003664 case MBEDTLS_SSL_VERSION_TLS1_2:
3665 used += ssl_tls12_session_save(session, p, remaining_len);
3666 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003667#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3668
Jerry Yu251a12e2022-07-13 15:15:48 +08003669#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003670 case MBEDTLS_SSL_VERSION_TLS1_3:
3671 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3672 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3673 return ret;
3674 }
3675 used += out_len;
3676 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003677#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3678
Gilles Peskine449bd832023-01-11 14:50:10 +01003679 default:
3680 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003681 }
3682
3683 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003684 if (used > buf_len) {
3685 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3686 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003687
Gilles Peskine449bd832023-01-11 14:50:10 +01003688 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003689}
3690
3691/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003692 * Public wrapper for ssl_session_save()
3693 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003694int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3695 unsigned char *buf,
3696 size_t buf_len,
3697 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003698{
Gilles Peskine449bd832023-01-11 14:50:10 +01003699 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003700}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003701
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003702/*
3703 * Deserialize session, see mbedtls_ssl_session_save() for format.
3704 *
3705 * This internal version is wrapped by a public function that cleans up in
3706 * case of error, and has an extra option omit_header.
3707 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003708MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003709static int ssl_session_load(mbedtls_ssl_session *session,
3710 unsigned char omit_header,
3711 const unsigned char *buf,
3712 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003713{
3714 const unsigned char *p = buf;
3715 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003716 size_t remaining_len;
3717
3718
Gilles Peskine449bd832023-01-11 14:50:10 +01003719 if (session == NULL) {
3720 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3721 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003722
Gilles Peskine449bd832023-01-11 14:50:10 +01003723 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003724 /*
3725 * Check Mbed TLS version identifier
3726 */
3727
Gilles Peskine449bd832023-01-11 14:50:10 +01003728 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3729 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003730 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003731
3732 if (memcmp(p, ssl_serialized_session_header,
3733 sizeof(ssl_serialized_session_header)) != 0) {
3734 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3735 }
3736 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003737 }
3738
3739 /*
3740 * TLS version identifier
3741 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003742 if (1 > (size_t) (end - p)) {
3743 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3744 }
Glenn Straussda7851c2022-03-14 13:29:48 -04003745 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003746
3747 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003748 remaining_len = (end - p);
3749 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003750#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003751 case MBEDTLS_SSL_VERSION_TLS1_2:
3752 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003753#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3754
Jerry Yu438ddd82022-07-07 06:55:50 +00003755#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003756 case MBEDTLS_SSL_VERSION_TLS1_3:
3757 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003758#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3759
Gilles Peskine449bd832023-01-11 14:50:10 +01003760 default:
3761 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003762 }
3763}
3764
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003765/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003766 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003767 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003768int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3769 const unsigned char *buf,
3770 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003771{
Gilles Peskine449bd832023-01-11 14:50:10 +01003772 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003773
Gilles Peskine449bd832023-01-11 14:50:10 +01003774 if (ret != 0) {
3775 mbedtls_ssl_session_free(session);
3776 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003777
Gilles Peskine449bd832023-01-11 14:50:10 +01003778 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003779}
3780
3781/*
Paul Bakker1961b702013-01-25 14:49:24 +01003782 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003783 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003784MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003785static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003786{
3787 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3788
Ronald Cron66dbf912022-02-02 15:33:46 +01003789 /*
3790 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003791 * that were written into the output buffer by the previous handshake step,
3792 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003793 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3794 * We proceed to the next handshake step only when all data from the
3795 * previous one have been sent to the peer, thus we make sure that this is
3796 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3797 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3798 * we have to wait before to go ahead.
3799 * In the case of TLS 1.3, handshake step handlers do not send data to the
3800 * peer. Data are only sent here and through
3801 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003802 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003803 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003804 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3805 return ret;
3806 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003807
3808#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003809 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3810 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3811 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3812 return ret;
3813 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003814 }
3815#endif /* MBEDTLS_SSL_PROTO_DTLS */
3816
Gilles Peskine449bd832023-01-11 14:50:10 +01003817 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003818}
3819
Gilles Peskine449bd832023-01-11 14:50:10 +01003820int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003821{
Hanno Becker41934dd2021-08-07 19:13:43 +01003822 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003823
Gilles Peskine449bd832023-01-11 14:50:10 +01003824 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003825 ssl->conf == NULL ||
3826 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003827 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3828 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003829 }
3830
Gilles Peskine449bd832023-01-11 14:50:10 +01003831 ret = ssl_prepare_handshake_step(ssl);
3832 if (ret != 0) {
3833 return ret;
3834 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003835
Gilles Peskine449bd832023-01-11 14:50:10 +01003836 ret = mbedtls_ssl_handle_pending_alert(ssl);
3837 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003838 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003839 }
Jerry Yue7047812021-09-13 19:26:39 +08003840
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003841 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3842 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3843 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3844
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003845#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003846 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3847 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
3848 mbedtls_ssl_states_str(ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003849
Gilles Peskine449bd832023-01-11 14:50:10 +01003850 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003851 case MBEDTLS_SSL_HELLO_REQUEST:
3852 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003853 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003854 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003855
Ronald Cron9f0fba32022-02-10 16:45:15 +01003856 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003857 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003858 break;
3859
3860 default:
3861#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003862 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3863 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3864 } else {
3865 ret = mbedtls_ssl_handshake_client_step(ssl);
3866 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003867#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003868 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003869#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003870 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003871#endif
3872 }
Jerry Yub9930e72021-08-06 17:11:51 +08003873 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003874#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003875#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003876 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6f135e12021-12-08 16:57:54 +01003877#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003878 if (mbedtls_ssl_conf_is_tls13_only(ssl->conf)) {
3879 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
3880 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003881#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003882
3883#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003884 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf)) {
3885 ret = mbedtls_ssl_handshake_server_step(ssl);
3886 }
Jerry Yub9930e72021-08-06 17:11:51 +08003887#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3888 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003889#endif
3890
Gilles Peskine449bd832023-01-11 14:50:10 +01003891 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003892 /* handshake_step return error. And it is same
3893 * with alert_reason.
3894 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003895 if (ssl->send_alert) {
3896 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003897 goto cleanup;
3898 }
3899 }
3900
3901cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003902 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003903}
3904
3905/*
3906 * Perform the SSL handshake
3907 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003908int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003909{
3910 int ret = 0;
3911
Hanno Beckera817ea42020-10-20 15:20:23 +01003912 /* Sanity checks */
3913
Gilles Peskine449bd832023-01-11 14:50:10 +01003914 if (ssl == NULL || ssl->conf == NULL) {
3915 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3916 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003917
Hanno Beckera817ea42020-10-20 15:20:23 +01003918#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003919 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3920 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3921 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3922 "mbedtls_ssl_set_timer_cb() for DTLS"));
3923 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003924 }
3925#endif /* MBEDTLS_SSL_PROTO_DTLS */
3926
Gilles Peskine449bd832023-01-11 14:50:10 +01003927 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003928
Hanno Beckera817ea42020-10-20 15:20:23 +01003929 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003930 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3931 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003932
Gilles Peskine449bd832023-01-11 14:50:10 +01003933 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003934 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003935 }
Paul Bakker1961b702013-01-25 14:49:24 +01003936 }
3937
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003939
Gilles Peskine449bd832023-01-11 14:50:10 +01003940 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003941}
3942
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003943#if defined(MBEDTLS_SSL_RENEGOTIATION)
3944#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003945/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003946 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003947 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003948MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003949static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003950{
Janos Follath865b3eb2019-12-16 11:46:15 +00003951 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003952
Gilles Peskine449bd832023-01-11 14:50:10 +01003953 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003954
3955 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003956 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3957 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003958
Gilles Peskine449bd832023-01-11 14:50:10 +01003959 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3960 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3961 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003962 }
3963
Gilles Peskine449bd832023-01-11 14:50:10 +01003964 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003965
Gilles Peskine449bd832023-01-11 14:50:10 +01003966 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003967}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003968#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003969
3970/*
3971 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003972 * - any side: calling mbedtls_ssl_renegotiate(),
3973 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3974 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003975 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003976 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003977 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003978 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003979int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003980{
Janos Follath865b3eb2019-12-16 11:46:15 +00003981 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003982
Gilles Peskine449bd832023-01-11 14:50:10 +01003983 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00003984
Gilles Peskine449bd832023-01-11 14:50:10 +01003985 if ((ret = ssl_handshake_init(ssl)) != 0) {
3986 return ret;
3987 }
Paul Bakker48916f92012-09-16 19:57:18 +00003988
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003989 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3990 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003991#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003992 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3993 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
3994 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003995 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003997 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003998 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003999 }
4000#endif
4001
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004002 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4003 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004004
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4006 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4007 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004008 }
4009
Gilles Peskine449bd832023-01-11 14:50:10 +01004010 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004011
Gilles Peskine449bd832023-01-11 14:50:10 +01004012 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004013}
4014
4015/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004016 * Renegotiate current connection on client,
4017 * or request renegotiation on server
4018 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004019int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004020{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004021 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004022
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 if (ssl == NULL || ssl->conf == NULL) {
4024 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4025 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004027#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004028 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4030 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4031 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4032 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004033
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004034 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004035
4036 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 if (ssl->out_left != 0) {
4038 return mbedtls_ssl_flush_output(ssl);
4039 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004040
Gilles Peskine449bd832023-01-11 14:50:10 +01004041 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004042 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004043#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004044
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004045#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004046 /*
4047 * On client, either start the renegotiation process or,
4048 * if already in progress, continue the handshake
4049 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4051 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004053 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004054
4055 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4056 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4057 return ret;
4058 }
4059 } else {
4060 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4061 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4062 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004063 }
4064 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004065#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004066
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004068}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004069#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004070
Gilles Peskine449bd832023-01-11 14:50:10 +01004071void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004072{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004073 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4074
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004076 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004077 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004078
Brett Warrene0edc842021-08-17 09:53:13 +01004079#if defined(MBEDTLS_ECP_C)
4080#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 if (ssl->handshake->group_list_heap_allocated) {
4082 mbedtls_free((void *) handshake->group_list);
4083 }
Brett Warrene0edc842021-08-17 09:53:13 +01004084 handshake->group_list = NULL;
4085#endif /* MBEDTLS_DEPRECATED_REMOVED */
4086#endif /* MBEDTLS_ECP_C */
4087
Ronald Crone68ab4f2022-10-05 12:46:29 +02004088#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004089#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004090 if (ssl->handshake->sig_algs_heap_allocated) {
4091 mbedtls_free((void *) handshake->sig_algs);
4092 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004093 handshake->sig_algs = NULL;
4094#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004095#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 if (ssl->handshake->certificate_request_context) {
4097 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004098 }
4099#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004100#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004101
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004102#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4104 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004105 handshake->async_in_progress = 0;
4106 }
4107#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4108
Andrzej Kurek25f27152022-08-17 16:09:31 -04004109#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004110#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004112#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004113 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004114#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004115#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004116#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004117#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004118 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004119#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004120 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004121#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004122#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004124#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004125 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004126#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02004127#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004129#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004130
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004131#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004132#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004134 /*
4135 * Opaque keys are not stored in the handshake's data and it's the user
4136 * responsibility to destroy them. Clear ones, instead, are created by
4137 * the TLS library and should be destroyed at the same level
4138 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4140 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004141 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004142 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4143#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004145#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004146#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004148 handshake->ecjpake_cache = NULL;
4149 handshake->ecjpake_cache_len = 0;
4150#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004151#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004152
Janos Follath4ae5c292016-02-10 11:27:43 +00004153#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4154 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004155 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004157#endif
4158
Ronald Cron73fe8df2022-10-05 14:31:43 +02004159#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004160#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004162 /* The maintenance of the external PSK key slot is the
4163 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 if (ssl->handshake->psk_opaque_is_internal) {
4165 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004166 ssl->handshake->psk_opaque_is_internal = 0;
4167 }
4168 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4169 }
Neil Armstronge952a302022-05-03 10:22:14 +02004170#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 if (handshake->psk != NULL) {
4172 mbedtls_platform_zeroize(handshake->psk, handshake->psk_len);
4173 mbedtls_free(handshake->psk);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004174 }
Neil Armstronge952a302022-05-03 10:22:14 +02004175#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004176#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004178#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4179 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004180 /*
4181 * Free only the linked list wrapper, not the keys themselves
4182 * since the belong to the SNI callback
4183 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004184 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004185#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004186
Gilles Peskineeccd8882020-03-10 12:19:08 +01004187#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004188 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4189 if (handshake->ecrs_peer_cert != NULL) {
4190 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4191 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004192 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004193#endif
4194
Hanno Becker75173122019-02-06 16:18:31 +00004195#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4196 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004198#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4199
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004200#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4202 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004203#endif /* MBEDTLS_SSL_CLI_C &&
4204 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004205
4206#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 mbedtls_ssl_flight_free(handshake->flight);
4208 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004209#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004210
Ronald Cronf12b81d2022-03-15 10:42:41 +01004211#if defined(MBEDTLS_ECDH_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 (defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4213 if (handshake->ecdh_psa_privkey_is_external == 0) {
4214 psa_destroy_key(handshake->ecdh_psa_privkey);
4215 }
Hanno Becker4a63ed42019-01-08 11:39:35 +00004216#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
4217
Ronald Cron6f135e12021-12-08 16:57:54 +01004218#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 mbedtls_ssl_transform_free(handshake->transform_handshake);
4220 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004221#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4223 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004224#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004225#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004226
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004227
4228#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4229 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4230 * processes datagrams and the fact that a datagram is allowed to have
4231 * several records in it, it is possible that the I/O buffers are not
4232 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4234 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004235#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004236
Jerry Yuba9c7272021-10-30 11:54:10 +08004237 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 mbedtls_platform_zeroize(handshake,
4239 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004240}
4241
Gilles Peskine449bd832023-01-11 14:50:10 +01004242void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004243{
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004245 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004247
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004248#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004250#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004251
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004252#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004253#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4254 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004256#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004258#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004259
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004261}
4262
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004263#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004264
4265#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4266#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4267#else
4268#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4269#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4270
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004271#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004272
4273#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4274#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4275#else
4276#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4277#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4278
4279#if defined(MBEDTLS_SSL_ALPN)
4280#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4281#else
4282#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4283#endif /* MBEDTLS_SSL_ALPN */
4284
4285#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4286#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4287#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4288#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4289
4290#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 ((uint32_t) ( \
4292 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4293 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4294 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4295 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4296 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4297 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4298 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4299 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004300
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004301static unsigned char ssl_serialized_context_header[] = {
4302 MBEDTLS_VERSION_MAJOR,
4303 MBEDTLS_VERSION_MINOR,
4304 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4306 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4307 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4308 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4309 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004310};
4311
Paul Bakker5121ce52009-01-03 21:22:43 +00004312/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004313 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004314 *
4315 * The format of the serialized data is:
4316 * (in the presentation language of TLS, RFC 8446 section 3)
4317 *
4318 * // header
4319 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004320 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004321 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004322 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004323 * Note: When updating the format, remember to keep these
4324 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004325 *
4326 * // session sub-structure
4327 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4328 * // transform sub-structure
4329 * uint8 random[64]; // ServerHello.random+ClientHello.random
4330 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4331 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4332 * // fields from ssl_context
4333 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4334 * uint64 in_window_top; // DTLS: last validated record seq_num
4335 * uint64 in_window; // DTLS: bitmask for replay protection
4336 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4337 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4338 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4339 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4340 *
4341 * Note that many fields of the ssl_context or sub-structures are not
4342 * serialized, as they fall in one of the following categories:
4343 *
4344 * 1. forced value (eg in_left must be 0)
4345 * 2. pointer to dynamically-allocated memory (eg session, transform)
4346 * 3. value can be re-derived from other data (eg session keys from MS)
4347 * 4. value was temporary (eg content of input buffer)
4348 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004349 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004350int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4351 unsigned char *buf,
4352 size_t buf_len,
4353 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004354{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004355 unsigned char *p = buf;
4356 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004357 size_t session_len;
4358 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004359
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004360 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004361 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4362 * this function's documentation.
4363 *
4364 * These are due to assumptions/limitations in the implementation. Some of
4365 * them are likely to stay (no handshake in progress) some might go away
4366 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004367 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004368 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4370 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4371 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004372 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 if (ssl->handshake != NULL) {
4374 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4375 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004376 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004377 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 if (ssl->transform == NULL || ssl->session == NULL) {
4379 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
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 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (mbedtls_ssl_check_pending(ssl) != 0) {
4384 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4385 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004386 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 if (ssl->out_left != 0) {
4388 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4389 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004390 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004391 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4393 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4394 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004395 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004396 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4398 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 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 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4403 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites 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 /* Renegotiation must not be enabled */
4407#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4409 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4410 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004411 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004412#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004413
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004414 /*
4415 * Version and format identifier
4416 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004418
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 if (used <= buf_len) {
4420 memcpy(p, ssl_serialized_context_header,
4421 sizeof(ssl_serialized_context_header));
4422 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004423 }
4424
4425 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004426 * Session (length + data)
4427 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4429 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4430 return ret;
4431 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004432
4433 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 if (used <= buf_len) {
4435 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004436 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004437
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 ret = ssl_session_save(ssl->session, 1,
4439 p, session_len, &session_len);
4440 if (ret != 0) {
4441 return ret;
4442 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004443
4444 p += session_len;
4445 }
4446
4447 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004448 * Transform
4449 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 used += sizeof(ssl->transform->randbytes);
4451 if (used <= buf_len) {
4452 memcpy(p, ssl->transform->randbytes,
4453 sizeof(ssl->transform->randbytes));
4454 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004455 }
4456
4457#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4458 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004460 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004462 p += ssl->transform->in_cid_len;
4463
4464 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004466 p += ssl->transform->out_cid_len;
4467 }
4468#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4469
4470 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004471 * Saved fields from top-level ssl_context structure
4472 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004473 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 if (used <= buf_len) {
4475 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004476 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004477 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004478
4479#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4480 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 if (used <= buf_len) {
4482 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004483 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004484
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004486 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004487 }
4488#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4489
4490#if defined(MBEDTLS_SSL_PROTO_DTLS)
4491 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004493 *p++ = ssl->disable_datagram_packing;
4494 }
4495#endif /* MBEDTLS_SSL_PROTO_DTLS */
4496
Jerry Yuae0b2e22021-10-08 15:21:19 +08004497 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 if (used <= buf_len) {
4499 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004500 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004501 }
4502
4503#if defined(MBEDTLS_SSL_PROTO_DTLS)
4504 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 if (used <= buf_len) {
4506 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004507 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004508 }
4509#endif /* MBEDTLS_SSL_PROTO_DTLS */
4510
4511#if defined(MBEDTLS_SSL_ALPN)
4512 {
4513 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004515 : 0;
4516
4517 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004519 *p++ = alpn_len;
4520
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 if (ssl->alpn_chosen != NULL) {
4522 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004523 p += alpn_len;
4524 }
4525 }
4526 }
4527#endif /* MBEDTLS_SSL_ALPN */
4528
4529 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004530 * Done
4531 */
4532 *olen = used;
4533
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 if (used > buf_len) {
4535 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4536 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004537
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004539
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004541}
4542
4543/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004544 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004545 *
4546 * This internal version is wrapped by a public function that cleans up in
4547 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004548 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004549MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004550static int ssl_context_load(mbedtls_ssl_context *ssl,
4551 const unsigned char *buf,
4552 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004553{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004554 const unsigned char *p = buf;
4555 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004556 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004557 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004558#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004559 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004560#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004561
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004562 /*
4563 * The context should have been freshly setup or reset.
4564 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004565 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004566 * renegotiating, or if the user mistakenly loaded a session first.)
4567 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4569 ssl->session != NULL) {
4570 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004571 }
4572
4573 /*
4574 * We can't check that the config matches the initial one, but we can at
4575 * least check it matches the requirements for serializing.
4576 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004578 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4579 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004580#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004581 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004582#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 0) {
4584 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004585 }
4586
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004588
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004589 /*
4590 * Check version identifier
4591 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4593 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004594 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004595
4596 if (memcmp(p, ssl_serialized_context_header,
4597 sizeof(ssl_serialized_context_header)) != 0) {
4598 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4599 }
4600 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004601
4602 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004603 * Session
4604 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 if ((size_t) (end - p) < 4) {
4606 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4607 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004608
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 session_len = ((size_t) p[0] << 24) |
4610 ((size_t) p[1] << 16) |
4611 ((size_t) p[2] << 8) |
4612 ((size_t) p[3]);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004613 p += 4;
4614
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004615 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004616 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004617 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004618 ssl->session_in = ssl->session;
4619 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004620 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004621
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 if ((size_t) (end - p) < session_len) {
4623 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4624 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004625
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 ret = ssl_session_load(ssl->session, 1, p, session_len);
4627 if (ret != 0) {
4628 mbedtls_ssl_session_free(ssl->session);
4629 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004630 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004631
4632 p += session_len;
4633
4634 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004635 * Transform
4636 */
4637
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004638 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004639 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004640#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004641 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004642 ssl->transform_in = ssl->transform;
4643 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004644 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004645#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004646
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004647#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4649 if (prf_func == NULL) {
4650 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4651 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004652
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004653 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4655 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4656 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004657
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 ret = ssl_tls12_populate_transform(ssl->transform,
4659 ssl->session->ciphersuite,
4660 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004661#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004663#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 prf_func,
4665 p, /* currently pointing to randbytes */
4666 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4667 ssl->conf->endpoint,
4668 ssl);
4669 if (ret != 0) {
4670 return ret;
4671 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004672#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004674
4675#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4676 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 if ((size_t) (end - p) < 1) {
4678 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4679 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004680
4681 ssl->transform->in_cid_len = *p++;
4682
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4684 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4685 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004688 p += ssl->transform->in_cid_len;
4689
4690 ssl->transform->out_cid_len = *p++;
4691
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4693 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4694 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004695
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004697 p += ssl->transform->out_cid_len;
4698#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4699
4700 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004701 * Saved fields from top-level ssl_context structure
4702 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 if ((size_t) (end - p) < 4) {
4704 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4705 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 ssl->badmac_seen = ((uint32_t) p[0] << 24) |
4708 ((uint32_t) p[1] << 16) |
4709 ((uint32_t) p[2] << 8) |
4710 ((uint32_t) p[3]);
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
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 ssl->in_window_top = ((uint64_t) p[0] << 56) |
4719 ((uint64_t) p[1] << 48) |
4720 ((uint64_t) p[2] << 40) |
4721 ((uint64_t) p[3] << 32) |
4722 ((uint64_t) p[4] << 24) |
4723 ((uint64_t) p[5] << 16) |
4724 ((uint64_t) p[6] << 8) |
4725 ((uint64_t) p[7]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004726 p += 8;
4727
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 ssl->in_window = ((uint64_t) p[0] << 56) |
4729 ((uint64_t) p[1] << 48) |
4730 ((uint64_t) p[2] << 40) |
4731 ((uint64_t) p[3] << 32) |
4732 ((uint64_t) p[4] << 24) |
4733 ((uint64_t) p[5] << 16) |
4734 ((uint64_t) p[6] << 8) |
4735 ((uint64_t) p[7]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004736 p += 8;
4737#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4738
4739#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 if ((size_t) (end - p) < 1) {
4741 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4742 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004743
4744 ssl->disable_datagram_packing = *p++;
4745#endif /* MBEDTLS_SSL_PROTO_DTLS */
4746
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4748 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4749 }
4750 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4751 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004752
4753#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 if ((size_t) (end - p) < 2) {
4755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4756 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004757
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004759 p += 2;
4760#endif /* MBEDTLS_SSL_PROTO_DTLS */
4761
4762#if defined(MBEDTLS_SSL_ALPN)
4763 {
4764 uint8_t alpn_len;
4765 const char **cur;
4766
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 if ((size_t) (end - p) < 1) {
4768 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4769 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004770
4771 alpn_len = *p++;
4772
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004774 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4776 if (strlen(*cur) == alpn_len &&
4777 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004778 ssl->alpn_chosen = *cur;
4779 break;
4780 }
4781 }
4782 }
4783
4784 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4786 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4787 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004788
4789 p += alpn_len;
4790 }
4791#endif /* MBEDTLS_SSL_ALPN */
4792
4793 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004794 * Forced fields from top-level ssl_context structure
4795 *
4796 * Most of them already set to the correct value by mbedtls_ssl_init() and
4797 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4798 */
4799 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004800 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004801
Hanno Becker361b10d2019-08-30 10:42:49 +01004802 /* Adjust pointers for header fields of outgoing records to
4803 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004805
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004806#if defined(MBEDTLS_SSL_PROTO_DTLS)
4807 ssl->in_epoch = 1;
4808#endif
4809
4810 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4811 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004812 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4813 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 if (ssl->handshake != NULL) {
4815 mbedtls_ssl_handshake_free(ssl);
4816 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004817 ssl->handshake = NULL;
4818 }
4819
4820 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004821 * Done - should have consumed entire buffer
4822 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 if (p != end) {
4824 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4825 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004826
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004828}
4829
4830/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004831 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004832 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004833int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4834 const unsigned char *buf,
4835 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004836{
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004838
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 if (ret != 0) {
4840 mbedtls_ssl_free(context);
4841 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004842
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004844}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004845#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004846
4847/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004848 * Free an SSL context
4849 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004850void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004851{
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004853 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004855
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004857
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004859#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4860 size_t out_buf_len = ssl->out_buf_len;
4861#else
4862 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4863#endif
4864
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 mbedtls_platform_zeroize(ssl->out_buf, out_buf_len);
4866 mbedtls_free(ssl->out_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004867 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004868 }
4869
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004871#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4872 size_t in_buf_len = ssl->in_buf_len;
4873#else
4874 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4875#endif
4876
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 mbedtls_platform_zeroize(ssl->in_buf, in_buf_len);
4878 mbedtls_free(ssl->in_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004879 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004880 }
4881
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 if (ssl->transform) {
4883 mbedtls_ssl_transform_free(ssl->transform);
4884 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004885 }
4886
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 if (ssl->handshake) {
4888 mbedtls_ssl_handshake_free(ssl);
4889 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004890
4891#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4893 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004894#endif
4895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 mbedtls_ssl_session_free(ssl->session_negotiate);
4897 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004898 }
4899
Ronald Cron6f135e12021-12-08 16:57:54 +01004900#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 mbedtls_ssl_transform_free(ssl->transform_application);
4902 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004903#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004904
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 if (ssl->session) {
4906 mbedtls_ssl_session_free(ssl->session);
4907 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004908 }
4909
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004910#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 if (ssl->hostname != NULL) {
4912 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
4913 mbedtls_free(ssl->hostname);
Paul Bakker5121ce52009-01-03 21:22:43 +00004914 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004915#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004916
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004917#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004919#endif
4920
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004922
Paul Bakker86f04f42013-02-14 11:20:09 +01004923 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004925}
4926
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004927/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004928 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004929 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004930void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004931{
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004933}
4934
Gilles Peskineae270bf2021-06-02 00:05:29 +02004935/* The selection should be the same as mbedtls_x509_crt_profile_default in
4936 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004937 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004938 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004939 * about this list.
4940 */
Brett Warrene0edc842021-08-17 09:53:13 +01004941static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004942#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004943 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004944#endif
4945#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004946 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004947#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004948#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004949 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004950#endif
4951#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004952 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004953#endif
4954#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004955 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004956#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004957#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004958 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004959#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004960#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004961 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004962#endif
4963#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004964 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004965#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004966 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004967};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004968
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004969static int ssl_preset_suiteb_ciphersuites[] = {
4970 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4971 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4972 0
4973};
4974
Ronald Crone68ab4f2022-10-05 12:46:29 +02004975#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004976
Jerry Yu909df7b2022-01-22 11:56:27 +08004977/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004978 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004979 * rules SHOULD be upheld.
4980 * - No duplicate entries.
4981 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004982 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004983 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004984 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004985static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004986
Valerio Setti75fba322023-02-23 17:35:09 +01004987#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
4988 defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004989 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4990 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Valerio Setti75fba322023-02-23 17:35:09 +01004991#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA &&
Jerry Yued5e9f42022-01-26 11:21:34 +08004992 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004993
Valerio Setti75fba322023-02-23 17:35:09 +01004994#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
4995 defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08004996 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4997 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Valerio Setti75fba322023-02-23 17:35:09 +01004998#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004999 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
5000
Valerio Setti75fba322023-02-23 17:35:09 +01005001#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
5002 defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08005003 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
5004 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Valerio Setti75fba322023-02-23 17:35:09 +01005005#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yued5e9f42022-01-26 11:21:34 +08005006 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005007
Gilles Peskine449bd832023-01-11 14:50:10 +01005008#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
5009 defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005010 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005011#endif \
5012 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005013
Gilles Peskine449bd832023-01-11 14:50:10 +01005014#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
5015 defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005016 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005017#endif \
5018 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005019
Gilles Peskine449bd832023-01-11 14:50:10 +01005020#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
5021 defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005022 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005023#endif \
5024 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005025
Andrzej Kurek25f27152022-08-17 16:09:31 -04005026#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu693a47a2022-06-23 14:02:28 +08005027 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
5028#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
5029
Andrzej Kurek25f27152022-08-17 16:09:31 -04005030#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu693a47a2022-06-23 14:02:28 +08005031 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
5032#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
5033
Andrzej Kurek25f27152022-08-17 16:09:31 -04005034#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu693a47a2022-06-23 14:02:28 +08005035 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
5036#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
5037
Gabor Mezei15b95a62022-05-09 16:37:58 +02005038 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005039};
5040
5041/* NOTICE: see above */
5042#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5043static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005044#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Valerio Setti75fba322023-02-23 17:35:09 +01005045#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005047#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005048#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5049 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5050#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005051#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005053#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005054#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04005055#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Valerio Setti75fba322023-02-23 17:35:09 +01005056#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005058#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005059#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5060 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5061#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005062#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005064#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005065#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04005066#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Valerio Setti75fba322023-02-23 17:35:09 +01005067#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005069#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005070#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5071 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5072#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005073#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005074 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005075#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005076#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005077 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005078};
5079#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5080/* NOTICE: see above */
5081static uint16_t ssl_preset_suiteb_sig_algs[] = {
5082
Andrzej Kurek25f27152022-08-17 16:09:31 -04005083#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08005084 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5085 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005086#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08005087 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
5088
Andrzej Kurek25f27152022-08-17 16:09:31 -04005089#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yu53037892022-01-25 11:02:06 +08005090 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5091 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005092#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu53037892022-01-25 11:02:06 +08005093 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005094
Gilles Peskine449bd832023-01-11 14:50:10 +01005095#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
5096 defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu909df7b2022-01-22 11:56:27 +08005097 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005098#endif \
5099 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005100
Andrzej Kurek25f27152022-08-17 16:09:31 -04005101#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu53037892022-01-25 11:02:06 +08005102 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005103#endif /* MBEDTLS_RSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu53037892022-01-25 11:02:06 +08005104
Gabor Mezei15b95a62022-05-09 16:37:58 +02005105 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005106};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005107
Jerry Yu909df7b2022-01-22 11:56:27 +08005108/* NOTICE: see above */
5109#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5110static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005111#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005112#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +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_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005117#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005118#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04005119#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005120#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005122#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005123#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005125#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005126#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005127 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005128};
Jerry Yu909df7b2022-01-22 11:56:27 +08005129#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5130
Ronald Crone68ab4f2022-10-05 12:46:29 +02005131#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005132
Brett Warrene0edc842021-08-17 09:53:13 +01005133static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01005134#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005135 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005136#endif
5137#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005138 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005139#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005140 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005141};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005142
Ronald Crone68ab4f2022-10-05 12:46:29 +02005143#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005144/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005145 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005146MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005147static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005148{
5149 size_t i, j;
5150 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005151
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5153 for (j = 0; j < i; j++) {
5154 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005155 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 }
5157 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5158 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5159 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005160 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005161 }
5162 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005164}
5165
Ronald Crone68ab4f2022-10-05 12:46:29 +02005166#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005167
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005168/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005169 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005170 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005171int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5172 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005173{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005174#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005175 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005176#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005177
Ronald Crone68ab4f2022-10-05 12:46:29 +02005178#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5180 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5181 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005182 }
5183
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5185 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5186 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005187 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005188
5189#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5191 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5192 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005193 }
5194
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5196 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5197 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005198 }
5199#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005200#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005201
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005202 /* Use the functions here so that they are covered in tests,
5203 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 mbedtls_ssl_conf_endpoint(conf, endpoint);
5205 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005206
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005207 /*
5208 * Things that are common to all presets
5209 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005210#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005212 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5213#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5214 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5215#endif
5216 }
5217#endif
5218
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005219#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5220 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5221#endif
5222
5223#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5224 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5225#endif
5226
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005227#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005228 conf->f_cookie_write = ssl_cookie_write_dummy;
5229 conf->f_cookie_check = ssl_cookie_check_dummy;
5230#endif
5231
5232#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5233 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5234#endif
5235
Janos Follath088ce432017-04-10 12:42:31 +01005236#if defined(MBEDTLS_SSL_SRV_C)
5237 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005238 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005239#endif
5240
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005241#if defined(MBEDTLS_SSL_PROTO_DTLS)
5242 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5243 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5244#endif
5245
5246#if defined(MBEDTLS_SSL_RENEGOTIATION)
5247 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 memset(conf->renego_period, 0x00, 2);
5249 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005250#endif
5251
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005252#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005254 const unsigned char dhm_p[] =
5255 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5256 const unsigned char dhm_g[] =
5257 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005258
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5260 dhm_p, sizeof(dhm_p),
5261 dhm_g, sizeof(dhm_g))) != 0) {
5262 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005263 }
5264 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005265#endif
5266
Ronald Cron6f135e12021-12-08 16:57:54 +01005267#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005268
5269#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 mbedtls_ssl_tls13_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005271#if defined(MBEDTLS_SSL_SRV_C)
5272 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005274#endif
5275#endif /* MBEDTLS_SSL_EARLY_DATA */
5276
Jerry Yud0766ec2022-09-22 10:46:57 +08005277#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005278 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005280#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005281 /*
5282 * Allow all TLS 1.3 key exchange modes by default.
5283 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005284 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005285#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005286
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005288#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005289 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005290 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005291#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005293#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005295#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005296 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005297 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5298 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 } else {
5300 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
XiaokangQian4d3a6042022-04-21 13:46:17 +00005301 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5302 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5303 }
5304#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5305 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5306 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5307#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5308 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5309 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5310#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005312#endif
5313 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005314
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005315 /*
5316 * Preset-specific defaults
5317 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005319 /*
5320 * NSA Suite B
5321 */
5322 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005323
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005324 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005325
5326#if defined(MBEDTLS_X509_CRT_PARSE_C)
5327 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005328#endif
5329
Ronald Crone68ab4f2022-10-05 12:46:29 +02005330#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005331#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005333 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005335#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005337#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005338
Brett Warrene0edc842021-08-17 09:53:13 +01005339#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5340 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005341#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005342 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005343 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005344
5345 /*
5346 * Default
5347 */
5348 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005349
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005350 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005351
5352#if defined(MBEDTLS_X509_CRT_PARSE_C)
5353 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5354#endif
5355
Ronald Crone68ab4f2022-10-05 12:46:29 +02005356#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005357#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005359 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005361#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005363#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005364
Brett Warrene0edc842021-08-17 09:53:13 +01005365#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5366 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005367#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005368 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005369
5370#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5371 conf->dhm_min_bitlen = 1024;
5372#endif
5373 }
5374
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005376}
5377
5378/*
5379 * Free mbedtls_ssl_config
5380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005381void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005382{
5383#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 mbedtls_mpi_free(&conf->dhm_P);
5385 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005386#endif
5387
Ronald Cron73fe8df2022-10-05 14:31:43 +02005388#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005389#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005391 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5392 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005393#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 if (conf->psk != NULL) {
5395 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
5396 mbedtls_free(conf->psk);
Azim Khan27e8a122018-03-21 14:24:11 +00005397 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005398 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005399 }
5400
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 if (conf->psk_identity != NULL) {
5402 mbedtls_platform_zeroize(conf->psk_identity, conf->psk_identity_len);
5403 mbedtls_free(conf->psk_identity);
Azim Khan27e8a122018-03-21 14:24:11 +00005404 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005405 conf->psk_identity_len = 0;
5406 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005407#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005408
5409#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005411#endif
5412
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005414}
5415
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005416#if defined(MBEDTLS_PK_C) && \
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005417 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_CAN_ECDSA_SOME))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005418/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005419 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005420 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005421unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005422{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005423#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5425 return MBEDTLS_SSL_SIG_RSA;
5426 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005427#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005428#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5430 return MBEDTLS_SSL_SIG_ECDSA;
5431 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005432#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005434}
5435
Gilles Peskine449bd832023-01-11 14:50:10 +01005436unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005437{
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005439 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005441 case MBEDTLS_PK_ECDSA:
5442 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005444 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005446 }
5447}
5448
Gilles Peskine449bd832023-01-11 14:50:10 +01005449mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005450{
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005452#if defined(MBEDTLS_RSA_C)
5453 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005455#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005456#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005457 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005459#endif
5460 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005462 }
5463}
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005464#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_PK_CAN_ECDSA_SOME ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005465
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005466/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005467 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005468 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005469mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005470{
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 switch (hash) {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005472#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005473 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005475#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005476#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005477 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005479#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005480#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005481 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005483#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005484#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005485 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005487#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005488#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005489 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005491#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005492#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005493 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005495#endif
5496 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005498 }
5499}
5500
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005501/*
5502 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005504unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005505{
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 switch (md) {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005507#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005508 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005510#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005511#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005512 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005514#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005515#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005516 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005518#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005519#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005520 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005522#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005523#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005524 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005526#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005527#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005528 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005530#endif
5531 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005533 }
5534}
5535
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005536/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005537 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005538 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005539 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005540int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005541{
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005543
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 if (group_list == NULL) {
5545 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005546 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005547
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 for (; *group_list != 0; group_list++) {
5549 if (*group_list == tls_id) {
5550 return 0;
5551 }
5552 }
5553
5554 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005555}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005556
5557#if defined(MBEDTLS_ECP_C)
5558/*
5559 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5560 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005561int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005562{
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005564
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005566 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005568
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005570}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02005571#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005572
Gilles Peskine449bd832023-01-11 14:50:10 +01005573#if defined(MBEDTLS_DEBUG_C)
Valerio Setti67419f02023-01-04 16:12:42 +01005574#define EC_NAME(_name_) _name_
5575#else
5576#define EC_NAME(_name_) NULL
5577#endif
5578
Valerio Setti18c9fed2022-12-30 17:44:24 +01005579static const struct {
5580 uint16_t tls_id;
5581 mbedtls_ecp_group_id ecp_group_id;
5582 psa_ecc_family_t psa_family;
5583 uint16_t bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 const char *name;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005585} tls_id_match_table[] =
5586{
5587#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521, EC_NAME("secp521r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005589#endif
5590#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512, EC_NAME("brainpoolP512r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005592#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005593#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384, EC_NAME("secp384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005595#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005596#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384, EC_NAME("brainpoolP384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005598#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005599#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256, EC_NAME("secp256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005601#endif
5602#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256, EC_NAME("secp256k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005604#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005605#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256, EC_NAME("brainpoolP256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005607#endif
5608#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224, EC_NAME("secp224r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005610#endif
5611#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224, EC_NAME("secp224k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005613#endif
5614#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192, EC_NAME("secp192r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005616#endif
5617#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192, EC_NAME("secp192k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005619#endif
5620#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255, EC_NAME("x25519") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005622#endif
5623#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448, EC_NAME("x448") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005625#endif
5626 { 0, MBEDTLS_ECP_DP_NONE, 0, 0, NULL },
5627};
5628
Gilles Peskine449bd832023-01-11 14:50:10 +01005629int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
5630 psa_ecc_family_t *family,
5631 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005632{
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5634 if (tls_id_match_table[i].tls_id == tls_id) {
5635 if (family != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005636 *family = tls_id_match_table[i].psa_family;
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 }
5638 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005639 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005641 return PSA_SUCCESS;
5642 }
5643 }
5644
5645 return PSA_ERROR_NOT_SUPPORTED;
5646}
5647
Gilles Peskine449bd832023-01-11 14:50:10 +01005648mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005649{
Gilles Peskine449bd832023-01-11 14:50:10 +01005650 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5651 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005652 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005653 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005654 }
5655
5656 return MBEDTLS_ECP_DP_NONE;
5657}
5658
Gilles Peskine449bd832023-01-11 14:50:10 +01005659uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005660{
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5662 i++) {
5663 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005664 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005666 }
5667
5668 return 0;
5669}
5670
Valerio Setti67419f02023-01-04 16:12:42 +01005671#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005672const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005673{
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5675 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005676 return tls_id_match_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005678 }
5679
5680 return NULL;
5681}
Valerio Setti67419f02023-01-04 16:12:42 +01005682#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005683
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005684#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005685int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5686 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5687 int cert_endpoint,
5688 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005689{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005690 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005691 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005692 const char *ext_oid;
5693 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005694
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005696 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005698 case MBEDTLS_KEY_EXCHANGE_RSA:
5699 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005700 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005701 break;
5702
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005703 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5704 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5705 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5706 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005707 break;
5708
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005709 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5710 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005711 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005712 break;
5713
5714 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005715 case MBEDTLS_KEY_EXCHANGE_NONE:
5716 case MBEDTLS_KEY_EXCHANGE_PSK:
5717 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5718 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005719 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005720 usage = 0;
5721 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005723 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5724 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005725 }
5726
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005728 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005729 ret = -1;
5730 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005731
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005733 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5735 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005736 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005738 }
5739
Gilles Peskine449bd832023-01-11 14:50:10 +01005740 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005741 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005742 ret = -1;
5743 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005744
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005746}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005747#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005748
Jerry Yu148165c2021-09-24 23:20:59 +08005749#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005750int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5751 const mbedtls_md_type_t md,
5752 unsigned char *dst,
5753 size_t dst_len,
5754 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005755{
Ronald Cronf6893e12022-01-07 22:09:01 +01005756 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5757 psa_hash_operation_t *hash_operation_to_clone;
5758 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5759
Jerry Yu148165c2021-09-24 23:20:59 +08005760 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005761
Gilles Peskine449bd832023-01-11 14:50:10 +01005762 switch (md) {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005763#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 case MBEDTLS_MD_SHA384:
5765 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5766 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005767#endif
5768
Andrzej Kurek25f27152022-08-17 16:09:31 -04005769#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 case MBEDTLS_MD_SHA256:
5771 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5772 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005773#endif
5774
Gilles Peskine449bd832023-01-11 14:50:10 +01005775 default:
5776 goto exit;
5777 }
5778
5779 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5780 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005781 goto exit;
5782 }
5783
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5785 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005786 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005787 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005788
5789exit:
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005790#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
5791 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
5792 (void) ssl;
5793#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005794 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005795}
5796#else /* MBEDTLS_USE_PSA_CRYPTO */
5797
Andrzej Kurek25f27152022-08-17 16:09:31 -04005798#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005799MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005800static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5801 unsigned char *dst,
5802 size_t dst_len,
5803 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005804{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005805 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005806 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005807
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 if (dst_len < 48) {
5809 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5810 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005811
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005812 mbedtls_md_init(&sha384);
5813 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005814 if (ret != 0) {
5815 goto exit;
5816 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005817 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005818 if (ret != 0) {
5819 goto exit;
5820 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005821
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005822 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005823 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005824 goto exit;
5825 }
5826
5827 *olen = 48;
5828
5829exit:
5830
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005831 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005833}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005834#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005835
Andrzej Kurek25f27152022-08-17 16:09:31 -04005836#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005837MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005838static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5839 unsigned char *dst,
5840 size_t dst_len,
5841 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005842{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005843 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005844 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005845
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 if (dst_len < 32) {
5847 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5848 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005849
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005850 mbedtls_md_init(&sha256);
5851 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5852 if (ret != 0) {
5853 goto exit;
5854 }
5855 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5856 if (ret != 0) {
5857 goto exit;
5858 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005859
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005860 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5861 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005862 goto exit;
5863 }
5864
5865 *olen = 32;
5866
5867exit:
5868
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005869 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005871}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005872#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005873
Gilles Peskine449bd832023-01-11 14:50:10 +01005874int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5875 const mbedtls_md_type_t md,
5876 unsigned char *dst,
5877 size_t dst_len,
5878 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005879{
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005881
Andrzej Kurek25f27152022-08-17 16:09:31 -04005882#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005883 case MBEDTLS_MD_SHA384:
5884 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005885#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005886
Andrzej Kurek25f27152022-08-17 16:09:31 -04005887#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 case MBEDTLS_MD_SHA256:
5889 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005890#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005891
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 default:
Andrzej Kurek409248a2022-10-24 10:33:21 -04005893#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
5895 (void) ssl;
5896 (void) dst;
5897 (void) dst_len;
5898 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005899#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005901 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005903}
XiaokangQian647719a2021-12-07 09:16:29 +00005904
Jerry Yu148165c2021-09-24 23:20:59 +08005905#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005906
Ronald Crone68ab4f2022-10-05 12:46:29 +02005907#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005908/* mbedtls_ssl_parse_sig_alg_ext()
5909 *
5910 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5911 * value (TLS 1.3 RFC8446):
5912 * enum {
5913 * ....
5914 * ecdsa_secp256r1_sha256( 0x0403 ),
5915 * ecdsa_secp384r1_sha384( 0x0503 ),
5916 * ecdsa_secp521r1_sha512( 0x0603 ),
5917 * ....
5918 * } SignatureScheme;
5919 *
5920 * struct {
5921 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5922 * } SignatureSchemeList;
5923 *
5924 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5925 * value (TLS 1.2 RFC5246):
5926 * enum {
5927 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5928 * sha512(6), (255)
5929 * } HashAlgorithm;
5930 *
5931 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5932 * SignatureAlgorithm;
5933 *
5934 * struct {
5935 * HashAlgorithm hash;
5936 * SignatureAlgorithm signature;
5937 * } SignatureAndHashAlgorithm;
5938 *
5939 * SignatureAndHashAlgorithm
5940 * supported_signature_algorithms<2..2^16-2>;
5941 *
5942 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5943 * generalization of the TLS 1.2 signature algorithm extension.
5944 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5945 * `SignatureScheme` field of TLS 1.3
5946 *
5947 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005948int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5949 const unsigned char *buf,
5950 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005951{
5952 const unsigned char *p = buf;
5953 size_t supported_sig_algs_len = 0;
5954 const unsigned char *supported_sig_algs_end;
5955 uint16_t sig_alg;
5956 uint32_t common_idx = 0;
5957
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5959 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005960 p += 2;
5961
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 memset(ssl->handshake->received_sig_algs, 0,
5963 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005964
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005966 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 while (p < supported_sig_algs_end) {
5968 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5969 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005970 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5972 sig_alg,
5973 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005974#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5976 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5977 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005978 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005979 }
5980#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005981
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5983 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005984
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005986 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5987 common_idx += 1;
5988 }
5989 }
5990 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 if (p != end) {
5992 MBEDTLS_SSL_DEBUG_MSG(1,
5993 ("Signature algorithms extension length misaligned"));
5994 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5995 MBEDTLS_ERR_SSL_DECODE_ERROR);
5996 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02005997 }
5998
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 if (common_idx == 0) {
6000 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6001 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6002 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6003 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006004 }
6005
Gabor Mezei15b95a62022-05-09 16:37:58 +02006006 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006008}
6009
Ronald Crone68ab4f2022-10-05 12:46:29 +02006010#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006011
Jerry Yudc7bd172022-02-17 13:44:15 +08006012#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6013
6014#if defined(MBEDTLS_USE_PSA_CRYPTO)
6015
Gilles Peskine449bd832023-01-11 14:50:10 +01006016static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6017 mbedtls_svc_key_id_t key,
6018 psa_algorithm_t alg,
6019 const unsigned char *raw_psk, size_t raw_psk_length,
6020 const unsigned char *seed, size_t seed_length,
6021 const unsigned char *label, size_t label_length,
6022 const unsigned char *other_secret,
6023 size_t other_secret_length,
6024 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006025{
6026 psa_status_t status;
6027
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 status = psa_key_derivation_setup(derivation, alg);
6029 if (status != PSA_SUCCESS) {
6030 return status;
6031 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006032
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6034 status = psa_key_derivation_input_bytes(derivation,
6035 PSA_KEY_DERIVATION_INPUT_SEED,
6036 seed, seed_length);
6037 if (status != PSA_SUCCESS) {
6038 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006039 }
6040
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 if (other_secret != NULL) {
6042 status = psa_key_derivation_input_bytes(derivation,
6043 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6044 other_secret, other_secret_length);
6045 if (status != PSA_SUCCESS) {
6046 return status;
6047 }
6048 }
6049
6050 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006051 status = psa_key_derivation_input_bytes(
6052 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 raw_psk, raw_psk_length);
6054 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006055 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006057 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 if (status != PSA_SUCCESS) {
6059 return status;
6060 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006061
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 status = psa_key_derivation_input_bytes(derivation,
6063 PSA_KEY_DERIVATION_INPUT_LABEL,
6064 label, label_length);
6065 if (status != PSA_SUCCESS) {
6066 return status;
6067 }
6068 } else {
6069 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006070 }
6071
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 status = psa_key_derivation_set_capacity(derivation, capacity);
6073 if (status != PSA_SUCCESS) {
6074 return status;
6075 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006076
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006078}
6079
Andrzej Kurek57d10632022-10-24 10:32:01 -04006080#if defined(PSA_WANT_ALG_SHA_384) || \
6081 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006082MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006083static int tls_prf_generic(mbedtls_md_type_t md_type,
6084 const unsigned char *secret, size_t slen,
6085 const char *label,
6086 const unsigned char *random, size_t rlen,
6087 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006088{
6089 psa_status_t status;
6090 psa_algorithm_t alg;
6091 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6092 psa_key_derivation_operation_t derivation =
6093 PSA_KEY_DERIVATION_OPERATION_INIT;
6094
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006096 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006098 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006100
6101 /* Normally a "secret" should be long enough to be impossible to
6102 * find by brute force, and in particular should not be empty. But
6103 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6104 * and for this use case it makes sense to have a 0-length "secret".
6105 * Since the key API doesn't allow importing a key of length 0,
6106 * keep master_key=0, which setup_psa_key_derivation() understands
6107 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006109 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6111 psa_set_key_algorithm(&key_attributes, alg);
6112 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006113
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6115 if (status != PSA_SUCCESS) {
6116 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6117 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006118 }
6119
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 status = setup_psa_key_derivation(&derivation,
6121 master_key, alg,
6122 NULL, 0,
6123 random, rlen,
6124 (unsigned char const *) label,
6125 (size_t) strlen(label),
6126 NULL, 0,
6127 dlen);
6128 if (status != PSA_SUCCESS) {
6129 psa_key_derivation_abort(&derivation);
6130 psa_destroy_key(master_key);
6131 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006132 }
6133
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6135 if (status != PSA_SUCCESS) {
6136 psa_key_derivation_abort(&derivation);
6137 psa_destroy_key(master_key);
6138 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006139 }
6140
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 status = psa_key_derivation_abort(&derivation);
6142 if (status != PSA_SUCCESS) {
6143 psa_destroy_key(master_key);
6144 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006145 }
6146
Gilles Peskine449bd832023-01-11 14:50:10 +01006147 if (!mbedtls_svc_key_id_is_null(master_key)) {
6148 status = psa_destroy_key(master_key);
6149 }
6150 if (status != PSA_SUCCESS) {
6151 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6152 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006153
Gilles Peskine449bd832023-01-11 14:50:10 +01006154 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006155}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006156#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006157#else /* MBEDTLS_USE_PSA_CRYPTO */
6158
Andrzej Kurek57d10632022-10-24 10:32:01 -04006159#if defined(MBEDTLS_MD_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 (defined(MBEDTLS_SHA256_C) || \
6161 defined(MBEDTLS_SHA384_C))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006162MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006163static int tls_prf_generic(mbedtls_md_type_t md_type,
6164 const unsigned char *secret, size_t slen,
6165 const char *label,
6166 const unsigned char *random, size_t rlen,
6167 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006168{
6169 size_t nb;
6170 size_t i, j, k, md_len;
6171 unsigned char *tmp;
6172 size_t tmp_len = 0;
6173 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6174 const mbedtls_md_info_t *md_info;
6175 mbedtls_md_context_t md_ctx;
6176 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6177
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6181 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6182 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006185
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 tmp_len = md_len + strlen(label) + rlen;
6187 tmp = mbedtls_calloc(1, tmp_len);
6188 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006189 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6190 goto exit;
6191 }
6192
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 nb = strlen(label);
6194 memcpy(tmp + md_len, label, nb);
6195 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006196 nb += rlen;
6197
6198 /*
6199 * Compute P_<hash>(secret, label + random)[0..dlen]
6200 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006202 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006204
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6206 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006207 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 }
6209 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6210 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006211 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 }
6213 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6214 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006215 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006217
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 for (i = 0; i < dlen; i += md_len) {
6219 ret = mbedtls_md_hmac_reset(&md_ctx);
6220 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006221 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 }
6223 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6224 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006225 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 }
6227 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6228 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006229 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006231
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 ret = mbedtls_md_hmac_reset(&md_ctx);
6233 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006234 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 }
6236 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6237 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006238 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 }
6240 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6241 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006242 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006244
Gilles Peskine449bd832023-01-11 14:50:10 +01006245 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006246
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006248 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006250 }
6251
6252exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006254
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 if (tmp != NULL) {
6256 mbedtls_platform_zeroize(tmp, tmp_len);
6257 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006258
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006260
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006262
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006264}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006265#endif /* MBEDTLS_MD_C && ( MBEDTLS_SHA256_C || MBEDTLS_SHA384_C ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006266#endif /* MBEDTLS_USE_PSA_CRYPTO */
6267
Andrzej Kurek25f27152022-08-17 16:09:31 -04006268#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006269MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006270static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6271 const char *label,
6272 const unsigned char *random, size_t rlen,
6273 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006274{
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6276 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006277}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04006278#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006279
Andrzej Kurek25f27152022-08-17 16:09:31 -04006280#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006281MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006282static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6283 const char *label,
6284 const unsigned char *random, size_t rlen,
6285 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006286{
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6288 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006289}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04006290#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006291
Jerry Yuf009d862022-02-17 14:01:37 +08006292/*
6293 * Set appropriate PRF function and other SSL / TLS1.2 functions
6294 *
6295 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006296 * - hash associated with the ciphersuite (only used by TLS 1.2)
6297 *
6298 * Outputs:
6299 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6300 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006301MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006302static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6303 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006304{
Andrzej Kurek25f27152022-08-17 16:09:31 -04006305#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006307 handshake->tls_prf = tls_prf_sha384;
6308 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6309 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006311#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04006312#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuf009d862022-02-17 14:01:37 +08006313 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006314 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006315 handshake->tls_prf = tls_prf_sha256;
6316 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6317 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6318 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006319#else
Jerry Yuf009d862022-02-17 14:01:37 +08006320 {
Jerry Yuf009d862022-02-17 14:01:37 +08006321 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006322 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006324 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006325#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006326
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006328}
Jerry Yud6ab2352022-02-17 14:03:43 +08006329
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006330/*
6331 * Compute master secret if needed
6332 *
6333 * Parameters:
6334 * [in/out] handshake
6335 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6336 * (PSA-PSK) ciphersuite_info, psk_opaque
6337 * [out] premaster (cleared)
6338 * [out] master
6339 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6340 * debug: conf->f_dbg, conf->p_dbg
6341 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006342 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006343 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006344MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006345static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6346 unsigned char *master,
6347 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006348{
6349 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6350
6351 /* cf. RFC 5246, Section 8.1:
6352 * "The master secret is always exactly 48 bytes in length." */
6353 size_t const master_secret_len = 48;
6354
6355#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6356 unsigned char session_hash[48];
6357#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6358
6359 /* The label for the KDF used for key expansion.
6360 * This is either "master secret" or "extended master secret"
6361 * depending on whether the Extended Master Secret extension
6362 * is used. */
6363 char const *lbl = "master secret";
6364
Przemek Stekielae4ed302022-04-05 17:15:55 +02006365 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006366 * - If the Extended Master Secret extension is not used,
6367 * this is ClientHello.Random + ServerHello.Random
6368 * (see Sect. 8.1 in RFC 5246).
6369 * - If the Extended Master Secret extension is used,
6370 * this is the transcript of the handshake so far.
6371 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006372 unsigned char const *seed = handshake->randbytes;
6373 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006374
6375#if !defined(MBEDTLS_DEBUG_C) && \
6376 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6377 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006379 ssl = NULL; /* make sure we don't use it except for those cases */
6380 (void) ssl;
6381#endif
6382
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 if (handshake->resume != 0) {
6384 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6385 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006386 }
6387
6388#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006390 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006391 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006392 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6393 if (ret != 0) {
6394 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6395 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006396
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6398 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006399 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006400#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006401
Przemek Stekiel99114f32022-04-22 11:20:09 +02006402#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006403 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006405 /* Perform PSK-to-MS expansion in a single step. */
6406 psa_status_t status;
6407 psa_algorithm_t alg;
6408 mbedtls_svc_key_id_t psk;
6409 psa_key_derivation_operation_t derivation =
6410 PSA_KEY_DERIVATION_OPERATION_INIT;
6411 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6412
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006414
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006416
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006418 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006420 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006422
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006423 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006427 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006428 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006429 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006430 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006431 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006432 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006433 other_secret_len = 48;
6434 other_secret = handshake->premaster + 2;
6435 break;
6436 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006437 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006438 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6439 other_secret = handshake->premaster + 2;
6440 break;
6441 default:
6442 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006443 }
6444
Gilles Peskine449bd832023-01-11 14:50:10 +01006445 status = setup_psa_key_derivation(&derivation, psk, alg,
6446 ssl->conf->psk, ssl->conf->psk_len,
6447 seed, seed_len,
6448 (unsigned char const *) lbl,
6449 (size_t) strlen(lbl),
6450 other_secret, other_secret_len,
6451 master_secret_len);
6452 if (status != PSA_SUCCESS) {
6453 psa_key_derivation_abort(&derivation);
6454 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006455 }
6456
Gilles Peskine449bd832023-01-11 14:50:10 +01006457 status = psa_key_derivation_output_bytes(&derivation,
6458 master,
6459 master_secret_len);
6460 if (status != PSA_SUCCESS) {
6461 psa_key_derivation_abort(&derivation);
6462 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006463 }
6464
Gilles Peskine449bd832023-01-11 14:50:10 +01006465 status = psa_key_derivation_abort(&derivation);
6466 if (status != PSA_SUCCESS) {
6467 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6468 }
6469 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006470#endif
6471 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006472#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006473 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6474 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006475 psa_status_t status;
6476 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6477 psa_key_derivation_operation_t derivation =
6478 PSA_KEY_DERIVATION_OPERATION_INIT;
6479
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006481
6482 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 status = psa_key_derivation_setup(&derivation, alg);
6485 if (status != PSA_SUCCESS) {
6486 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006487 }
6488
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 status = psa_key_derivation_set_capacity(&derivation,
6490 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6491 if (status != PSA_SUCCESS) {
6492 psa_key_derivation_abort(&derivation);
6493 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006494 }
6495
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6497 &derivation);
6498 if (status != PSA_SUCCESS) {
6499 psa_key_derivation_abort(&derivation);
6500 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006501 }
6502
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 status = psa_key_derivation_output_bytes(&derivation,
6504 handshake->premaster,
6505 handshake->pmslen);
6506 if (status != PSA_SUCCESS) {
6507 psa_key_derivation_abort(&derivation);
6508 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6509 }
6510
6511 status = psa_key_derivation_abort(&derivation);
6512 if (status != PSA_SUCCESS) {
6513 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006514 }
6515 }
6516#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6518 lbl, seed, seed_len,
6519 master,
6520 master_secret_len);
6521 if (ret != 0) {
6522 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6523 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006524 }
6525
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6527 handshake->premaster,
6528 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006529
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 mbedtls_platform_zeroize(handshake->premaster,
6531 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006532 }
6533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006535}
6536
Gilles Peskine449bd832023-01-11 14:50:10 +01006537int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006538{
6539 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6540 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6541 ssl->handshake->ciphersuite_info;
6542
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006544
6545 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 ret = ssl_set_handshake_prfs(ssl->handshake,
6547 ciphersuite_info->mac);
6548 if (ret != 0) {
6549 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6550 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006551 }
6552
6553 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 ret = ssl_compute_master(ssl->handshake,
6555 ssl->session_negotiate->master,
6556 ssl);
6557 if (ret != 0) {
6558 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6559 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006560 }
6561
6562 /* Swap the client and server random values:
6563 * - MS derivation wanted client+server (RFC 5246 8.1)
6564 * - key derivation wants server+client (RFC 5246 6.3) */
6565 {
6566 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 memcpy(tmp, ssl->handshake->randbytes, 64);
6568 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6569 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6570 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006571 }
6572
6573 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6575 ssl->session_negotiate->ciphersuite,
6576 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006577#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006578 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006579#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 ssl->handshake->tls_prf,
6581 ssl->handshake->randbytes,
6582 ssl->tls_version,
6583 ssl->conf->endpoint,
6584 ssl);
6585 if (ret != 0) {
6586 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6587 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006588 }
6589
6590 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6592 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006593
Gilles Peskine449bd832023-01-11 14:50:10 +01006594 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006595
Gilles Peskine449bd832023-01-11 14:50:10 +01006596 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006597}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006598
Gilles Peskine449bd832023-01-11 14:50:10 +01006599int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006600{
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 switch (md) {
Andrzej Kurek25f27152022-08-17 16:09:31 -04006602#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006603 case MBEDTLS_SSL_HASH_SHA384:
6604 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6605 break;
6606#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04006607#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006608 case MBEDTLS_SSL_HASH_SHA256:
6609 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6610 break;
6611#endif
6612 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006613 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006614 }
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006615#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
6616 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
6617 (void) ssl;
6618#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006619 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006620}
6621
Andrzej Kurek25f27152022-08-17 16:09:31 -04006622#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006623int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6624 unsigned char *hash,
6625 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006626{
6627#if defined(MBEDTLS_USE_PSA_CRYPTO)
6628 size_t hash_size;
6629 psa_status_t status;
6630 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
6631
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify sha256"));
6633 status = psa_hash_clone(&ssl->handshake->fin_sha256_psa, &sha256_psa);
6634 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006635 goto exit;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006636 }
6637
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 status = psa_hash_finish(&sha256_psa, hash, 32, &hash_size);
6639 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006640 goto exit;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006641 }
6642
6643 *hlen = 32;
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6645 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006646
6647exit:
6648 psa_hash_abort(&sha256_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05006649 return PSA_TO_MD_ERR(status);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006650#else
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006651 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006652 mbedtls_md_context_t sha256;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006653
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006654 mbedtls_md_init(&sha256);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006655
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify sha256"));
Jerry Yu8392e0d2022-02-17 14:10:24 +08006657
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006658 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6659 if (ret != 0) {
6660 goto exit;
6661 }
6662 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6663 if (ret != 0) {
6664 goto exit;
6665 }
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006666
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006667 ret = mbedtls_md_finish(&sha256, hash);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006668 if (ret != 0) {
6669 goto exit;
6670 }
Jerry Yu8392e0d2022-02-17 14:10:24 +08006671
6672 *hlen = 32;
6673
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6675 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
Jerry Yu8392e0d2022-02-17 14:10:24 +08006676
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006677exit:
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006678 mbedtls_md_free(&sha256);
Manuel Pégourié-Gonnard8e176f72023-02-09 10:33:54 +01006679 return ret;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006680#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006681}
Andrzej Kurek25f27152022-08-17 16:09:31 -04006682#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006683
Andrzej Kurek25f27152022-08-17 16:09:31 -04006684#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006685int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6686 unsigned char *hash,
6687 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006688{
6689#if defined(MBEDTLS_USE_PSA_CRYPTO)
6690 size_t hash_size;
6691 psa_status_t status;
6692 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
6693
Gilles Peskine449bd832023-01-11 14:50:10 +01006694 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify sha384"));
6695 status = psa_hash_clone(&ssl->handshake->fin_sha384_psa, &sha384_psa);
6696 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006697 goto exit;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006698 }
6699
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 status = psa_hash_finish(&sha384_psa, hash, 48, &hash_size);
6701 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006702 goto exit;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006703 }
6704
6705 *hlen = 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006706 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6707 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006708
6709exit:
6710 psa_hash_abort(&sha384_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05006711 return PSA_TO_MD_ERR(status);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006712#else
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006713 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006714 mbedtls_md_context_t sha384;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006715
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006716 mbedtls_md_init(&sha384);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006717
Gilles Peskine449bd832023-01-11 14:50:10 +01006718 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify sha384"));
Jerry Yuc1cb3842022-02-17 14:13:48 +08006719
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006720 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006721 if (ret != 0) {
6722 goto exit;
6723 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006724 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006725 if (ret != 0) {
6726 goto exit;
6727 }
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006728
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006729 ret = mbedtls_md_finish(&sha384, hash);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006730 if (ret != 0) {
6731 goto exit;
6732 }
Jerry Yuc1cb3842022-02-17 14:13:48 +08006733
6734 *hlen = 48;
6735
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6737 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
Jerry Yuc1cb3842022-02-17 14:13:48 +08006738
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006739exit:
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006740 mbedtls_md_free(&sha384);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006741 return ret;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006742#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006743}
Andrzej Kurek25f27152022-08-17 16:09:31 -04006744#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006745
Neil Armstrong80f6f322022-05-03 17:56:38 +02006746#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6747 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006748int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006749{
6750 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006752 const unsigned char *psk = NULL;
6753 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006755
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006757 /*
6758 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006759 * checked before calling this function.
6760 *
6761 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006762 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006763 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6765 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6766 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006767 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006768 }
6769
6770 /*
6771 * PMS = struct {
6772 * opaque other_secret<0..2^16-1>;
6773 * opaque psk<0..2^16-1>;
6774 * };
6775 * with "other_secret" depending on the particular key exchange
6776 */
6777#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6779 if (end - p < 2) {
6780 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6781 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006782
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006784 p += 2;
6785
Gilles Peskine449bd832023-01-11 14:50:10 +01006786 if (end < p || (size_t) (end - p) < psk_len) {
6787 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6788 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006789
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006791 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006793#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6794#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006795 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006796 /*
6797 * other_secret already set by the ClientKeyExchange message,
6798 * and is 48 bytes long
6799 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 if (end - p < 2) {
6801 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6802 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006803
6804 *p++ = 0;
6805 *p++ = 48;
6806 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006808#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6809#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006811 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6812 size_t len;
6813
6814 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6816 p + 2, end - (p + 2), &len,
6817 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6818 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6819 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006820 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006822 p += 2 + len;
6823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6825 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006826#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006827#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006829 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6830 size_t zlen;
6831
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6833 p + 2, end - (p + 2),
6834 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6835 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6836 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006837 }
6838
Gilles Peskine449bd832023-01-11 14:50:10 +01006839 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006840 p += 2 + zlen;
6841
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6843 MBEDTLS_DEBUG_ECDH_Z);
6844 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006845#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006846 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6848 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006849 }
6850
6851 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 if (end - p < 2) {
6853 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6854 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006855
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006857 p += 2;
6858
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 if (end < p || (size_t) (end - p) < psk_len) {
6860 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6861 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006862
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006864 p += psk_len;
6865
6866 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6867
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006869}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006870#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006871
6872#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006873MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006874static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006875
6876#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006877int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006878{
6879 /* If renegotiation is not enforced, retransmit until we would reach max
6880 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006882 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6883 unsigned char doublings = 1;
6884
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006886 ++doublings;
6887 ratio >>= 1;
6888 }
6889
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 if (++ssl->renego_records_seen > doublings) {
6891 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6892 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006893 }
6894 }
6895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006897}
6898#endif
6899#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006900
Jerry Yud9526692022-02-17 14:23:47 +08006901/*
6902 * Handshake functions
6903 */
6904#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6905/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006906int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006907{
6908 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6909 ssl->handshake->ciphersuite_info;
6910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006912
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6914 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006915 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006917 }
6918
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6920 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006921}
6922
Gilles Peskine449bd832023-01-11 14:50:10 +01006923int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006924{
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, ("=> parse 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 parse 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
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6937 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006938}
6939
6940#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6941/* Some certificate support -> implement write and parse */
6942
Gilles Peskine449bd832023-01-11 14:50:10 +01006943int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006944{
6945 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6946 size_t i, n;
6947 const mbedtls_x509_crt *crt;
6948 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6949 ssl->handshake->ciphersuite_info;
6950
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006952
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6954 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006955 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006957 }
6958
6959#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6961 if (ssl->handshake->client_auth == 0) {
6962 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006963 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006965 }
6966 }
6967#endif /* MBEDTLS_SSL_CLI_C */
6968#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6970 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006971 /* Should never happen because we shouldn't have picked the
6972 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006974 }
6975 }
6976#endif
6977
Gilles Peskine449bd832023-01-11 14:50:10 +01006978 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006979
6980 /*
6981 * 0 . 0 handshake type
6982 * 1 . 3 handshake length
6983 * 4 . 6 length of all certs
6984 * 7 . 9 length of cert. 1
6985 * 10 . n-1 peer certificate
6986 * n . n+2 length of cert. 2
6987 * n+3 . ... upper level cert, etc.
6988 */
6989 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006990 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006991
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006993 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6995 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6996 " > %" MBEDTLS_PRINTF_SIZET,
6997 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6998 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006999 }
7000
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7002 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7003 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007004
Gilles Peskine449bd832023-01-11 14:50:10 +01007005 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007006 i += n; crt = crt->next;
7007 }
7008
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7010 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7011 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007012
7013 ssl->out_msglen = i;
7014 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7015 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7016
7017 ssl->state++;
7018
Gilles Peskine449bd832023-01-11 14:50:10 +01007019 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7020 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7021 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007022 }
7023
Gilles Peskine449bd832023-01-11 14:50:10 +01007024 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007025
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007027}
7028
7029#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7030
7031#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007032MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007033static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7034 unsigned char *crt_buf,
7035 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007036{
7037 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7038
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 if (peer_crt == NULL) {
7040 return -1;
7041 }
Jerry Yud9526692022-02-17 14:23:47 +08007042
Gilles Peskine449bd832023-01-11 14:50:10 +01007043 if (peer_crt->raw.len != crt_buf_len) {
7044 return -1;
7045 }
Jerry Yud9526692022-02-17 14:23:47 +08007046
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007048}
7049#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007050MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007051static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7052 unsigned char *crt_buf,
7053 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007054{
7055 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7056 unsigned char const * const peer_cert_digest =
7057 ssl->session->peer_cert_digest;
7058 mbedtls_md_type_t const peer_cert_digest_type =
7059 ssl->session->peer_cert_digest_type;
7060 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007062 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7063 size_t digest_len;
7064
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 if (peer_cert_digest == NULL || digest_info == NULL) {
7066 return -1;
7067 }
Jerry Yud9526692022-02-17 14:23:47 +08007068
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 digest_len = mbedtls_md_get_size(digest_info);
7070 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7071 return -1;
7072 }
Jerry Yud9526692022-02-17 14:23:47 +08007073
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7075 if (ret != 0) {
7076 return -1;
7077 }
Jerry Yud9526692022-02-17 14:23:47 +08007078
Gilles Peskine449bd832023-01-11 14:50:10 +01007079 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007080}
7081#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7082#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7083
7084/*
7085 * Once the certificate message is read, parse it into a cert chain and
7086 * perform basic checks, but leave actual verification to the caller
7087 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007088MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007089static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7090 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007091{
7092 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7093#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007095#endif
7096 size_t i, n;
7097 uint8_t alert;
7098
Gilles Peskine449bd832023-01-11 14:50:10 +01007099 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7100 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7101 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7102 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7103 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007104 }
7105
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7107 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7108 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7109 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007110 }
7111
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7113 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7114 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7115 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7116 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007117 }
7118
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007120
7121 /*
7122 * Same message structure as in mbedtls_ssl_write_certificate()
7123 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007124 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007125
Gilles Peskine449bd832023-01-11 14:50:10 +01007126 if (ssl->in_msg[i] != 0 ||
7127 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7128 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7129 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7130 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7131 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007132 }
7133
7134 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7135 i += 3;
7136
7137 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007139 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 if (i + 3 > ssl->in_hslen) {
7141 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7142 mbedtls_ssl_send_alert_message(ssl,
7143 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7144 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7145 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007146 }
7147 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7148 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 if (ssl->in_msg[i] != 0) {
7150 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7151 mbedtls_ssl_send_alert_message(ssl,
7152 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7153 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7154 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007155 }
7156
7157 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007159 | (unsigned int) ssl->in_msg[i + 2];
7160 i += 3;
7161
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 if (n < 128 || i + n > ssl->in_hslen) {
7163 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7164 mbedtls_ssl_send_alert_message(ssl,
7165 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7166 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7167 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007168 }
7169
7170 /* Check if we're handling the first CRT in the chain. */
7171#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007173 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007175 /* During client-side renegotiation, check that the server's
7176 * end-CRTs hasn't changed compared to the initial handshake,
7177 * mitigating the triple handshake attack. On success, reuse
7178 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7180 if (ssl_check_peer_crt_unchanged(ssl,
7181 &ssl->in_msg[i],
7182 n) != 0) {
7183 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7184 mbedtls_ssl_send_alert_message(ssl,
7185 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7186 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7187 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007188 }
7189
7190 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007192 }
7193#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7194
7195 /* Parse the next certificate in the chain. */
7196#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007198#else
7199 /* If we don't need to store the CRT chain permanently, parse
7200 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007202#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007204 case 0: /*ok*/
7205 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7206 /* Ignore certificate with an unknown algorithm: maybe a
7207 prior certificate was already trusted. */
7208 break;
7209
7210 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7211 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7212 goto crt_parse_der_failed;
7213
7214 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7215 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7216 goto crt_parse_der_failed;
7217
7218 default:
7219 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007220crt_parse_der_failed:
7221 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7222 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7223 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007224 }
7225
7226 i += n;
7227 }
7228
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7230 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007231}
7232
7233#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007234MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007235static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007236{
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7238 return -1;
7239 }
Jerry Yud9526692022-02-17 14:23:47 +08007240
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007242 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7243 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007244 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7245 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7246 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007247 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007249}
7250#endif /* MBEDTLS_SSL_SRV_C */
7251
7252/* Check if a certificate message is expected.
7253 * Return either
7254 * - SSL_CERTIFICATE_EXPECTED, or
7255 * - SSL_CERTIFICATE_SKIP
7256 * indicating whether a Certificate message is expected or not.
7257 */
7258#define SSL_CERTIFICATE_EXPECTED 0
7259#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007260MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007261static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7262 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007263{
7264 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7265 ssl->handshake->ciphersuite_info;
7266
Gilles Peskine449bd832023-01-11 14:50:10 +01007267 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7268 return SSL_CERTIFICATE_SKIP;
7269 }
Jerry Yud9526692022-02-17 14:23:47 +08007270
7271#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007272 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7273 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7274 return SSL_CERTIFICATE_SKIP;
7275 }
Jerry Yud9526692022-02-17 14:23:47 +08007276
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007278 ssl->session_negotiate->verify_result =
7279 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007281 }
7282 }
7283#else
7284 ((void) authmode);
7285#endif /* MBEDTLS_SSL_SRV_C */
7286
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007288}
7289
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007290MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007291static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7292 int authmode,
7293 mbedtls_x509_crt *chain,
7294 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007295{
7296 int ret = 0;
7297 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7298 ssl->handshake->ciphersuite_info;
7299 int have_ca_chain = 0;
7300
7301 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7302 void *p_vrfy;
7303
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7305 return 0;
7306 }
Jerry Yud9526692022-02-17 14:23:47 +08007307
Gilles Peskine449bd832023-01-11 14:50:10 +01007308 if (ssl->f_vrfy != NULL) {
7309 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007310 f_vrfy = ssl->f_vrfy;
7311 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007312 } else {
7313 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007314 f_vrfy = ssl->conf->f_vrfy;
7315 p_vrfy = ssl->conf->p_vrfy;
7316 }
7317
7318 /*
7319 * Main check: verify certificate
7320 */
7321#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007323 ((void) rs_ctx);
7324 have_ca_chain = 1;
7325
Gilles Peskine449bd832023-01-11 14:50:10 +01007326 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007327 ret = mbedtls_x509_crt_verify_with_ca_cb(
7328 chain,
7329 ssl->conf->f_ca_cb,
7330 ssl->conf->p_ca_cb,
7331 ssl->conf->cert_profile,
7332 ssl->hostname,
7333 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 f_vrfy, p_vrfy);
7335 } else
Jerry Yud9526692022-02-17 14:23:47 +08007336#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7337 {
7338 mbedtls_x509_crt *ca_chain;
7339 mbedtls_x509_crl *ca_crl;
7340
7341#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007342 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007343 ca_chain = ssl->handshake->sni_ca_chain;
7344 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007345 } else
Jerry Yud9526692022-02-17 14:23:47 +08007346#endif
7347 {
7348 ca_chain = ssl->conf->ca_chain;
7349 ca_crl = ssl->conf->ca_crl;
7350 }
7351
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007353 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 }
Jerry Yud9526692022-02-17 14:23:47 +08007355
7356 ret = mbedtls_x509_crt_verify_restartable(
7357 chain,
7358 ca_chain, ca_crl,
7359 ssl->conf->cert_profile,
7360 ssl->hostname,
7361 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007363 }
7364
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 if (ret != 0) {
7366 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007367 }
7368
7369#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7371 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7372 }
Jerry Yud9526692022-02-17 14:23:47 +08007373#endif
7374
7375 /*
7376 * Secondary checks: always done, but change 'ret' only if it was 0
7377 */
7378
7379#if defined(MBEDTLS_ECP_C)
7380 {
7381 const mbedtls_pk_context *pk = &chain->pk;
7382
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007383 /* If certificate uses an EC key, make sure the curve is OK.
7384 * This is a public key, so it can't be opaque, so can_do() is a good
7385 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007387 /* and in the unlikely case the above assumption no longer holds
7388 * we are making sure that pk_ec() here does not return a NULL
7389 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007390 const mbedtls_ecp_keypair *ec = mbedtls_pk_ec(*pk);
7391 if (ec == NULL) {
7392 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_pk_ec() returned NULL"));
7393 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007394 }
Jerry Yud9526692022-02-17 14:23:47 +08007395
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 if (mbedtls_ssl_check_curve(ssl, ec->grp.id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007397 ssl->session_negotiate->verify_result |=
7398 MBEDTLS_X509_BADCERT_BAD_KEY;
7399
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7401 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007402 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007404 }
Jerry Yud9526692022-02-17 14:23:47 +08007405 }
7406 }
7407#endif /* MBEDTLS_ECP_C */
7408
Gilles Peskine449bd832023-01-11 14:50:10 +01007409 if (mbedtls_ssl_check_cert_usage(chain,
7410 ciphersuite_info,
7411 !ssl->conf->endpoint,
7412 &ssl->session_negotiate->verify_result) != 0) {
7413 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7414 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007415 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 }
Jerry Yud9526692022-02-17 14:23:47 +08007417 }
7418
7419 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7420 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7421 * with details encoded in the verification flags. All other kinds
7422 * of error codes, including those from the user provided f_vrfy
7423 * functions, are treated as fatal and lead to a failure of
7424 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7426 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7427 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007428 ret = 0;
7429 }
7430
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7432 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007433 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7434 }
7435
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007437 uint8_t alert;
7438
7439 /* The certificate may have been rejected for several reasons.
7440 Pick one and send the corresponding alert. Which alert to send
7441 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007443 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007445 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007447 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007449 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007451 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007453 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007455 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007457 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007459 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007461 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007463 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 }
7465 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7466 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007467 }
7468
7469#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 if (ssl->session_negotiate->verify_result != 0) {
7471 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7472 (unsigned int) ssl->session_negotiate->verify_result));
7473 } else {
7474 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007475 }
7476#endif /* MBEDTLS_DEBUG_C */
7477
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007479}
7480
7481#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007482MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007483static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7484 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007485{
7486 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7487 /* Remember digest of the peer's end-CRT. */
7488 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7490 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7491 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7492 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7493 mbedtls_ssl_send_alert_message(ssl,
7494 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7495 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007496
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007498 }
7499
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 ret = mbedtls_md(mbedtls_md_info_from_type(
7501 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7502 start, len,
7503 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007504
7505 ssl->session_negotiate->peer_cert_digest_type =
7506 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7507 ssl->session_negotiate->peer_cert_digest_len =
7508 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7509
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007511}
7512
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007513MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007514static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7515 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007516{
7517 unsigned char *end = start + len;
7518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7519
7520 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7522 ret = mbedtls_pk_parse_subpubkey(&start, end,
7523 &ssl->handshake->peer_pubkey);
7524 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007525 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007527 }
7528
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007530}
7531#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7532
Gilles Peskine449bd832023-01-11 14:50:10 +01007533int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007534{
7535 int ret = 0;
7536 int crt_expected;
7537#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7538 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7539 ? ssl->handshake->sni_authmode
7540 : ssl->conf->authmode;
7541#else
7542 const int authmode = ssl->conf->authmode;
7543#endif
7544 void *rs_ctx = NULL;
7545 mbedtls_x509_crt *chain = NULL;
7546
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007548
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7550 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7551 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007552 goto exit;
7553 }
7554
7555#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 if (ssl->handshake->ecrs_enabled &&
7557 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007558 chain = ssl->handshake->ecrs_peer_cert;
7559 ssl->handshake->ecrs_peer_cert = NULL;
7560 goto crt_verify;
7561 }
7562#endif
7563
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007565 /* mbedtls_ssl_read_record may have sent an alert already. We
7566 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007567 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007568 goto exit;
7569 }
7570
7571#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007573 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7574
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007576 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 }
Jerry Yud9526692022-02-17 14:23:47 +08007578
7579 goto exit;
7580 }
7581#endif /* MBEDTLS_SSL_SRV_C */
7582
7583 /* Clear existing peer CRT structure in case we tried to
7584 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007586
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7588 if (chain == NULL) {
7589 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7590 sizeof(mbedtls_x509_crt)));
7591 mbedtls_ssl_send_alert_message(ssl,
7592 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7593 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007594
7595 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7596 goto exit;
7597 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007599
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 ret = ssl_parse_certificate_chain(ssl, chain);
7601 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007602 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 }
Jerry Yud9526692022-02-17 14:23:47 +08007604
7605#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007607 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 }
Jerry Yud9526692022-02-17 14:23:47 +08007609
7610crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007612 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 }
Jerry Yud9526692022-02-17 14:23:47 +08007614#endif
7615
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 ret = ssl_parse_certificate_verify(ssl, authmode,
7617 chain, rs_ctx);
7618 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007619 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007620 }
Jerry Yud9526692022-02-17 14:23:47 +08007621
7622#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7623 {
7624 unsigned char *crt_start, *pk_start;
7625 size_t crt_len, pk_len;
7626
7627 /* We parse the CRT chain without copying, so
7628 * these pointers point into the input buffer,
7629 * and are hence still valid after freeing the
7630 * CRT chain. */
7631
7632 crt_start = chain->raw.p;
7633 crt_len = chain->raw.len;
7634
7635 pk_start = chain->pk_raw.p;
7636 pk_len = chain->pk_raw.len;
7637
7638 /* Free the CRT structures before computing
7639 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 mbedtls_x509_crt_free(chain);
7641 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007642 chain = NULL;
7643
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7645 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007646 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 }
Jerry Yud9526692022-02-17 14:23:47 +08007648
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7650 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007651 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 }
Jerry Yud9526692022-02-17 14:23:47 +08007653 }
7654#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7655 /* Pass ownership to session structure. */
7656 ssl->session_negotiate->peer_cert = chain;
7657 chain = NULL;
7658#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7659
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007661
7662exit:
7663
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007665 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 }
Jerry Yud9526692022-02-17 14:23:47 +08007667
7668#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007670 ssl->handshake->ecrs_peer_cert = chain;
7671 chain = NULL;
7672 }
7673#endif
7674
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 if (chain != NULL) {
7676 mbedtls_x509_crt_free(chain);
7677 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007678 }
7679
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007681}
7682#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7683
Andrzej Kurek25f27152022-08-17 16:09:31 -04007684#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007685static int ssl_calc_finished_tls_sha256(
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007687{
7688 int len = 12;
7689 const char *sender;
7690 unsigned char padbuf[32];
7691#if defined(MBEDTLS_USE_PSA_CRYPTO)
7692 size_t hash_size;
7693 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
7694 psa_status_t status;
7695#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007696 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007697 mbedtls_md_context_t sha256;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007698#endif
7699
7700 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007701 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007702 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007704
Gilles Peskine449bd832023-01-11 14:50:10 +01007705 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007706 ? "client finished"
7707 : "server finished";
7708
7709#if defined(MBEDTLS_USE_PSA_CRYPTO)
7710 sha256_psa = psa_hash_operation_init();
7711
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls sha256"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007713
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 status = psa_hash_clone(&ssl->handshake->fin_sha256_psa, &sha256_psa);
7715 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007716 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007717 }
7718
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 status = psa_hash_finish(&sha256_psa, padbuf, sizeof(padbuf), &hash_size);
7720 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007721 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007722 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, 32);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007724#else
7725
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007726 mbedtls_md_init(&sha256);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007727
Gilles Peskine449bd832023-01-11 14:50:10 +01007728 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls sha256"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007729
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007730 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
7731 if (ret != 0) {
7732 goto exit;
7733 }
7734 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
7735 if (ret != 0) {
7736 goto exit;
7737 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007738
7739 /*
7740 * TLSv1.2:
7741 * hash = PRF( master, finished_label,
7742 * Hash( handshake ) )[0.11]
7743 */
7744
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007745 ret = mbedtls_md_finish(&sha256, padbuf);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007746 if (ret != 0) {
7747 goto exit;
7748 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007749#endif /* MBEDTLS_USE_PSA_CRYPTO */
7750
Manuel Pégourié-Gonnard0ac71c02023-02-24 12:13:55 +01007751 MBEDTLS_SSL_DEBUG_BUF(4, "finished sha256 output", padbuf, 32);
7752
Gilles Peskine449bd832023-01-11 14:50:10 +01007753 ssl->handshake->tls_prf(session->master, 48, sender,
7754 padbuf, 32, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007755
Gilles Peskine449bd832023-01-11 14:50:10 +01007756 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007757
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007759
Gilles Peskine449bd832023-01-11 14:50:10 +01007760 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007761
7762exit:
7763#if defined(MBEDTLS_USE_PSA_CRYPTO)
7764 psa_hash_abort(&sha256_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05007765 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007766#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007767 mbedtls_md_free(&sha256);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007768 return ret;
7769#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007770}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04007771#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007772
Jerry Yub7ba49e2022-02-17 14:25:53 +08007773
Andrzej Kurek25f27152022-08-17 16:09:31 -04007774#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007775static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007776 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007777{
7778 int len = 12;
7779 const char *sender;
7780 unsigned char padbuf[48];
7781#if defined(MBEDTLS_USE_PSA_CRYPTO)
7782 size_t hash_size;
7783 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
7784 psa_status_t status;
7785#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007786 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007787 mbedtls_md_context_t sha384;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007788#endif
7789
7790 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007791 if (!session) {
Jerry Yub7ba49e2022-02-17 14:25:53 +08007792 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007794
Gilles Peskine449bd832023-01-11 14:50:10 +01007795 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007796 ? "client finished"
7797 : "server finished";
7798
7799#if defined(MBEDTLS_USE_PSA_CRYPTO)
7800 sha384_psa = psa_hash_operation_init();
7801
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls sha384"));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007803
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 status = psa_hash_clone(&ssl->handshake->fin_sha384_psa, &sha384_psa);
7805 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007806 goto exit;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007807 }
7808
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 status = psa_hash_finish(&sha384_psa, padbuf, sizeof(padbuf), &hash_size);
7810 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007811 goto exit;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007812 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, 48);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007814#else
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007815 mbedtls_md_init(&sha384);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007816
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls sha384"));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007818
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007819 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007820 if (ret != 0) {
7821 goto exit;
7822 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007823 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007824 if (ret != 0) {
7825 goto exit;
7826 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007827
7828 /*
7829 * TLSv1.2:
7830 * hash = PRF( master, finished_label,
7831 * Hash( handshake ) )[0.11]
7832 */
7833
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007834 ret = mbedtls_md_finish(&sha384, padbuf);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007835 if (ret != 0) {
7836 goto exit;
7837 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007838#endif
7839
Manuel Pégourié-Gonnard0ac71c02023-02-24 12:13:55 +01007840 MBEDTLS_SSL_DEBUG_BUF(4, "finished sha384 output", padbuf, 48);
7841
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 ssl->handshake->tls_prf(session->master, 48, sender,
7843 padbuf, 48, buf, len);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007844
Gilles Peskine449bd832023-01-11 14:50:10 +01007845 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007846
Gilles Peskine449bd832023-01-11 14:50:10 +01007847 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007848
Gilles Peskine449bd832023-01-11 14:50:10 +01007849 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007850
7851exit:
7852#if defined(MBEDTLS_USE_PSA_CRYPTO)
7853 psa_hash_abort(&sha384_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05007854 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007855#else
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007856 mbedtls_md_free(&sha384);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007857 return ret;
7858#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yub7ba49e2022-02-17 14:25:53 +08007859}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04007860#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007861
Gilles Peskine449bd832023-01-11 14:50:10 +01007862void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007863{
Gilles Peskine449bd832023-01-11 14:50:10 +01007864 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007865
7866 /*
7867 * Free our handshake params
7868 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007869 mbedtls_ssl_handshake_free(ssl);
7870 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007871 ssl->handshake = NULL;
7872
7873 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007874 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007875 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007876 if (ssl->transform) {
7877 mbedtls_ssl_transform_free(ssl->transform);
7878 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007879 }
7880 ssl->transform = ssl->transform_negotiate;
7881 ssl->transform_negotiate = NULL;
7882
Gilles Peskine449bd832023-01-11 14:50:10 +01007883 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007884}
7885
Gilles Peskine449bd832023-01-11 14:50:10 +01007886void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007887{
7888 int resume = ssl->handshake->resume;
7889
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007891
7892#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007894 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7895 ssl->renego_records_seen = 0;
7896 }
7897#endif
7898
7899 /*
7900 * Free the previous session and switch in the current one
7901 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007902 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007903#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7904 /* RFC 7366 3.1: keep the EtM state */
7905 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007907#endif
7908
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 mbedtls_ssl_session_free(ssl->session);
7910 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007911 }
7912 ssl->session = ssl->session_negotiate;
7913 ssl->session_negotiate = NULL;
7914
7915 /*
7916 * Add cache entry
7917 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007919 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 resume == 0) {
7921 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7922 ssl->session->id,
7923 ssl->session->id_len,
7924 ssl->session) != 0) {
7925 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7926 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007927 }
7928
7929#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7931 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007932 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007934
7935 /* Keep last flight around in case we need to resend it:
7936 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7938 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007939#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007940 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007941
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007942 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007943
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007945}
7946
Gilles Peskine449bd832023-01-11 14:50:10 +01007947int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007948{
7949 int ret, hash_len;
7950
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007952
Gilles Peskine449bd832023-01-11 14:50:10 +01007953 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007954
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007955 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7956 if (ret != 0) {
7957 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7958 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007959
7960 /*
7961 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7962 * may define some other value. Currently (early 2016), no defined
7963 * ciphersuite does this (and this is unlikely to change as activity has
7964 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7965 */
7966 hash_len = 12;
7967
7968#if defined(MBEDTLS_SSL_RENEGOTIATION)
7969 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007971#endif
7972
7973 ssl->out_msglen = 4 + hash_len;
7974 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7975 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7976
7977 /*
7978 * In case of session resuming, invert the client and server
7979 * ChangeCipherSpec messages order.
7980 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007982#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007984 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007985 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007986#endif
7987#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007989 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007991#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007992 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007993 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007995
7996 /*
7997 * Switch to our negotiated transform and session parameters for outbound
7998 * data.
7999 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008001
8002#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008004 unsigned char i;
8005
8006 /* Remember current epoch settings for resending */
8007 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8009 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008010
8011 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008013
8014
8015 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 for (i = 2; i > 0; i--) {
8017 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008018 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 }
8020 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008021
8022 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 if (i == 0) {
8024 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8025 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008026 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008028#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008030
8031 ssl->transform_out = ssl->transform_negotiate;
8032 ssl->session_out = ssl->session_negotiate;
8033
8034#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8036 mbedtls_ssl_send_flight_completed(ssl);
8037 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008038#endif
8039
Gilles Peskine449bd832023-01-11 14:50:10 +01008040 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8041 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8042 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008043 }
8044
8045#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8047 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8048 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8049 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008050 }
8051#endif
8052
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008054
Gilles Peskine449bd832023-01-11 14:50:10 +01008055 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008056}
8057
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008058#define SSL_MAX_HASH_LEN 12
8059
Gilles Peskine449bd832023-01-11 14:50:10 +01008060int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008061{
8062 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8063 unsigned int hash_len = 12;
8064 unsigned char buf[SSL_MAX_HASH_LEN];
8065
Gilles Peskine449bd832023-01-11 14:50:10 +01008066 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008067
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008068 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8069 if (ret != 0) {
8070 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8071 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008072
Gilles Peskine449bd832023-01-11 14:50:10 +01008073 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8074 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008075 goto exit;
8076 }
8077
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8079 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8080 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8081 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008082 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8083 goto exit;
8084 }
8085
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8087 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8088 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008089 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8090 goto exit;
8091 }
8092
Gilles Peskine449bd832023-01-11 14:50:10 +01008093 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8094 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8095 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8096 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008097 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8098 goto exit;
8099 }
8100
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8102 buf, hash_len) != 0) {
8103 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8104 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8105 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008106 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8107 goto exit;
8108 }
8109
8110#if defined(MBEDTLS_SSL_RENEGOTIATION)
8111 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008112 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008113#endif
8114
Gilles Peskine449bd832023-01-11 14:50:10 +01008115 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008116#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008118 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008119 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008120#endif
8121#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008122 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008123 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008124 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008125#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008126 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008127 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008128 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008129
8130#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008131 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8132 mbedtls_ssl_recv_flight_completed(ssl);
8133 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008134#endif
8135
Gilles Peskine449bd832023-01-11 14:50:10 +01008136 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008137
8138exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008139 mbedtls_platform_zeroize(buf, hash_len);
8140 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008141}
8142
Jerry Yu392112c2022-02-17 14:34:10 +08008143#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8144/*
8145 * Helper to get TLS 1.2 PRF from ciphersuite
8146 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8147 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008148static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008149{
Jerry Yu392112c2022-02-17 14:34:10 +08008150 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Andrzej Kurek68327742022-10-03 06:18:18 -04008152#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01008153 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8154 return tls_prf_sha384;
8155 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008156#endif
Andrzej Kurek894edde2022-09-29 06:31:14 -04008157#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
8158 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008159 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8160 return tls_prf_sha256;
8161 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008162 }
8163#endif
8164#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
8165 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
8166 (void) ciphersuite_info;
8167#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008168
Gilles Peskine449bd832023-01-11 14:50:10 +01008169 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008170}
8171#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008172
Gilles Peskine449bd832023-01-11 14:50:10 +01008173static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008174{
8175 ((void) tls_prf);
Andrzej Kurek25f27152022-08-17 16:09:31 -04008176#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01008177 if (tls_prf == tls_prf_sha384) {
8178 return MBEDTLS_SSL_TLS_PRF_SHA384;
8179 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008180#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04008181#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01008182 if (tls_prf == tls_prf_sha256) {
8183 return MBEDTLS_SSL_TLS_PRF_SHA256;
8184 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008185#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008186 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008187}
8188
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008189/*
8190 * Populate a transform structure with session keys and all the other
8191 * necessary information.
8192 *
8193 * Parameters:
8194 * - [in/out]: transform: structure to populate
8195 * [in] must be just initialised with mbedtls_ssl_transform_init()
8196 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8197 * - [in] ciphersuite
8198 * - [in] master
8199 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008200 * - [in] tls_prf: pointer to PRF to use for key derivation
8201 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008202 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008203 * - [in] endpoint: client or server
8204 * - [in] ssl: used for:
8205 * - ssl->conf->{f,p}_export_keys
8206 * [in] optionally used for:
8207 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8208 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008209MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008210static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8211 int ciphersuite,
8212 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008213#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008214 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008215#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008216 ssl_tls_prf_t tls_prf,
8217 const unsigned char randbytes[64],
8218 mbedtls_ssl_protocol_version tls_version,
8219 unsigned endpoint,
8220 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008221{
8222 int ret = 0;
8223 unsigned char keyblk[256];
8224 unsigned char *key1;
8225 unsigned char *key2;
8226 unsigned char *mac_enc;
8227 unsigned char *mac_dec;
8228 size_t mac_key_len = 0;
8229 size_t iv_copy_len;
8230 size_t keylen;
8231 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008232 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008233#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008234 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008235 const mbedtls_md_info_t *md_info;
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_USE_PSA_CRYPTO)
8239 psa_key_type_t key_type;
8240 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8241 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008242 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008243 size_t key_bits;
8244 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8245#endif
8246
8247#if !defined(MBEDTLS_DEBUG_C) && \
8248 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008249 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008250 ssl = NULL; /* make sure we don't use it except for these cases */
8251 (void) ssl;
8252 }
8253#endif
8254
8255 /*
8256 * Some data just needs copying into the structure
8257 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008258#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008259 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008260#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008261 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008262
8263#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008264 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008265#endif
8266
8267#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008268 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008269 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8270 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008272 }
8273#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8274
8275 /*
8276 * Get various info structures
8277 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008278 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8279 if (ciphersuite_info == NULL) {
8280 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8281 ciphersuite));
8282 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008283 }
8284
Neil Armstrongab555e02022-04-04 11:07:59 +02008285 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008286#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008287 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008288#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008289 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008290
Gilles Peskine449bd832023-01-11 14:50:10 +01008291 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008292 transform->taglen =
8293 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008294 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008295
8296#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 if ((status = mbedtls_ssl_cipher_to_psa(ciphersuite_info->cipher,
8298 transform->taglen,
8299 &alg,
8300 &key_type,
8301 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008302 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008304 goto end;
8305 }
8306#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 cipher_info = mbedtls_cipher_info_from_type(ciphersuite_info->cipher);
8308 if (cipher_info == NULL) {
8309 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8310 ciphersuite_info->cipher));
8311 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008312 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008313#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008314
Neil Armstronge4512952022-03-08 09:08:22 +01008315#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008316 mac_alg = mbedtls_hash_info_psa_from_md(ciphersuite_info->mac);
8317 if (mac_alg == 0) {
8318 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_hash_info_psa_from_md for %u not found",
8319 (unsigned) ciphersuite_info->mac));
8320 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008321 }
8322#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008323 md_info = mbedtls_md_info_from_type(ciphersuite_info->mac);
8324 if (md_info == NULL) {
8325 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8326 (unsigned) ciphersuite_info->mac));
8327 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008328 }
Neil Armstronge4512952022-03-08 09:08:22 +01008329#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008330
8331#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8332 /* Copy own and peer's CID if the use of the CID
8333 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008334 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8335 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008336
8337 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8339 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8340 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008341
8342 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008343 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8344 ssl->handshake->peer_cid_len);
8345 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8346 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008347 }
8348#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8349
8350 /*
8351 * Compute key block using the PRF
8352 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008353 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8354 if (ret != 0) {
8355 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8356 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008357 }
8358
Gilles Peskine449bd832023-01-11 14:50:10 +01008359 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8360 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8361 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8362 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8363 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008364
8365 /*
8366 * Determine the appropriate key, IV and MAC length.
8367 */
8368
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008369#if defined(MBEDTLS_USE_PSA_CRYPTO)
8370 keylen = PSA_BITS_TO_BYTES(key_bits);
8371#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008372 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008373#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008374
8375#if defined(MBEDTLS_GCM_C) || \
8376 defined(MBEDTLS_CCM_C) || \
8377 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008378 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008379 size_t explicit_ivlen;
8380
8381 transform->maclen = 0;
8382 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008383
8384 /* All modes haves 96-bit IVs, but the length of the static parts vary
8385 * with mode and version:
8386 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8387 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8388 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8389 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8390 * sequence number).
8391 */
8392 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008393
8394 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008395#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008396 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008397#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008398 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8399 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008400#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008401
Gilles Peskine449bd832023-01-11 14:50:10 +01008402 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008403 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008404 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008405 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008406 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008407
8408 /* Minimum length of encrypted record */
8409 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8410 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008411 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008412#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8413#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008414 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008415 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008416 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008417#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008418 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008419#else
8420 size_t block_size = cipher_info->block_size;
8421#endif /* MBEDTLS_USE_PSA_CRYPTO */
8422
8423#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008424 /* Get MAC length */
8425 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8426#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008427 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8429 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8430 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008431 goto end;
8432 }
8433
8434 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008436#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008437 transform->maclen = mac_key_len;
8438
8439 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008440#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008441 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008442#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008443 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008444#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008445
8446 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008447 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008448 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008449 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008450 /*
8451 * GenericBlockCipher:
8452 * 1. if EtM is in use: one block plus MAC
8453 * otherwise: * first multiple of blocklen greater than maclen
8454 * 2. IV
8455 */
8456#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008457 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008458 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 + block_size;
8460 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008461#endif
8462 {
8463 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008464 + block_size
8465 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008466 }
8467
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008469 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008470 } else {
8471 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008472 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8473 goto end;
8474 }
8475 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008477#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8478 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008479 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8480 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008481 }
8482
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8484 (unsigned) keylen,
8485 (unsigned) transform->minlen,
8486 (unsigned) transform->ivlen,
8487 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008488
8489 /*
8490 * Finally setup the cipher contexts, IVs and MAC secrets.
8491 */
8492#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008493 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008494 key1 = keyblk + mac_key_len * 2;
8495 key2 = keyblk + mac_key_len * 2 + keylen;
8496
8497 mac_enc = keyblk;
8498 mac_dec = keyblk + mac_key_len;
8499
Gilles Peskine449bd832023-01-11 14:50:10 +01008500 iv_copy_len = (transform->fixed_ivlen) ?
8501 transform->fixed_ivlen : transform->ivlen;
8502 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8503 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8504 iv_copy_len);
8505 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008506#endif /* MBEDTLS_SSL_CLI_C */
8507#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008508 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008509 key1 = keyblk + mac_key_len * 2 + keylen;
8510 key2 = keyblk + mac_key_len * 2;
8511
8512 mac_enc = keyblk + mac_key_len;
8513 mac_dec = keyblk;
8514
Gilles Peskine449bd832023-01-11 14:50:10 +01008515 iv_copy_len = (transform->fixed_ivlen) ?
8516 transform->fixed_ivlen : transform->ivlen;
8517 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8518 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8519 iv_copy_len);
8520 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008521#endif /* MBEDTLS_SSL_SRV_C */
8522 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008524 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8525 goto end;
8526 }
8527
Gilles Peskine449bd832023-01-11 14:50:10 +01008528 if (ssl != NULL && ssl->f_export_keys != NULL) {
8529 ssl->f_export_keys(ssl->p_export_keys,
8530 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8531 master, 48,
8532 randbytes + 32,
8533 randbytes,
8534 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008535 }
8536
8537#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008538 transform->psa_alg = alg;
8539
Gilles Peskine449bd832023-01-11 14:50:10 +01008540 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8541 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8542 psa_set_key_algorithm(&attributes, alg);
8543 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008544
Gilles Peskine449bd832023-01-11 14:50:10 +01008545 if ((status = psa_import_key(&attributes,
8546 key1,
8547 PSA_BITS_TO_BYTES(key_bits),
8548 &transform->psa_key_enc)) != PSA_SUCCESS) {
8549 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
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_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008552 goto end;
8553 }
8554
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008556
Gilles Peskine449bd832023-01-11 14:50:10 +01008557 if ((status = psa_import_key(&attributes,
8558 key2,
8559 PSA_BITS_TO_BYTES(key_bits),
8560 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008561 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008563 goto end;
8564 }
8565 }
8566#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008567 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8568 cipher_info)) != 0) {
8569 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008570 goto end;
8571 }
8572
Gilles Peskine449bd832023-01-11 14:50:10 +01008573 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8574 cipher_info)) != 0) {
8575 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008576 goto end;
8577 }
8578
Gilles Peskine449bd832023-01-11 14:50:10 +01008579 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8580 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8581 MBEDTLS_ENCRYPT)) != 0) {
8582 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008583 goto end;
8584 }
8585
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8587 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8588 MBEDTLS_DECRYPT)) != 0) {
8589 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008590 goto end;
8591 }
8592
8593#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8595 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8596 MBEDTLS_PADDING_NONE)) != 0) {
8597 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008598 goto end;
8599 }
8600
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8602 MBEDTLS_PADDING_NONE)) != 0) {
8603 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008604 goto end;
8605 }
8606 }
8607#endif /* MBEDTLS_CIPHER_MODE_CBC */
8608#endif /* MBEDTLS_USE_PSA_CRYPTO */
8609
Neil Armstrong29c0c042022-03-17 17:47:28 +01008610#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8611 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8612 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008613 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008614#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008615 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008616
Gilles Peskine449bd832023-01-11 14:50:10 +01008617 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8618 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8619 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008620
Gilles Peskine449bd832023-01-11 14:50:10 +01008621 if ((status = psa_import_key(&attributes,
8622 mac_enc, mac_key_len,
8623 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008624 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008626 goto end;
8627 }
8628
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8630 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008631#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008632 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008633#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008634 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008635 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008636 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8637 PSA_KEY_USAGE_VERIFY_HASH);
8638 } else {
8639 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8640 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008641
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 if ((status = psa_import_key(&attributes,
8643 mac_dec, mac_key_len,
8644 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008645 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008647 goto end;
8648 }
8649#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008650 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8651 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008652 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008653 }
8654 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8655 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008656 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008657 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008658#endif /* MBEDTLS_USE_PSA_CRYPTO */
8659 }
8660#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8661
8662 ((void) mac_dec);
8663 ((void) mac_enc);
8664
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008665end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008666 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8667 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008668}
8669
Valerio Settia08b1a42022-11-17 15:10:02 +01008670#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8671 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008672int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008673 psa_pake_operation_t *pake_ctx,
8674 const unsigned char *buf,
8675 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008676{
8677 psa_status_t status;
8678 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008679 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008680 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8681 * At round two perform a single cycle
8682 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008683 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008684
Gilles Peskine449bd832023-01-11 14:50:10 +01008685 for (; remaining_steps > 0; remaining_steps--) {
8686 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008687 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008689 /* Length is stored at the first byte */
8690 size_t length = buf[input_offset];
8691 input_offset += 1;
8692
Gilles Peskine449bd832023-01-11 14:50:10 +01008693 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008694 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8695 }
8696
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 status = psa_pake_input(pake_ctx, step,
8698 buf + input_offset, length);
8699 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008700 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008701 }
8702
8703 input_offset += length;
8704 }
8705 }
8706
Gilles Peskine449bd832023-01-11 14:50:10 +01008707 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008708 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008709 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008710
Gilles Peskine449bd832023-01-11 14:50:10 +01008711 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008712}
8713
Valerio Setti6b3dab02022-11-17 17:14:54 +01008714int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008715 psa_pake_operation_t *pake_ctx,
8716 unsigned char *buf,
8717 size_t len, size_t *olen,
8718 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008719{
8720 psa_status_t status;
8721 size_t output_offset = 0;
8722 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008723 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008724 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8725 * At round two perform a single cycle
8726 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008727 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008728
Gilles Peskine449bd832023-01-11 14:50:10 +01008729 for (; remaining_steps > 0; remaining_steps--) {
8730 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8731 step <= PSA_PAKE_STEP_ZK_PROOF;
8732 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008733 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008734 * For each step, prepend 1 byte with the length of the data as
8735 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008736 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008737 status = psa_pake_output(pake_ctx, step,
8738 buf + output_offset + 1,
8739 len - output_offset - 1,
8740 &output_len);
8741 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008742 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008743 }
8744
Valerio Setti99d88c12022-11-22 16:03:43 +01008745 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008746
8747 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008748 }
8749 }
8750
8751 *olen = output_offset;
8752
Gilles Peskine449bd832023-01-11 14:50:10 +01008753 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008754}
Valerio Settia08b1a42022-11-17 15:10:02 +01008755#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8756
Jerry Yuee40f9d2022-02-17 14:55:16 +08008757#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008758int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8759 unsigned char *hash, size_t *hashlen,
8760 unsigned char *data, size_t data_len,
8761 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008762{
8763 psa_status_t status;
8764 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008765 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008766
Gilles Peskine449bd832023-01-11 14:50:10 +01008767 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008768
Gilles Peskine449bd832023-01-11 14:50:10 +01008769 if ((status = psa_hash_setup(&hash_operation,
8770 hash_alg)) != PSA_SUCCESS) {
8771 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008772 goto exit;
8773 }
8774
Gilles Peskine449bd832023-01-11 14:50:10 +01008775 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8776 64)) != PSA_SUCCESS) {
8777 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008778 goto exit;
8779 }
8780
Gilles Peskine449bd832023-01-11 14:50:10 +01008781 if ((status = psa_hash_update(&hash_operation,
8782 data, data_len)) != PSA_SUCCESS) {
8783 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008784 goto exit;
8785 }
8786
Gilles Peskine449bd832023-01-11 14:50:10 +01008787 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8788 hashlen)) != PSA_SUCCESS) {
8789 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8790 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008791 }
8792
8793exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008794 if (status != PSA_SUCCESS) {
8795 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8796 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8797 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008798 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008799 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008800 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8801 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008802 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008803 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008804 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008805 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008806 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008807 }
8808 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008809 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008810}
8811
8812#else
8813
Gilles Peskine449bd832023-01-11 14:50:10 +01008814int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8815 unsigned char *hash, size_t *hashlen,
8816 unsigned char *data, size_t data_len,
8817 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008818{
8819 int ret = 0;
8820 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008821 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8822 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008823
Gilles Peskine449bd832023-01-11 14:50:10 +01008824 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008825
Gilles Peskine449bd832023-01-11 14:50:10 +01008826 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008827
8828 /*
8829 * digitally-signed struct {
8830 * opaque client_random[32];
8831 * opaque server_random[32];
8832 * ServerDHParams params;
8833 * };
8834 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8836 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008837 goto exit;
8838 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008839 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8840 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008841 goto exit;
8842 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008843 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8844 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008845 goto exit;
8846 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008847 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8848 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008849 goto exit;
8850 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008851 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8852 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008853 goto exit;
8854 }
8855
8856exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008857 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008858
Gilles Peskine449bd832023-01-11 14:50:10 +01008859 if (ret != 0) {
8860 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8861 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8862 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008863
Gilles Peskine449bd832023-01-11 14:50:10 +01008864 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008865}
8866#endif /* MBEDTLS_USE_PSA_CRYPTO */
8867
Jerry Yud9d91da2022-02-17 14:57:06 +08008868#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8869
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008870/* Find the preferred hash for a given signature algorithm. */
8871unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008872 mbedtls_ssl_context *ssl,
8873 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008874{
Gabor Mezei078e8032022-04-27 21:17:56 +02008875 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008876 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008877
Gilles Peskine449bd832023-01-11 14:50:10 +01008878 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8879 return MBEDTLS_SSL_HASH_NONE;
8880 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008881
Gilles Peskine449bd832023-01-11 14:50:10 +01008882 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008883 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008884 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8885 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008886 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008887 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8888 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008889
Gilles Peskine449bd832023-01-11 14:50:10 +01008890 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008891#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008892 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008893 psa_algorithm_t psa_hash_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +01008894 mbedtls_hash_info_psa_from_md(hash_alg_received);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008895
Gilles Peskine449bd832023-01-11 14:50:10 +01008896 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8897 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8898 PSA_ALG_ECDSA(psa_hash_alg),
8899 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008900 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008901 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008902
Gilles Peskine449bd832023-01-11 14:50:10 +01008903 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8904 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8905 PSA_ALG_RSA_PKCS1V15_SIGN(
8906 psa_hash_alg),
8907 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008908 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008909 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008910 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008911#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008912
Gilles Peskine449bd832023-01-11 14:50:10 +01008913 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008914 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008915 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008916
Gilles Peskine449bd832023-01-11 14:50:10 +01008917 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008918}
8919
8920#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8921
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008922/* Serialization of TLS 1.2 sessions:
8923 *
8924 * struct {
8925 * uint64 start_time;
8926 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008927 * uint8 session_id_len; // at most 32
8928 * opaque session_id[32];
8929 * opaque master[48]; // fixed length in the standard
8930 * uint32 verify_result;
8931 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8932 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8933 * uint32 ticket_lifetime;
8934 * uint8 mfl_code; // up to 255 according to standard
8935 * uint8 encrypt_then_mac; // 0 or 1
8936 * } serialized_session_tls12;
8937 *
8938 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008939static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8940 unsigned char *buf,
8941 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008942{
8943 unsigned char *p = buf;
8944 size_t used = 0;
8945
8946#if defined(MBEDTLS_HAVE_TIME)
8947 uint64_t start;
8948#endif
8949#if defined(MBEDTLS_X509_CRT_PARSE_C)
8950#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8951 size_t cert_len;
8952#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8953#endif /* MBEDTLS_X509_CRT_PARSE_C */
8954
8955 /*
8956 * Time
8957 */
8958#if defined(MBEDTLS_HAVE_TIME)
8959 used += 8;
8960
Gilles Peskine449bd832023-01-11 14:50:10 +01008961 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008962 start = (uint64_t) session->start;
8963
Gilles Peskine449bd832023-01-11 14:50:10 +01008964 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008965 p += 8;
8966 }
8967#endif /* MBEDTLS_HAVE_TIME */
8968
8969 /*
8970 * Basic mandatory fields
8971 */
8972 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008973 + 1 /* id_len */
8974 + sizeof(session->id)
8975 + sizeof(session->master)
8976 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008977
Gilles Peskine449bd832023-01-11 14:50:10 +01008978 if (used <= buf_len) {
8979 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008980 p += 2;
8981
Gilles Peskine449bd832023-01-11 14:50:10 +01008982 *p++ = MBEDTLS_BYTE_0(session->id_len);
8983 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008984 p += 32;
8985
Gilles Peskine449bd832023-01-11 14:50:10 +01008986 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008987 p += 48;
8988
Gilles Peskine449bd832023-01-11 14:50:10 +01008989 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008990 p += 4;
8991 }
8992
8993 /*
8994 * Peer's end-entity certificate
8995 */
8996#if defined(MBEDTLS_X509_CRT_PARSE_C)
8997#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008998 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008999 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01009000 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009001 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009002 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009003
9004 used += 3 + cert_len;
9005
Gilles Peskine449bd832023-01-11 14:50:10 +01009006 if (used <= buf_len) {
9007 *p++ = MBEDTLS_BYTE_2(cert_len);
9008 *p++ = MBEDTLS_BYTE_1(cert_len);
9009 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009010
Gilles Peskine449bd832023-01-11 14:50:10 +01009011 if (session->peer_cert != NULL) {
9012 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009013 p += cert_len;
9014 }
9015 }
9016#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009018 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009020 *p++ = (unsigned char) session->peer_cert_digest_type;
9021 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009022 memcpy(p, session->peer_cert_digest,
9023 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009024 p += session->peer_cert_digest_len;
9025 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009026 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009027 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009028 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009029 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9030 *p++ = 0;
9031 }
9032 }
9033#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9034#endif /* MBEDTLS_X509_CRT_PARSE_C */
9035
9036 /*
9037 * Session ticket if any, plus associated data
9038 */
9039#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9040 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9041
Gilles Peskine449bd832023-01-11 14:50:10 +01009042 if (used <= buf_len) {
9043 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9044 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9045 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009046
Gilles Peskine449bd832023-01-11 14:50:10 +01009047 if (session->ticket != NULL) {
9048 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009049 p += session->ticket_len;
9050 }
9051
Gilles Peskine449bd832023-01-11 14:50:10 +01009052 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009053 p += 4;
9054 }
9055#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9056
9057 /*
9058 * Misc extension-related info
9059 */
9060#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9061 used += 1;
9062
Gilles Peskine449bd832023-01-11 14:50:10 +01009063 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009064 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009065 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009066#endif
9067
9068#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9069 used += 1;
9070
Gilles Peskine449bd832023-01-11 14:50:10 +01009071 if (used <= buf_len) {
9072 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9073 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009074#endif
9075
Gilles Peskine449bd832023-01-11 14:50:10 +01009076 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009077}
9078
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009079MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009080static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9081 const unsigned char *buf,
9082 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009083{
9084#if defined(MBEDTLS_HAVE_TIME)
9085 uint64_t start;
9086#endif
9087#if defined(MBEDTLS_X509_CRT_PARSE_C)
9088#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9089 size_t cert_len;
9090#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9091#endif /* MBEDTLS_X509_CRT_PARSE_C */
9092
9093 const unsigned char *p = buf;
9094 const unsigned char * const end = buf + len;
9095
9096 /*
9097 * Time
9098 */
9099#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009100 if (8 > (size_t) (end - p)) {
9101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9102 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009103
Gilles Peskine449bd832023-01-11 14:50:10 +01009104 start = ((uint64_t) p[0] << 56) |
9105 ((uint64_t) p[1] << 48) |
9106 ((uint64_t) p[2] << 40) |
9107 ((uint64_t) p[3] << 32) |
9108 ((uint64_t) p[4] << 24) |
9109 ((uint64_t) p[5] << 16) |
9110 ((uint64_t) p[6] << 8) |
9111 ((uint64_t) p[7]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009112 p += 8;
9113
9114 session->start = (time_t) start;
9115#endif /* MBEDTLS_HAVE_TIME */
9116
9117 /*
9118 * Basic mandatory fields
9119 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009120 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9122 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009123
Gilles Peskine449bd832023-01-11 14:50:10 +01009124 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009125 p += 2;
9126
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009127 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009128 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009129 p += 32;
9130
Gilles Peskine449bd832023-01-11 14:50:10 +01009131 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009132 p += 48;
9133
Gilles Peskine449bd832023-01-11 14:50:10 +01009134 session->verify_result = ((uint32_t) p[0] << 24) |
9135 ((uint32_t) p[1] << 16) |
9136 ((uint32_t) p[2] << 8) |
9137 ((uint32_t) p[3]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009138 p += 4;
9139
9140 /* Immediately clear invalid pointer values that have been read, in case
9141 * we exit early before we replaced them with valid ones. */
9142#if defined(MBEDTLS_X509_CRT_PARSE_C)
9143#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9144 session->peer_cert = NULL;
9145#else
9146 session->peer_cert_digest = NULL;
9147#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9148#endif /* MBEDTLS_X509_CRT_PARSE_C */
9149#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9150 session->ticket = NULL;
9151#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9152
9153 /*
9154 * Peer certificate
9155 */
9156#if defined(MBEDTLS_X509_CRT_PARSE_C)
9157#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9158 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009159 if (3 > (size_t) (end - p)) {
9160 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9161 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009162
Gilles Peskine449bd832023-01-11 14:50:10 +01009163 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009164 p += 3;
9165
Gilles Peskine449bd832023-01-11 14:50:10 +01009166 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009167 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9168
Gilles Peskine449bd832023-01-11 14:50:10 +01009169 if (cert_len > (size_t) (end - p)) {
9170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9171 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009172
Gilles Peskine449bd832023-01-11 14:50:10 +01009173 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009174
Gilles Peskine449bd832023-01-11 14:50:10 +01009175 if (session->peer_cert == NULL) {
9176 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9177 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009178
Gilles Peskine449bd832023-01-11 14:50:10 +01009179 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009180
Gilles Peskine449bd832023-01-11 14:50:10 +01009181 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9182 p, cert_len)) != 0) {
9183 mbedtls_x509_crt_free(session->peer_cert);
9184 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009185 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009186 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009187 }
9188
9189 p += cert_len;
9190 }
9191#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9192 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009193 if (2 > (size_t) (end - p)) {
9194 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9195 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009196
9197 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9198 session->peer_cert_digest_len = (size_t) *p++;
9199
Gilles Peskine449bd832023-01-11 14:50:10 +01009200 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009201 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9203 if (md_info == NULL) {
9204 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9205 }
9206 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9207 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9208 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009209
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9211 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9212 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009213
9214 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009215 mbedtls_calloc(1, session->peer_cert_digest_len);
9216 if (session->peer_cert_digest == NULL) {
9217 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9218 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009219
Gilles Peskine449bd832023-01-11 14:50:10 +01009220 memcpy(session->peer_cert_digest, p,
9221 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009222 p += session->peer_cert_digest_len;
9223 }
9224#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9225#endif /* MBEDTLS_X509_CRT_PARSE_C */
9226
9227 /*
9228 * Session ticket and associated data
9229 */
9230#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009231 if (3 > (size_t) (end - p)) {
9232 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9233 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009234
Gilles Peskine449bd832023-01-11 14:50:10 +01009235 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009236 p += 3;
9237
Gilles Peskine449bd832023-01-11 14:50:10 +01009238 if (session->ticket_len != 0) {
9239 if (session->ticket_len > (size_t) (end - p)) {
9240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9241 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009242
Gilles Peskine449bd832023-01-11 14:50:10 +01009243 session->ticket = mbedtls_calloc(1, session->ticket_len);
9244 if (session->ticket == NULL) {
9245 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9246 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009247
Gilles Peskine449bd832023-01-11 14:50:10 +01009248 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009249 p += session->ticket_len;
9250 }
9251
Gilles Peskine449bd832023-01-11 14:50:10 +01009252 if (4 > (size_t) (end - p)) {
9253 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9254 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009255
Gilles Peskine449bd832023-01-11 14:50:10 +01009256 session->ticket_lifetime = ((uint32_t) p[0] << 24) |
9257 ((uint32_t) p[1] << 16) |
9258 ((uint32_t) p[2] << 8) |
9259 ((uint32_t) p[3]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009260 p += 4;
9261#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9262
9263 /*
9264 * Misc extension-related info
9265 */
9266#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009267 if (1 > (size_t) (end - p)) {
9268 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9269 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009270
9271 session->mfl_code = *p++;
9272#endif
9273
9274#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009275 if (1 > (size_t) (end - p)) {
9276 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9277 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009278
9279 session->encrypt_then_mac = *p++;
9280#endif
9281
9282 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009283 if (p != end) {
9284 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9285 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009286
Gilles Peskine449bd832023-01-11 14:50:10 +01009287 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009288}
Jerry Yudc7bd172022-02-17 13:44:15 +08009289#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9290
XiaokangQian75d40ef2022-04-20 11:05:24 +00009291int mbedtls_ssl_validate_ciphersuite(
9292 const mbedtls_ssl_context *ssl,
9293 const mbedtls_ssl_ciphersuite_t *suite_info,
9294 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009295 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009296{
9297 (void) ssl;
9298
Gilles Peskine449bd832023-01-11 14:50:10 +01009299 if (suite_info == NULL) {
9300 return -1;
9301 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009302
Gilles Peskine449bd832023-01-11 14:50:10 +01009303 if ((suite_info->min_tls_version > max_tls_version) ||
9304 (suite_info->max_tls_version < min_tls_version)) {
9305 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009306 }
9307
XiaokangQian060d8672022-04-21 09:24:56 +00009308#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009309#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009310#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009311 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9312 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009313#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009314 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9315 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009316#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009317 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009318 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009319 }
9320#endif
9321
9322 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9323#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009324 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9325 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9326 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009327 }
9328#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9329#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9330
Gilles Peskine449bd832023-01-11 14:50:10 +01009331 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009332}
9333
Ronald Crone68ab4f2022-10-05 12:46:29 +02009334#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009335/*
9336 * Function for writing a signature algorithm extension.
9337 *
9338 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9339 * value (TLS 1.3 RFC8446):
9340 * enum {
9341 * ....
9342 * ecdsa_secp256r1_sha256( 0x0403 ),
9343 * ecdsa_secp384r1_sha384( 0x0503 ),
9344 * ecdsa_secp521r1_sha512( 0x0603 ),
9345 * ....
9346 * } SignatureScheme;
9347 *
9348 * struct {
9349 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9350 * } SignatureSchemeList;
9351 *
9352 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9353 * value (TLS 1.2 RFC5246):
9354 * enum {
9355 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9356 * sha512(6), (255)
9357 * } HashAlgorithm;
9358 *
9359 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9360 * SignatureAlgorithm;
9361 *
9362 * struct {
9363 * HashAlgorithm hash;
9364 * SignatureAlgorithm signature;
9365 * } SignatureAndHashAlgorithm;
9366 *
9367 * SignatureAndHashAlgorithm
9368 * supported_signature_algorithms<2..2^16-2>;
9369 *
9370 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9371 * generalization of the TLS 1.2 signature algorithm extension.
9372 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9373 * `SignatureScheme` field of TLS 1.3
9374 *
9375 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009376int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9377 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009378{
9379 unsigned char *p = buf;
9380 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9381 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9382
9383 *out_len = 0;
9384
Gilles Peskine449bd832023-01-11 14:50:10 +01009385 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009386
9387 /* Check if we have space for header and length field:
9388 * - extension_type (2 bytes)
9389 * - extension_data_length (2 bytes)
9390 * - supported_signature_algorithms_length (2 bytes)
9391 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009392 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009393 p += 6;
9394
9395 /*
9396 * Write supported_signature_algorithms
9397 */
9398 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009399 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9400 if (sig_alg == NULL) {
9401 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9402 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009403
Gilles Peskine449bd832023-01-11 14:50:10 +01009404 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9405 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9406 *sig_alg,
9407 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9408 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009409 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009410 }
9411 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9412 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009413 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009414 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9415 *sig_alg,
9416 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009417 }
9418
9419 /* Length of supported_signature_algorithms */
9420 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009421 if (supported_sig_alg_len == 0) {
9422 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9423 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009424 }
9425
Gilles Peskine449bd832023-01-11 14:50:10 +01009426 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9427 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9428 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009429
XiaokangQianeaf36512022-04-24 09:07:44 +00009430 *out_len = p - buf;
9431
9432#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009433 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009434#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009435
Gilles Peskine449bd832023-01-11 14:50:10 +01009436 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009437}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009438#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009439
XiaokangQian40a35232022-05-07 09:02:40 +00009440#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009441/*
9442 * mbedtls_ssl_parse_server_name_ext
9443 *
9444 * Structure of server_name extension:
9445 *
9446 * enum {
9447 * host_name(0), (255)
9448 * } NameType;
9449 * opaque HostName<1..2^16-1>;
9450 *
9451 * struct {
9452 * NameType name_type;
9453 * select (name_type) {
9454 * case host_name: HostName;
9455 * } name;
9456 * } ServerName;
9457 * struct {
9458 * ServerName server_name_list<1..2^16-1>
9459 * } ServerNameList;
9460 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009461MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009462int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9463 const unsigned char *buf,
9464 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009465{
9466 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9467 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009468 size_t server_name_list_len, hostname_len;
9469 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009470
Gilles Peskine449bd832023-01-11 14:50:10 +01009471 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009472
Gilles Peskine449bd832023-01-11 14:50:10 +01009473 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9474 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009475 p += 2;
9476
Gilles Peskine449bd832023-01-11 14:50:10 +01009477 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009478 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009479 while (p < server_name_list_end) {
9480 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9481 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9482 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9483 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009484
Gilles Peskine449bd832023-01-11 14:50:10 +01009485 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009486 /* sni_name is intended to be used only during the parsing of the
9487 * ClientHello message (it is reset to NULL before the end of
9488 * the message parsing). Thus it is ok to just point to the
9489 * reception buffer and not make a copy of it.
9490 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009491 ssl->handshake->sni_name = p + 3;
9492 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009493 if (ssl->conf->f_sni == NULL) {
9494 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009495 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009496 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9497 ssl, p + 3, hostname_len);
9498 if (ret != 0) {
9499 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9500 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9501 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9502 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9503 }
9504 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009505 }
9506
9507 p += hostname_len + 3;
9508 }
9509
Gilles Peskine449bd832023-01-11 14:50:10 +01009510 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009511}
9512#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9513
XiaokangQianacb39922022-06-17 10:18:48 +00009514#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009515MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009516int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9517 const unsigned char *buf,
9518 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009519{
9520 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009521 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009522 const unsigned char *protocol_name_list;
9523 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009524 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009525
9526 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009527 if (ssl->conf->alpn_list == NULL) {
9528 return 0;
9529 }
XiaokangQianacb39922022-06-17 10:18:48 +00009530
9531 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009532 * RFC7301, section 3.1
9533 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009534 *
XiaokangQianc7403452022-06-23 03:24:12 +00009535 * struct {
9536 * ProtocolName protocol_name_list<2..2^16-1>
9537 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009538 */
9539
XiaokangQianc7403452022-06-23 03:24:12 +00009540 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009541 * protocol_name_list_len 2 bytes
9542 * protocol_name_len 1 bytes
9543 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009544 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009545 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009546
Gilles Peskine449bd832023-01-11 14:50:10 +01009547 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009548 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009549 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009550 protocol_name_list = p;
9551 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009552
9553 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009554 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009555 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009556 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9557 protocol_name_len);
9558 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009559 MBEDTLS_SSL_PEND_FATAL_ALERT(
9560 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009561 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9562 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009563 }
9564
9565 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009566 }
9567
9568 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9570 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009571 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009572 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009573 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009574 if (protocol_name_len == alpn_len &&
9575 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009576 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009577 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009578 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009579
9580 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009581 }
9582 }
9583
XiaokangQian95d5f542022-06-24 02:29:26 +00009584 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009585 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009586 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9587 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9588 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009589}
9590
Gilles Peskine449bd832023-01-11 14:50:10 +01009591int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9592 unsigned char *buf,
9593 unsigned char *end,
9594 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009595{
9596 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009597 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009598 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009599
Gilles Peskine449bd832023-01-11 14:50:10 +01009600 if (ssl->alpn_chosen == NULL) {
9601 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009602 }
9603
Gilles Peskine449bd832023-01-11 14:50:10 +01009604 protocol_name_len = strlen(ssl->alpn_chosen);
9605 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009606
Gilles Peskine449bd832023-01-11 14:50:10 +01009607 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009608 /*
9609 * 0 . 1 ext identifier
9610 * 2 . 3 ext length
9611 * 4 . 5 protocol list length
9612 * 6 . 6 protocol name length
9613 * 7 . 7+n protocol name
9614 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009615 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009616
XiaokangQian95d5f542022-06-24 02:29:26 +00009617 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009618
Gilles Peskine449bd832023-01-11 14:50:10 +01009619 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9620 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009621 /* Note: the length of the chosen protocol has been checked to be less
9622 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9623 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009624 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009625
Gilles Peskine449bd832023-01-11 14:50:10 +01009626 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009627
9628#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009629 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009630#endif
9631
Gilles Peskine449bd832023-01-11 14:50:10 +01009632 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009633}
9634#endif /* MBEDTLS_SSL_ALPN */
9635
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009636#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009637 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009638 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009639 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009640int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9641 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009642{
9643 /* Initialize to suppress unnecessary compiler warning */
9644 size_t hostname_len = 0;
9645
9646 /* Check if new hostname is valid before
9647 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009648 if (hostname != NULL) {
9649 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009650
Gilles Peskine449bd832023-01-11 14:50:10 +01009651 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9652 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9653 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009654 }
9655
9656 /* Now it's clear that we will overwrite the old hostname,
9657 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009658 if (session->hostname != NULL) {
9659 mbedtls_platform_zeroize(session->hostname,
9660 strlen(session->hostname));
9661 mbedtls_free(session->hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009662 }
9663
9664 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009665 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009666 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009667 } else {
9668 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9669 if (session->hostname == NULL) {
9670 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9671 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009672
Gilles Peskine449bd832023-01-11 14:50:10 +01009673 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009674 }
9675
Gilles Peskine449bd832023-01-11 14:50:10 +01009676 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009677}
Xiaokang Qian03409292022-10-12 02:49:52 +00009678#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9679 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009680 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009681 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009682
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009683#endif /* MBEDTLS_SSL_TLS_C */