blob: 2d5d52911e04c4a0c822fcef12870ff164760004 [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
596 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100597 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800598
599 }
600
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800602}
603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800605{
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800607}
608
Jerry Yud25cab02022-10-31 12:48:30 +0800609#if defined(MBEDTLS_DEBUG_C)
610static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800611 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800612 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
613 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
614 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
615 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
616 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
617 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
618 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
619 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
620 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
621 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
622 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
623 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
624 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
625 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
626 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
627 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
628 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
629 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
630 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
631 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
632 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
633 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
634 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
635 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
636 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
637 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
638 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket"
639};
640
Gilles Peskine449bd832023-01-11 14:50:10 +0100641static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800642 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
643 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
644 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
645 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
646 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
647 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
648 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
649 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
650 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
651 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
652 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
653 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
654 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
655 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
656 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
657 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
658 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
659 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
660 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
661 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
662 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
663 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
664 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
665 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
666 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
667 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
668 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
669 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET
670};
671
Gilles Peskine449bd832023-01-11 14:50:10 +0100672const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800673{
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 return extension_name_table[
675 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800676}
677
Gilles Peskine449bd832023-01-11 14:50:10 +0100678static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800679{
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800681 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800683 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800685 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800687 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800689 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800691 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800693 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800695 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800697}
698
Gilles Peskine449bd832023-01-11 14:50:10 +0100699void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
700 int level, const char *file, int line,
701 int hs_msg_type, unsigned int extension_type,
702 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800703{
704 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800706 mbedtls_debug_print_msg(
707 ssl, level, file, line,
708 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 ssl_tls13_get_hs_msg_name(hs_msg_type),
710 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800711 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100712 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800713 return;
714 }
715
716 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800718 mbedtls_debug_print_msg(
719 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
721 mbedtls_ssl_get_extension_name(extension_type), extension_type,
722 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800723 return;
724 }
725
726 mbedtls_debug_print_msg(
727 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
729 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800730}
731
Gilles Peskine449bd832023-01-11 14:50:10 +0100732void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
733 int level, const char *file, int line,
734 int hs_msg_type, uint32_t extensions_mask,
735 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800736{
737
Gilles Peskine449bd832023-01-11 14:50:10 +0100738 for (unsigned i = 0;
739 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
740 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800741 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800742 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800744 }
745}
746
Pengyu Lvee455c02023-01-12 14:37:24 +0800747#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
748#define ARRAY_LENGTH(a) (sizeof(a) / sizeof(*(a)))
749
750static const char *ticket_flag_name_table[] =
751{
752 [0] = "ALLOW_PSK_RESUMPTION",
753 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
754 [3] = "ALLOW_EARLY_DATA",
755};
756
Pengyu Lv4938a562023-01-16 11:28:49 +0800757void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
758 int level, const char *file, int line,
759 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800760{
761 size_t i;
762
763 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800764 "print ticket_flags (0x%02x)", flags);
765
766 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800767
768 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800769 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800770 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
771 ticket_flag_name_table[i]);
772 }
773 }
774}
775#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
776
Jerry Yud25cab02022-10-31 12:48:30 +0800777#endif /* MBEDTLS_DEBUG_C */
778
Gilles Peskine449bd832023-01-11 14:50:10 +0100779void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
780 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800781{
782 ((void) ciphersuite_info);
783
Andrzej Kurek25f27152022-08-17 16:09:31 -0400784#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800786 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800788#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400789#if defined(MBEDTLS_HAS_ALG_SHA_256_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_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800793#endif
794 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800796 return;
797 }
798}
799
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100800int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100801 unsigned hs_type,
802 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100803{
804 unsigned char hs_hdr[4];
805
806 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
808 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
809 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
810 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100811
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100812 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100813}
814
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100815int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100816 unsigned hs_type,
817 unsigned char const *msg,
818 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100819{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100820 int ret;
821 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100822 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100824 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100825 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100826}
827
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100828int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800829{
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100830#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) || \
831 defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100832#if defined(MBEDTLS_USE_PSA_CRYPTO)
833 psa_status_t status;
834#else
835 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
836#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100837#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800838 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100839#endif /* SHA-256 or SHA-384 */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400840#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800841#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100842 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
843 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500844 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100845 }
846 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
847 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500848 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100849 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800850#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100851 mbedtls_md_free(&ssl->handshake->fin_sha256);
852 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100853 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
854 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
855 0);
856 if (ret != 0) {
857 return ret;
858 }
859 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100860 if (ret != 0) {
861 return ret;
862 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800863#endif
864#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400865#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100867 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
868 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500869 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100870 }
871 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
872 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500873 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100874 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800875#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100876 mbedtls_md_free(&ssl->handshake->fin_sha384);
877 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100878 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
879 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
880 if (ret != 0) {
881 return ret;
882 }
883 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100884 if (ret != 0) {
885 return ret;
886 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800887#endif
888#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100889 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800890}
891
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100892static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100893 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800894{
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100895#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) || \
896 defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100897#if defined(MBEDTLS_USE_PSA_CRYPTO)
898 psa_status_t status;
899#else
900 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
901#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100902#else /* SHA-256 or SHA-384 */
903 ((void) ssl);
904 (void) buf;
905 (void) len;
906#endif /* SHA-256 or SHA-384 */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400907#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800908#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100909 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
910 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500911 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100912 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800913#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100914 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100915 if (ret != 0) {
916 return ret;
917 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800918#endif
919#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400920#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800921#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100922 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
923 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500924 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100925 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800926#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100927 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100928 if (ret != 0) {
929 return ret;
930 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800931#endif
932#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100933 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800934}
935
Andrzej Kurek25f27152022-08-17 16:09:31 -0400936#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100937static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100938 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800939{
940#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500941 return PSA_TO_MD_ERR(psa_hash_update(
942 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800943#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100944 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800945#endif
946}
947#endif
948
Andrzej Kurek25f27152022-08-17 16:09:31 -0400949#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100950static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100951 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800952{
953#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500954 return PSA_TO_MD_ERR(psa_hash_update(
955 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800956#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100957 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800958#endif
959}
960#endif
961
Gilles Peskine449bd832023-01-11 14:50:10 +0100962static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200963{
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200965
Andrzej Kurek25f27152022-08-17 16:09:31 -0400966#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#if defined(MBEDTLS_USE_PSA_CRYPTO)
968 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500969#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100970 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200971#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500972#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400973#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500974#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500975 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500976#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100977 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200978#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500979#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200980
981 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100982
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200983#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100984 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200985#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200986#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200988#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200989#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200990#if defined(MBEDTLS_USE_PSA_CRYPTO)
991 handshake->psa_pake_ctx = psa_pake_operation_init();
992 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
993#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200995#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200996#if defined(MBEDTLS_SSL_CLI_C)
997 handshake->ecjpake_cache = NULL;
998 handshake->ecjpake_cache_len = 0;
999#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001000#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001001
Gilles Peskineeccd8882020-03-10 12:19:08 +01001002#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001003 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001004#endif
1005
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001006#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1007 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1008#endif
Hanno Becker75173122019-02-06 16:18:31 +00001009
1010#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1011 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001012 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001013#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001014}
1015
Gilles Peskine449bd832023-01-11 14:50:10 +01001016void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001017{
Gilles Peskine449bd832023-01-11 14:50:10 +01001018 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001019
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001020#if defined(MBEDTLS_USE_PSA_CRYPTO)
1021 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1022 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001023#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1025 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001026#endif
1027
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001028#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001029#if defined(MBEDTLS_USE_PSA_CRYPTO)
1030 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1031 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001032#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 mbedtls_md_init(&transform->md_ctx_enc);
1034 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001035#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001036#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001037}
1038
Gilles Peskine449bd832023-01-11 14:50:10 +01001039void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001040{
Gilles Peskine449bd832023-01-11 14:50:10 +01001041 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001042}
1043
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001044MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001045static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001046{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001047 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1048
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001049 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001050#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001051 if (ssl->transform_negotiate) {
1052 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1053 }
Jerry Yu2e199812022-12-01 18:57:19 +08001054#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (ssl->session_negotiate) {
1056 mbedtls_ssl_session_free(ssl->session_negotiate);
1057 }
1058 if (ssl->handshake) {
1059 mbedtls_ssl_handshake_free(ssl);
1060 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001061
Jerry Yu2e199812022-12-01 18:57:19 +08001062#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001063 /*
1064 * Either the pointers are now NULL or cleared properly and can be freed.
1065 * Now allocate missing structures.
1066 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001067 if (ssl->transform_negotiate == NULL) {
1068 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001069 }
Jerry Yu2e199812022-12-01 18:57:19 +08001070#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001071
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 if (ssl->session_negotiate == NULL) {
1073 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001074 }
Paul Bakker48916f92012-09-16 19:57:18 +00001075
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (ssl->handshake == NULL) {
1077 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001078 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001079#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1080 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001081
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1083 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001084#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001085
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001086 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001088#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001089 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001090#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 ssl->session_negotiate == NULL) {
1092 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001095 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001096
1097#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001099 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001100#endif
1101
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001103 ssl->session_negotiate = NULL;
1104
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001106 }
1107
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001108 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 mbedtls_ssl_session_init(ssl->session_negotiate);
1110 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001111
Jerry Yu2e199812022-12-01 18:57:19 +08001112#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001113 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001114#endif
1115
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001116 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001117 ret = mbedtls_ssl_reset_checksum(ssl);
1118 if (ret != 0) {
1119 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1120 return ret;
1121 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001122
Jerry Yud0766ec2022-09-22 10:46:57 +08001123#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1124 defined(MBEDTLS_SSL_SRV_C) && \
1125 defined(MBEDTLS_SSL_SESSION_TICKETS)
1126 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001128#endif
1129
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001130#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001132 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001133
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001135 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001137 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001139
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001141 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001142#endif
1143
Brett Warrene0edc842021-08-17 09:53:13 +01001144/*
1145 * curve_list is translated to IANA TLS group identifiers here because
1146 * mbedtls_ssl_conf_curves returns void and so can't return
1147 * any error codes.
1148 */
1149#if defined(MBEDTLS_ECP_C)
1150#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1151 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001153 size_t length;
1154 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1155
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE) &&
1157 (length < MBEDTLS_ECP_DP_MAX); length++) {
1158 }
Brett Warrene0edc842021-08-17 09:53:13 +01001159
1160 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1162 if (group_list == NULL) {
1163 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1164 }
Brett Warrene0edc842021-08-17 09:53:13 +01001165
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001167 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 curve_list[i]);
1169 if (tls_id == 0) {
1170 mbedtls_free(group_list);
1171 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001172 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001173 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001174 }
1175
1176 group_list[length] = 0;
1177
1178 ssl->handshake->group_list = group_list;
1179 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001181 ssl->handshake->group_list = ssl->conf->group_list;
1182 ssl->handshake->group_list_heap_allocated = 0;
1183 }
1184#endif /* MBEDTLS_DEPRECATED_REMOVED */
1185#endif /* MBEDTLS_ECP_C */
1186
Ronald Crone68ab4f2022-10-05 12:46:29 +02001187#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001188#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001189#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001190 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1191 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1193 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001194 const int *md;
1195 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001196 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001197 uint16_t *p;
1198
Jerry Yub476a442022-01-21 18:14:45 +08001199#if defined(static_assert)
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 static_assert(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1201 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1202 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001203#endif
1204
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1206 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001207 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 }
Valerio Setti75fba322023-02-23 17:35:09 +01001209#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001211#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001212
Jerry Yub476a442022-01-21 18:14:45 +08001213#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001215#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1217 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1218 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001219 }
1220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1222 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1223 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001224
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1226 sizeof(uint16_t));
1227 if (ssl->handshake->sig_algs == NULL) {
1228 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1229 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001230
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 p = (uint16_t *) ssl->handshake->sig_algs;
1232 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1233 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1234 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001235 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 }
Valerio Setti75fba322023-02-23 17:35:09 +01001237#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001240#endif
1241#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001243 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001244#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001245 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001246 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001247 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001249#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001250 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001251 ssl->handshake->sig_algs_heap_allocated = 0;
1252 }
Jerry Yucc539102022-06-27 16:27:35 +08001253#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001254#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001255 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001256}
1257
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001258#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001259/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001260MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001261static int ssl_cookie_write_dummy(void *ctx,
1262 unsigned char **p, unsigned char *end,
1263 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001264{
1265 ((void) ctx);
1266 ((void) p);
1267 ((void) end);
1268 ((void) cli_id);
1269 ((void) cli_id_len);
1270
Gilles Peskine449bd832023-01-11 14:50:10 +01001271 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001272}
1273
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001274MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001275static int ssl_cookie_check_dummy(void *ctx,
1276 const unsigned char *cookie, size_t cookie_len,
1277 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001278{
1279 ((void) ctx);
1280 ((void) cookie);
1281 ((void) cookie_len);
1282 ((void) cli_id);
1283 ((void) cli_id_len);
1284
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001286}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001287#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001288
Paul Bakker5121ce52009-01-03 21:22:43 +00001289/*
1290 * Initialize an SSL context
1291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001292void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001293{
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001295}
1296
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001297MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001298static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001299{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001300 const mbedtls_ssl_config *conf = ssl->conf;
1301
Ronald Cron6f135e12021-12-08 16:57:54 +01001302#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1304 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1305 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1306 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001307 }
1308
Gilles Peskine449bd832023-01-11 14:50:10 +01001309 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1310 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001311 }
1312#endif
1313
1314#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1316 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1317 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001318 }
1319#endif
1320
Ronald Cron6f135e12021-12-08 16:57:54 +01001321#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1323 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1324 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1325 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001326 }
1327
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 if (conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
1329 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS 1.3 server is not supported yet."));
1330 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian8f9dfe42022-04-15 02:52:39 +00001331 }
1332
1333
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1335 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001336 }
1337#endif
1338
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1340 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001341}
1342
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001343MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001344static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1345{
1346 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 ret = ssl_conf_version_check(ssl);
1348 if (ret != 0) {
1349 return ret;
1350 }
Jerry Yu60835a82021-08-04 10:13:52 +08001351
Jerry Yudef7ae42022-10-30 14:13:19 +08001352#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1353 /* RFC 8446 section 4.4.3
1354 *
1355 * If the verification fails, the receiver MUST terminate the handshake with
1356 * a "decrypt_error" alert.
1357 *
1358 * If the client is configured as TLS 1.3 only with optional verify, return
1359 * bad config.
1360 *
1361 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1363 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001364 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1365 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1366 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001367 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001368 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001369 1, ("Optional verify auth mode "
1370 "is not available for TLS 1.3 client"));
1371 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001372 }
1373#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1374
Jerry Yu60835a82021-08-04 10:13:52 +08001375 /* Space for further checks */
1376
Gilles Peskine449bd832023-01-11 14:50:10 +01001377 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001378}
1379
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001380/*
1381 * Setup an SSL context
1382 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001383
Gilles Peskine449bd832023-01-11 14:50:10 +01001384int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1385 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001386{
Janos Follath865b3eb2019-12-16 11:46:15 +00001387 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001388 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1389 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001390
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001391 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001392
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 if ((ret = ssl_conf_check(ssl)) != 0) {
1394 return ret;
1395 }
Jerry Yu60835a82021-08-04 10:13:52 +08001396
Paul Bakker62f2dee2012-09-28 07:31:51 +00001397 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001398 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001399 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001400
1401 /* Set to NULL in case of an error condition */
1402 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001403
Darryl Greenb33cc762019-11-28 14:29:44 +00001404#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1405 ssl->in_buf_len = in_buf_len;
1406#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001407 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1408 if (ssl->in_buf == NULL) {
1409 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001410 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001411 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001412 }
1413
Darryl Greenb33cc762019-11-28 14:29:44 +00001414#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1415 ssl->out_buf_len = out_buf_len;
1416#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1418 if (ssl->out_buf == NULL) {
1419 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001420 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001421 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001422 }
1423
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001425
Johan Pascalb62bb512015-12-03 21:56:45 +01001426#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001428#endif
1429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001431 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001433
Gilles Peskine449bd832023-01-11 14:50:10 +01001434 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001435
1436error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 mbedtls_free(ssl->in_buf);
1438 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001439
1440 ssl->conf = NULL;
1441
Darryl Greenb33cc762019-11-28 14:29:44 +00001442#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1443 ssl->in_buf_len = 0;
1444 ssl->out_buf_len = 0;
1445#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001446 ssl->in_buf = NULL;
1447 ssl->out_buf = NULL;
1448
1449 ssl->in_hdr = NULL;
1450 ssl->in_ctr = NULL;
1451 ssl->in_len = NULL;
1452 ssl->in_iv = NULL;
1453 ssl->in_msg = NULL;
1454
1455 ssl->out_hdr = NULL;
1456 ssl->out_ctr = NULL;
1457 ssl->out_len = NULL;
1458 ssl->out_iv = NULL;
1459 ssl->out_msg = NULL;
1460
Gilles Peskine449bd832023-01-11 14:50:10 +01001461 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001462}
1463
1464/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001465 * Reset an initialized and used SSL context for re-use while retaining
1466 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001467 *
1468 * If partial is non-zero, keep data in the input buffer and client ID.
1469 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1472 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001473{
Darryl Greenb33cc762019-11-28 14:29:44 +00001474#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1475 size_t in_buf_len = ssl->in_buf_len;
1476 size_t out_buf_len = ssl->out_buf_len;
1477#else
1478 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1479 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1480#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001481
Hanno Beckerb0302c42021-08-03 09:39:42 +01001482#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1483 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001484#endif
1485
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001486 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001488
Gilles Peskine449bd832023-01-11 14:50:10 +01001489 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001490
1491 /* Reset incoming message parsing */
1492 ssl->in_offt = NULL;
1493 ssl->nb_zero = 0;
1494 ssl->in_msgtype = 0;
1495 ssl->in_msglen = 0;
1496 ssl->in_hslen = 0;
1497 ssl->keep_current_message = 0;
1498 ssl->transform_in = NULL;
1499
1500#if defined(MBEDTLS_SSL_PROTO_DTLS)
1501 ssl->next_record_offset = 0;
1502 ssl->in_epoch = 0;
1503#endif
1504
1505 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001507 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001508 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001509 }
1510
Ronald Cronad8c17b2022-06-10 17:18:09 +02001511 ssl->send_alert = 0;
1512
Hanno Beckerb0302c42021-08-03 09:39:42 +01001513 /* Reset outgoing message writing */
1514 ssl->out_msgtype = 0;
1515 ssl->out_msglen = 0;
1516 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 memset(ssl->out_buf, 0, out_buf_len);
1518 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001519 ssl->transform_out = NULL;
1520
1521#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001523#endif
1524
XiaokangQian2b01dc32022-01-21 02:53:13 +00001525#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 if (ssl->transform) {
1527 mbedtls_ssl_transform_free(ssl->transform);
1528 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001529 ssl->transform = NULL;
1530 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1532
XiaokangQian2b01dc32022-01-21 02:53:13 +00001533#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 mbedtls_ssl_transform_free(ssl->transform_application);
1535 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001536 ssl->transform_application = NULL;
1537
Gilles Peskine449bd832023-01-11 14:50:10 +01001538 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001539#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1541 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001542 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001543#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001544
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1546 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001547 ssl->handshake->transform_handshake = NULL;
1548 }
1549
XiaokangQian2b01dc32022-01-21 02:53:13 +00001550#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001551}
1552
Gilles Peskine449bd832023-01-11 14:50:10 +01001553int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001554{
1555 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1556
1557 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1558
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001560
1561 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001562#if defined(MBEDTLS_SSL_RENEGOTIATION)
1563 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001564 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001565
1566 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001567 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1568 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001569#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001571
Hanno Beckerb0302c42021-08-03 09:39:42 +01001572 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001573 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001574 if (ssl->session) {
1575 mbedtls_ssl_session_free(ssl->session);
1576 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001577 ssl->session = NULL;
1578 }
1579
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001580#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001581 ssl->alpn_chosen = NULL;
1582#endif
1583
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001584#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001585 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001586#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001588#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 if (free_cli_id) {
1590 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001591 ssl->cli_id = NULL;
1592 ssl->cli_id_len = 0;
1593 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001594#endif
1595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 if ((ret = ssl_handshake_init(ssl)) != 0) {
1597 return ret;
1598 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001599
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001601}
1602
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001603/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001604 * Reset an initialized and used SSL context for re-use while retaining
1605 * all application-set variables, function pointers and data.
1606 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001607int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001608{
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001610}
1611
1612/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001613 * SSL set accessors
1614 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001615void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001616{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001617 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001618}
1619
Gilles Peskine449bd832023-01-11 14:50:10 +01001620void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001621{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001622 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001623}
1624
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001625#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001626void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001627{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001628 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001629}
1630#endif
1631
Gilles Peskine449bd832023-01-11 14:50:10 +01001632void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001633{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001634 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001635}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001636
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001637#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001638
Gilles Peskine449bd832023-01-11 14:50:10 +01001639void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1640 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001641{
1642 ssl->disable_datagram_packing = !allow_packing;
1643}
1644
Gilles Peskine449bd832023-01-11 14:50:10 +01001645void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1646 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001647{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001648 conf->hs_timeout_min = min;
1649 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001650}
1651#endif
1652
Gilles Peskine449bd832023-01-11 14:50:10 +01001653void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001654{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001655 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001656}
1657
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001658#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001659void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1660 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1661 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001662{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001663 conf->f_vrfy = f_vrfy;
1664 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001665}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001666#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001667
Gilles Peskine449bd832023-01-11 14:50:10 +01001668void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1669 int (*f_rng)(void *, unsigned char *, size_t),
1670 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001671{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001672 conf->f_rng = f_rng;
1673 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001674}
1675
Gilles Peskine449bd832023-01-11 14:50:10 +01001676void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1677 void (*f_dbg)(void *, int, const char *, int, const char *),
1678 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001679{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001680 conf->f_dbg = f_dbg;
1681 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001682}
1683
Gilles Peskine449bd832023-01-11 14:50:10 +01001684void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1685 void *p_bio,
1686 mbedtls_ssl_send_t *f_send,
1687 mbedtls_ssl_recv_t *f_recv,
1688 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001689{
1690 ssl->p_bio = p_bio;
1691 ssl->f_send = f_send;
1692 ssl->f_recv = f_recv;
1693 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001694}
1695
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001696#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001697void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001698{
1699 ssl->mtu = mtu;
1700}
1701#endif
1702
Gilles Peskine449bd832023-01-11 14:50:10 +01001703void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001704{
1705 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001706}
1707
Gilles Peskine449bd832023-01-11 14:50:10 +01001708void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1709 void *p_timer,
1710 mbedtls_ssl_set_timer_t *f_set_timer,
1711 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001712{
1713 ssl->p_timer = p_timer;
1714 ssl->f_set_timer = f_set_timer;
1715 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001716
1717 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001719}
1720
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001722void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1723 void *p_cache,
1724 mbedtls_ssl_cache_get_t *f_get_cache,
1725 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001726{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001727 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001728 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001729 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001730}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001731#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001734int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001735{
Janos Follath865b3eb2019-12-16 11:46:15 +00001736 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001737
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001739 session == NULL ||
1740 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1742 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001743 }
1744
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 if (ssl->handshake->resume == 1) {
1746 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1747 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001748
Jerry Yu21092062022-10-10 21:21:31 +08001749#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001751 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001753
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001755 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1757 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1758 session->ciphersuite));
1759 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001760 }
Jerry Yu40afab62022-10-08 10:42:13 +08001761 }
Jerry Yu21092062022-10-10 21:21:31 +08001762#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001763
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1765 session)) != 0) {
1766 return ret;
1767 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001768
Paul Bakker0a597072012-09-25 21:55:46 +00001769 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001772}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001773#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1776 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001777{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001778 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001779}
1780
Ronald Cron6f135e12021-12-08 16:57:54 +01001781#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001782void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1783 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001784{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001785 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001786}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787
1788#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001789void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
1790 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001791{
1792 conf->early_data_enabled = early_data_enabled;
1793}
Jerry Yucc4e0072022-11-22 17:22:22 +08001794
1795#if defined(MBEDTLS_SSL_SRV_C)
1796void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001797 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001798{
Jerry Yu39da9852022-12-06 16:58:36 +08001799 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001800}
1801#endif /* MBEDTLS_SSL_SRV_C */
1802
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001803#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001804#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001807void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1808 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001809{
1810 conf->cert_profile = profile;
1811}
1812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001814{
1815 mbedtls_ssl_key_cert *cur = key_cert, *next;
1816
Gilles Peskine449bd832023-01-11 14:50:10 +01001817 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001818 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001819 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001820 cur = next;
1821 }
1822}
1823
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001824/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001825MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001826static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1827 mbedtls_x509_crt *cert,
1828 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001829{
niisato8ee24222018-06-25 19:05:48 +09001830 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001831
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001833 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001835 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001837 }
1838
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1840 if (new_cert == NULL) {
1841 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1842 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001843
niisato8ee24222018-06-25 19:05:48 +09001844 new_cert->cert = cert;
1845 new_cert->key = key;
1846 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001847
Glenn Strauss36872db2022-01-22 05:06:31 -05001848 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001850 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001852 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001854 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 }
niisato8ee24222018-06-25 19:05:48 +09001856 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001857 }
1858
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001860}
1861
Gilles Peskine449bd832023-01-11 14:50:10 +01001862int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001863 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001865{
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001867}
1868
Gilles Peskine449bd832023-01-11 14:50:10 +01001869void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001870 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001872{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001873 conf->ca_chain = ca_chain;
1874 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001875
1876#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1877 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1878 * cannot be used together. */
1879 conf->f_ca_cb = NULL;
1880 conf->p_ca_cb = NULL;
1881#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001882}
Hanno Becker5adaad92019-03-27 16:54:37 +00001883
1884#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001885void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1886 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1887 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001888{
1889 conf->f_ca_cb = f_ca_cb;
1890 conf->p_ca_cb = p_ca_cb;
1891
1892 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1893 * cannot be used together. */
1894 conf->ca_chain = NULL;
1895 conf->ca_crl = NULL;
1896}
1897#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001899
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001900#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001901const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1902 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001903{
1904 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001905 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001906}
1907
Gilles Peskine449bd832023-01-11 14:50:10 +01001908int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1909 mbedtls_x509_crt *own_cert,
1910 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001911{
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1913 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001914}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001915
Gilles Peskine449bd832023-01-11 14:50:10 +01001916void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1917 mbedtls_x509_crt *ca_chain,
1918 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001919{
1920 ssl->handshake->sni_ca_chain = ca_chain;
1921 ssl->handshake->sni_ca_crl = ca_crl;
1922}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001923
Glenn Strauss999ef702022-03-11 01:37:23 -05001924#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001925void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1926 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001927{
1928 ssl->handshake->dn_hints = crt;
1929}
1930#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1931
Gilles Peskine449bd832023-01-11 14:50:10 +01001932void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1933 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001934{
1935 ssl->handshake->sni_authmode = authmode;
1936}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001937#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1938
Hanno Becker8927c832019-04-03 12:52:50 +01001939#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001940void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1941 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1942 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001943{
1944 ssl->f_vrfy = f_vrfy;
1945 ssl->p_vrfy = p_vrfy;
1946}
1947#endif
1948
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001949#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001950
Valerio Setti016f6822022-12-09 14:17:50 +01001951#if defined(MBEDTLS_USE_PSA_CRYPTO)
1952static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 mbedtls_ssl_context *ssl,
1954 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001955{
1956 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001957 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001958 uint8_t *user = NULL;
1959 size_t user_len = 0;
1960 uint8_t *peer = NULL;
1961 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1963 psa_pake_cs_set_primitive(&cipher_suite,
1964 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1965 PSA_ECC_FAMILY_SECP_R1,
1966 256));
1967 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001968
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1970 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001971 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001973
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001975 user = (uint8_t *) PSA_JPAKE_SERVER_ID;
1976 user_len = strlen(PSA_JPAKE_SERVER_ID);
1977 peer = (uint8_t *) PSA_JPAKE_CLIENT_ID;
1978 peer_len = strlen(PSA_JPAKE_CLIENT_ID);
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 } else {
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001980 user = (uint8_t *) PSA_JPAKE_CLIENT_ID;
1981 user_len = strlen(PSA_JPAKE_CLIENT_ID);
1982 peer = (uint8_t *) PSA_JPAKE_SERVER_ID;
1983 peer_len = strlen(PSA_JPAKE_SERVER_ID);
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001985
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001986 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1987 if (status != PSA_SUCCESS) {
1988 return status;
1989 }
1990
1991 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001993 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 }
Valerio Setti016f6822022-12-09 14:17:50 +01001995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1997 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001998 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 }
Valerio Setti016f6822022-12-09 14:17:50 +01002000
2001 ssl->handshake->psa_pake_ctx_is_ok = 1;
2002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002004}
2005
Gilles Peskine449bd832023-01-11 14:50:10 +01002006int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2007 const unsigned char *pw,
2008 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002009{
2010 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2011 psa_status_t status;
2012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 if (ssl->handshake == NULL || ssl->conf == NULL) {
2014 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002015 }
2016
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 /* Empty password is not valid */
2018 if ((pw == NULL) || (pw_len == 0)) {
2019 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2020 }
2021
2022 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2023 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2024 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2025
2026 status = psa_import_key(&attributes, pw, pw_len,
2027 &ssl->handshake->psa_pake_password);
2028 if (status != PSA_SUCCESS) {
2029 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2030 }
2031
2032 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2033 ssl->handshake->psa_pake_password);
2034 if (status != PSA_SUCCESS) {
2035 psa_destroy_key(ssl->handshake->psa_pake_password);
2036 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2037 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2038 }
2039
2040 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002041}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002042
Gilles Peskine449bd832023-01-11 14:50:10 +01002043int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2044 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002045{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002046 psa_status_t status;
2047
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 if (ssl->handshake == NULL || ssl->conf == NULL) {
2049 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002050 }
2051
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 if (mbedtls_svc_key_id_is_null(pwd)) {
2053 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2054 }
2055
2056 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2057 if (status != PSA_SUCCESS) {
2058 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2059 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2060 }
2061
2062 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002063}
2064#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002065int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2066 const unsigned char *pw,
2067 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002068{
2069 mbedtls_ecjpake_role role;
2070
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 if (ssl->handshake == NULL || ssl->conf == NULL) {
2072 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2073 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002074
Valerio Settic689ed82022-12-07 14:40:38 +01002075 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if ((pw == NULL) || (pw_len == 0)) {
2077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2078 }
Valerio Settic689ed82022-12-07 14:40:38 +01002079
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002083 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002085
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2087 role,
2088 MBEDTLS_MD_SHA256,
2089 MBEDTLS_ECP_DP_SECP256R1,
2090 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002091}
Valerio Setti02c25b52022-11-15 14:08:42 +01002092#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002093#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002094
Ronald Cron73fe8df2022-10-05 14:31:43 +02002095#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002096int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002097{
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 if (conf->psk_identity == NULL ||
2099 conf->psk_identity_len == 0) {
2100 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002101 }
2102
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002103#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2105 return 1;
2106 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002107#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002108
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 if (conf->psk != NULL && conf->psk_len != 0) {
2110 return 1;
2111 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002112
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002114}
2115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002117{
2118 /* Remove reference to existing PSK, if any. */
2119#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002121 /* The maintenance of the PSK key slot is the
2122 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002123 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002124 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002125#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 if (conf->psk != NULL) {
2127 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 mbedtls_free(conf->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002130 conf->psk = NULL;
2131 conf->psk_len = 0;
2132 }
2133
2134 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 if (conf->psk_identity != NULL) {
2136 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002137 conf->psk_identity = NULL;
2138 conf->psk_identity_len = 0;
2139 }
2140}
2141
Hanno Becker7390c712018-11-15 13:33:04 +00002142/* This function assumes that PSK identity in the SSL config is unset.
2143 * It checks that the provided identity is well-formed and attempts
2144 * to make a copy of it in the SSL config.
2145 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002146MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002147static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2148 unsigned char const *psk_identity,
2149 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002150{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002151 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002153 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 (psk_identity_len >> 16) != 0 ||
2155 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2156 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002157 }
2158
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2160 if (conf->psk_identity == NULL) {
2161 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2162 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002163
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002164 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002168}
2169
Gilles Peskine449bd832023-01-11 14:50:10 +01002170int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2171 const unsigned char *psk, size_t psk_len,
2172 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002173{
Janos Follath865b3eb2019-12-16 11:46:15 +00002174 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002175
2176 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2178 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2179 }
Hanno Becker7390c712018-11-15 13:33:04 +00002180
2181 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 if (psk == NULL) {
2183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2184 }
2185 if (psk_len == 0) {
2186 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2187 }
2188 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2189 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2190 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2193 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2194 }
Hanno Becker7390c712018-11-15 13:33:04 +00002195 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002197
2198 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2200 if (ret != 0) {
2201 ssl_conf_remove_psk(conf);
2202 }
Hanno Becker7390c712018-11-15 13:33:04 +00002203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002205}
2206
Gilles Peskine449bd832023-01-11 14:50:10 +01002207static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002208{
2209#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002211 /* The maintenance of the external PSK key slot is the
2212 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 if (ssl->handshake->psk_opaque_is_internal) {
2214 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002215 ssl->handshake->psk_opaque_is_internal = 0;
2216 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002217 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002218 }
Neil Armstronge952a302022-05-03 10:22:14 +02002219#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 if (ssl->handshake->psk != NULL) {
2221 mbedtls_platform_zeroize(ssl->handshake->psk,
2222 ssl->handshake->psk_len);
2223 mbedtls_free(ssl->handshake->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002224 ssl->handshake->psk_len = 0;
2225 }
Neil Armstronge952a302022-05-03 10:22:14 +02002226#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002227}
2228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2230 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002231{
Neil Armstrong501c9322022-05-03 09:35:09 +02002232#if defined(MBEDTLS_USE_PSA_CRYPTO)
2233 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002234 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002235 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002236 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002237#endif /* MBEDTLS_USE_PSA_CRYPTO */
2238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 if (psk == NULL || ssl->handshake == NULL) {
2240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2241 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002242
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2244 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2245 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002246
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002248
Neil Armstrong501c9322022-05-03 09:35:09 +02002249#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002250#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2252 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2253 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2254 } else {
2255 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2256 }
2257 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002258 }
2259#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002260
Jerry Yu568ec252022-07-22 21:27:34 +08002261#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2263 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2264 psa_set_key_usage_flags(&key_attributes,
2265 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002266 }
2267#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 psa_set_key_algorithm(&key_attributes, alg);
2270 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2273 if (status != PSA_SUCCESS) {
2274 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2275 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002276
2277 /* Allow calling psa_destroy_key() on psk remove */
2278 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002280#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2282 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2283 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002284
2285 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002287
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002289#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002290}
2291
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002292#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002293int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2294 mbedtls_svc_key_id_t psk,
2295 const unsigned char *psk_identity,
2296 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002297{
Janos Follath865b3eb2019-12-16 11:46:15 +00002298 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002299
2300 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2302 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2303 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002304
Hanno Becker7390c712018-11-15 13:33:04 +00002305 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 if (mbedtls_svc_key_id_is_null(psk)) {
2307 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2308 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002309 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002310
2311 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2313 psk_identity_len);
2314 if (ret != 0) {
2315 ssl_conf_remove_psk(conf);
2316 }
Hanno Becker7390c712018-11-15 13:33:04 +00002317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002319}
2320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2322 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002323{
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 if ((mbedtls_svc_key_id_is_null(psk)) ||
2325 (ssl->handshake == NULL)) {
2326 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2327 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002328
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002330 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002332}
2333#endif /* MBEDTLS_USE_PSA_CRYPTO */
2334
Jerry Yu8897c072022-08-12 13:56:53 +08002335#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002336void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2337 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2338 size_t),
2339 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002340{
2341 conf->f_psk = f_psk;
2342 conf->p_psk = p_psk;
2343}
Jerry Yu8897c072022-08-12 13:56:53 +08002344#endif /* MBEDTLS_SSL_SRV_C */
2345
Ronald Cron73fe8df2022-10-05 14:31:43 +02002346#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002347
2348#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002349static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002351{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002352#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (alg == PSA_ALG_CBC_NO_PADDING) {
2354 return MBEDTLS_SSL_MODE_CBC;
2355 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002356#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002357 if (PSA_ALG_IS_AEAD(alg)) {
2358 return MBEDTLS_SSL_MODE_AEAD;
2359 }
2360 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002361}
2362
2363#else /* MBEDTLS_USE_PSA_CRYPTO */
2364
2365static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002367{
2368#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 if (mode == MBEDTLS_MODE_CBC) {
2370 return MBEDTLS_SSL_MODE_CBC;
2371 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002372#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2373
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002374#if defined(MBEDTLS_GCM_C) || \
2375 defined(MBEDTLS_CCM_C) || \
2376 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002378 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 mode == MBEDTLS_MODE_CHACHAPOLY) {
2380 return MBEDTLS_SSL_MODE_AEAD;
2381 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002382#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002383
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002385}
Gilles Peskine301711e2022-04-26 16:57:05 +02002386#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002387
Gilles Peskinee108d982022-04-26 16:50:40 +02002388static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2389 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002391{
2392#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2394 base_mode == MBEDTLS_SSL_MODE_CBC) {
2395 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002396 }
2397#else
2398 (void) encrypt_then_mac;
2399#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002401}
2402
Neil Armstrongab555e02022-04-04 11:07:59 +02002403mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002405{
Gilles Peskinee108d982022-04-26 16:50:40 +02002406 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002407#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002409#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002411#endif
2412 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002413
Gilles Peskinee108d982022-04-26 16:50:40 +02002414 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002415#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002416 encrypt_then_mac = transform->encrypt_then_mac;
2417#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002419}
2420
Neil Armstrongab555e02022-04-04 11:07:59 +02002421mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002422#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002424#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002426{
Gilles Peskinee108d982022-04-26 16:50:40 +02002427 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2428
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002429#if defined(MBEDTLS_USE_PSA_CRYPTO)
2430 psa_status_t status;
2431 psa_algorithm_t alg;
2432 psa_key_type_t type;
2433 size_t size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 status = mbedtls_ssl_cipher_to_psa(suite->cipher, 0, &alg, &type, &size);
2435 if (status == PSA_SUCCESS) {
2436 base_mode = mbedtls_ssl_get_base_mode(alg);
2437 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002438#else
2439 const mbedtls_cipher_info_t *cipher =
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 mbedtls_cipher_info_from_type(suite->cipher);
2441 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002442 base_mode =
2443 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002445 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002446#endif /* MBEDTLS_USE_PSA_CRYPTO */
2447
Gilles Peskinee108d982022-04-26 16:50:40 +02002448#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2449 int encrypt_then_mac = 0;
2450#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002452}
2453
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002454#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002455
2456#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002457/* Serialization of TLS 1.3 sessions:
2458 *
2459 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002460 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002461 * uint64 ticket_received;
2462 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002463 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002464 * } ClientOnlyData;
2465 *
2466 * struct {
2467 * uint8 endpoint;
2468 * uint8 ciphersuite[2];
2469 * uint32 ticket_age_add;
2470 * uint8 ticket_flags;
2471 * opaque resumption_key<0..255>;
2472 * select ( endpoint ) {
2473 * case client: ClientOnlyData;
2474 * case server: uint64 start_time;
2475 * };
2476 * } serialized_session_tls13;
2477 *
2478 */
2479#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002480MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002481static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2482 unsigned char *buf,
2483 size_t buf_len,
2484 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002485{
2486 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002487#if defined(MBEDTLS_SSL_CLI_C) && \
2488 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 size_t hostname_len = (session->hostname == NULL) ?
2490 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002491#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002492 size_t needed = 1 /* endpoint */
2493 + 2 /* ciphersuite */
2494 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002495 + 1 /* ticket_flags */
2496 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002497 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2500 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2501 }
Jerry Yu34191072022-08-18 10:32:09 +08002502 needed += session->resumption_key_len; /* resumption_key */
2503
Jerry Yu438ddd82022-07-07 06:55:50 +00002504#if defined(MBEDTLS_HAVE_TIME)
2505 needed += 8; /* start_time or ticket_received */
2506#endif
2507
2508#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002510#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002511 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002513#endif
2514
Jerry Yu438ddd82022-07-07 06:55:50 +00002515 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002516 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002517
2518 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 if (session->ticket_len > SIZE_MAX - needed) {
2520 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2521 }
Jerry Yu34191072022-08-18 10:32:09 +08002522
Jerry Yue28d9742022-08-18 15:44:03 +08002523 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002524 }
2525#endif /* MBEDTLS_SSL_CLI_C */
2526
Jerry Yue36fdd62022-08-17 21:31:36 +08002527 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 if (needed > buf_len) {
2529 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2530 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002531
2532 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2534 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002535 p[7] = session->ticket_flags;
2536
2537 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002538 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002539 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002541 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002542
2543#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2545 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002546 p += 8;
2547 }
2548#endif /* MBEDTLS_HAVE_TIME */
2549
2550#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002552#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002554 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002556 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002558 p += hostname_len;
2559 }
2560#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2561
Jerry Yu438ddd82022-07-07 06:55:50 +00002562#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002564 p += 8;
2565#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002567 p += 4;
2568
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002570 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 if (session->ticket != NULL && session->ticket_len > 0) {
2573 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002574 p += session->ticket_len;
2575 }
2576 }
2577#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002579}
2580
2581MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002582static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2583 const unsigned char *buf,
2584 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002585{
2586 const unsigned char *p = buf;
2587 const unsigned char *end = buf + len;
2588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 if (end - p < 9) {
2590 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2591 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002592 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2594 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002595 session->ticket_flags = p[7];
2596
2597 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002598 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002599 p += 9;
2600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 if (end - p < session->resumption_key_len) {
2602 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2603 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2606 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2607 }
2608 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002609 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002610
2611#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2613 if (end - p < 8) {
2614 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2615 }
2616 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002617 p += 8;
2618 }
2619#endif /* MBEDTLS_HAVE_TIME */
2620
2621#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002623#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002625 size_t hostname_len;
2626 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 if (end - p < 2) {
2628 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2629 }
2630 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002631 p += 2;
2632
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 if (end - p < (long int) hostname_len) {
2634 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2635 }
2636 if (hostname_len > 0) {
2637 session->hostname = mbedtls_calloc(1, hostname_len);
2638 if (session->hostname == NULL) {
2639 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2640 }
2641 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002642 p += hostname_len;
2643 }
2644#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2645 MBEDTLS_SSL_SESSION_TICKETS */
2646
Jerry Yu438ddd82022-07-07 06:55:50 +00002647#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 if (end - p < 8) {
2649 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2650 }
2651 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002652 p += 8;
2653#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 if (end - p < 4) {
2655 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2656 }
2657 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002658 p += 4;
2659
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 if (end - p < 2) {
2661 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2662 }
2663 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002664 p += 2;
2665
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 if (end - p < (long int) session->ticket_len) {
2667 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2668 }
2669 if (session->ticket_len > 0) {
2670 session->ticket = mbedtls_calloc(1, session->ticket_len);
2671 if (session->ticket == NULL) {
2672 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2673 }
2674 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002675 p += session->ticket_len;
2676 }
2677 }
2678#endif /* MBEDTLS_SSL_CLI_C */
2679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002681
2682}
2683#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002684MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002685static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2686 unsigned char *buf,
2687 size_t buf_len,
2688 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002689{
2690 ((void) session);
2691 ((void) buf);
2692 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002693 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002695}
Jerry Yu438ddd82022-07-07 06:55:50 +00002696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2698 unsigned char *buf,
2699 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002700{
2701 ((void) session);
2702 ((void) buf);
2703 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002705}
2706#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002707#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2708
Gilles Peskine449bd832023-01-11 14:50:10 +01002709psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2710 size_t taglen,
2711 psa_algorithm_t *alg,
2712 psa_key_type_t *key_type,
2713 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002714{
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002716 case MBEDTLS_CIPHER_AES_128_CBC:
2717 *alg = PSA_ALG_CBC_NO_PADDING;
2718 *key_type = PSA_KEY_TYPE_AES;
2719 *key_size = 128;
2720 break;
2721 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002723 *key_type = PSA_KEY_TYPE_AES;
2724 *key_size = 128;
2725 break;
2726 case MBEDTLS_CIPHER_AES_128_GCM:
2727 *alg = PSA_ALG_GCM;
2728 *key_type = PSA_KEY_TYPE_AES;
2729 *key_size = 128;
2730 break;
2731 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002733 *key_type = PSA_KEY_TYPE_AES;
2734 *key_size = 192;
2735 break;
2736 case MBEDTLS_CIPHER_AES_192_GCM:
2737 *alg = PSA_ALG_GCM;
2738 *key_type = PSA_KEY_TYPE_AES;
2739 *key_size = 192;
2740 break;
2741 case MBEDTLS_CIPHER_AES_256_CBC:
2742 *alg = PSA_ALG_CBC_NO_PADDING;
2743 *key_type = PSA_KEY_TYPE_AES;
2744 *key_size = 256;
2745 break;
2746 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002748 *key_type = PSA_KEY_TYPE_AES;
2749 *key_size = 256;
2750 break;
2751 case MBEDTLS_CIPHER_AES_256_GCM:
2752 *alg = PSA_ALG_GCM;
2753 *key_type = PSA_KEY_TYPE_AES;
2754 *key_size = 256;
2755 break;
2756 case MBEDTLS_CIPHER_ARIA_128_CBC:
2757 *alg = PSA_ALG_CBC_NO_PADDING;
2758 *key_type = PSA_KEY_TYPE_ARIA;
2759 *key_size = 128;
2760 break;
2761 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002763 *key_type = PSA_KEY_TYPE_ARIA;
2764 *key_size = 128;
2765 break;
2766 case MBEDTLS_CIPHER_ARIA_128_GCM:
2767 *alg = PSA_ALG_GCM;
2768 *key_type = PSA_KEY_TYPE_ARIA;
2769 *key_size = 128;
2770 break;
2771 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002772 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002773 *key_type = PSA_KEY_TYPE_ARIA;
2774 *key_size = 192;
2775 break;
2776 case MBEDTLS_CIPHER_ARIA_192_GCM:
2777 *alg = PSA_ALG_GCM;
2778 *key_type = PSA_KEY_TYPE_ARIA;
2779 *key_size = 192;
2780 break;
2781 case MBEDTLS_CIPHER_ARIA_256_CBC:
2782 *alg = PSA_ALG_CBC_NO_PADDING;
2783 *key_type = PSA_KEY_TYPE_ARIA;
2784 *key_size = 256;
2785 break;
2786 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002788 *key_type = PSA_KEY_TYPE_ARIA;
2789 *key_size = 256;
2790 break;
2791 case MBEDTLS_CIPHER_ARIA_256_GCM:
2792 *alg = PSA_ALG_GCM;
2793 *key_type = PSA_KEY_TYPE_ARIA;
2794 *key_size = 256;
2795 break;
2796 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2797 *alg = PSA_ALG_CBC_NO_PADDING;
2798 *key_type = PSA_KEY_TYPE_CAMELLIA;
2799 *key_size = 128;
2800 break;
2801 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002803 *key_type = PSA_KEY_TYPE_CAMELLIA;
2804 *key_size = 128;
2805 break;
2806 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2807 *alg = PSA_ALG_GCM;
2808 *key_type = PSA_KEY_TYPE_CAMELLIA;
2809 *key_size = 128;
2810 break;
2811 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002813 *key_type = PSA_KEY_TYPE_CAMELLIA;
2814 *key_size = 192;
2815 break;
2816 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2817 *alg = PSA_ALG_GCM;
2818 *key_type = PSA_KEY_TYPE_CAMELLIA;
2819 *key_size = 192;
2820 break;
2821 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2822 *alg = PSA_ALG_CBC_NO_PADDING;
2823 *key_type = PSA_KEY_TYPE_CAMELLIA;
2824 *key_size = 256;
2825 break;
2826 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002828 *key_type = PSA_KEY_TYPE_CAMELLIA;
2829 *key_size = 256;
2830 break;
2831 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2832 *alg = PSA_ALG_GCM;
2833 *key_type = PSA_KEY_TYPE_CAMELLIA;
2834 *key_size = 256;
2835 break;
2836 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2837 *alg = PSA_ALG_CHACHA20_POLY1305;
2838 *key_type = PSA_KEY_TYPE_CHACHA20;
2839 *key_size = 256;
2840 break;
2841 case MBEDTLS_CIPHER_NULL:
2842 *alg = MBEDTLS_SSL_NULL_CIPHER;
2843 *key_type = 0;
2844 *key_size = 0;
2845 break;
2846 default:
2847 return PSA_ERROR_NOT_SUPPORTED;
2848 }
2849
2850 return PSA_SUCCESS;
2851}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002852#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002853
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002854#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002855int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2856 const unsigned char *dhm_P, size_t P_len,
2857 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002858{
Janos Follath865b3eb2019-12-16 11:46:15 +00002859 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 mbedtls_mpi_free(&conf->dhm_P);
2862 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2865 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2866 mbedtls_mpi_free(&conf->dhm_P);
2867 mbedtls_mpi_free(&conf->dhm_G);
2868 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002869 }
2870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002872}
Paul Bakker5121ce52009-01-03 21:22:43 +00002873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002875{
Janos Follath865b3eb2019-12-16 11:46:15 +00002876 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002877
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 mbedtls_mpi_free(&conf->dhm_P);
2879 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2882 &conf->dhm_P)) != 0 ||
2883 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2884 &conf->dhm_G)) != 0) {
2885 mbedtls_mpi_free(&conf->dhm_P);
2886 mbedtls_mpi_free(&conf->dhm_G);
2887 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002888 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002889
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002891}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002892#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002893
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002894#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2895/*
2896 * Set the minimum length for Diffie-Hellman parameters
2897 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002898void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2899 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002900{
2901 conf->dhm_min_bitlen = bitlen;
2902}
2903#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2904
Ronald Crone68ab4f2022-10-05 12:46:29 +02002905#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002906#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002907/*
2908 * Set allowed/preferred hashes for handshake signatures
2909 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002910void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2911 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002912{
2913 conf->sig_hashes = hashes;
2914}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002915#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002916
Jerry Yuf017ee42022-01-12 15:49:48 +08002917/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002918void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2919 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002920{
Jerry Yuf017ee42022-01-12 15:49:48 +08002921#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2922 conf->sig_hashes = NULL;
2923#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2924 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002925}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002926#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002927
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002928#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002929#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002930/*
2931 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002932 *
2933 * mbedtls_ssl_setup() takes the provided list
2934 * and translates it to a list of IANA TLS group identifiers,
2935 * stored in ssl->handshake->group_list.
2936 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002937 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002938void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2939 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002940{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002941 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002942 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002943}
Brett Warrene0edc842021-08-17 09:53:13 +01002944#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002945#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002946
Brett Warrene0edc842021-08-17 09:53:13 +01002947/*
2948 * Set the allowed groups
2949 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002950void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2951 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002952{
2953#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2954 conf->curve_list = NULL;
2955#endif
2956 conf->group_list = group_list;
2957}
2958
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002959#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002960int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002961{
Hanno Becker947194e2017-04-07 13:25:49 +01002962 /* Initialize to suppress unnecessary compiler warning */
2963 size_t hostname_len = 0;
2964
2965 /* Check if new hostname is valid before
2966 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 if (hostname != NULL) {
2968 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002969
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2971 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2972 }
Hanno Becker947194e2017-04-07 13:25:49 +01002973 }
2974
2975 /* Now it's clear that we will overwrite the old hostname,
2976 * so we can free it safely */
2977
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 if (ssl->hostname != NULL) {
2979 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
2980 mbedtls_free(ssl->hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002981 }
2982
2983 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002986 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 } else {
2988 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2989 if (ssl->hostname == NULL) {
2990 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2991 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002992
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002994
Hanno Becker947194e2017-04-07 13:25:49 +01002995 ssl->hostname[hostname_len] = '\0';
2996 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002997
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002999}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003000#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003001
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003002#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003003void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3004 int (*f_sni)(void *, mbedtls_ssl_context *,
3005 const unsigned char *, size_t),
3006 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003007{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003008 conf->f_sni = f_sni;
3009 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003010}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003011#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003014int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003015{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003016 size_t cur_len, tot_len;
3017 const char **p;
3018
3019 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003020 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3021 * MUST NOT be truncated."
3022 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003023 */
3024 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 for (p = protos; *p != NULL; p++) {
3026 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003027 tot_len += cur_len;
3028
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 if ((cur_len == 0) ||
3030 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3031 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3032 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3033 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003034 }
3035
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003036 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003039}
3040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003042{
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003044}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003045#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003046
Johan Pascalb62bb512015-12-03 21:56:45 +01003047#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003048void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3049 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003050{
3051 conf->dtls_srtp_mki_support = support_mki_value;
3052}
3053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3055 unsigned char *mki_value,
3056 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003057{
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003060 }
Ron Eldor591f1622018-01-22 12:30:04 +02003061
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3063 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003064 }
Ron Eldor591f1622018-01-22 12:30:04 +02003065
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003067 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003069}
3070
Gilles Peskine449bd832023-01-11 14:50:10 +01003071int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3072 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003073{
Johan Pascal253d0262020-09-22 13:04:45 +02003074 const mbedtls_ssl_srtp_profile *p;
3075 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003076
Johan Pascal253d0262020-09-22 13:04:45 +02003077 /* check the profiles list: all entry must be valid,
3078 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3080 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3081 p++) {
3082 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003083 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003085 /* unsupported value, stop parsing and set the size to an error value */
3086 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003087 }
3088 }
3089
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3091 conf->dtls_srtp_profile_list = NULL;
3092 conf->dtls_srtp_profile_list_len = 0;
3093 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003094 }
3095
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003096 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003097 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003098
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003100}
3101
Gilles Peskine449bd832023-01-11 14:50:10 +01003102void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3103 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003104{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003105 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3106 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003108 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003110 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3112 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003113 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003114}
Johan Pascalb62bb512015-12-03 21:56:45 +01003115#endif /* MBEDTLS_SSL_DTLS_SRTP */
3116
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303117#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003118void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003119{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003120 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00003121}
3122
Gilles Peskine449bd832023-01-11 14:50:10 +01003123void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003124{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003125 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00003126}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303127#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003128
Janos Follath088ce432017-04-10 12:42:31 +01003129#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003130void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3131 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003132{
3133 conf->cert_req_ca_list = cert_req_ca_list;
3134}
3135#endif
3136
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003138void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003139{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003140 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003141}
3142#endif
3143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003144#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003145void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003146{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003147 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003148}
3149#endif
3150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003152int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003153{
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3155 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3156 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003157 }
3158
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003159 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003160
Gilles Peskine449bd832023-01-11 14:50:10 +01003161 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003162}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003163#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003164
Gilles Peskine449bd832023-01-11 14:50:10 +01003165void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003166{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003167 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003168}
3169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003171void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003172{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003173 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003174}
3175
Gilles Peskine449bd832023-01-11 14:50:10 +01003176void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003177{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003178 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003179}
3180
Gilles Peskine449bd832023-01-11 14:50:10 +01003181void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3182 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003183{
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003185}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003189#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003190void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003191{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003192 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003193}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003194#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003195
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003196#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003197
Jerry Yud0766ec2022-09-22 10:46:57 +08003198#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003199void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3200 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003201{
Jerry Yud0766ec2022-09-22 10:46:57 +08003202 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003203}
3204#endif
3205
Gilles Peskine449bd832023-01-11 14:50:10 +01003206void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3207 mbedtls_ssl_ticket_write_t *f_ticket_write,
3208 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3209 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003210{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003211 conf->f_ticket_write = f_ticket_write;
3212 conf->f_ticket_parse = f_ticket_parse;
3213 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003214}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003215#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003216#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003217
Gilles Peskine449bd832023-01-11 14:50:10 +01003218void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3219 mbedtls_ssl_export_keys_t *f_export_keys,
3220 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003221{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003222 ssl->f_export_keys = f_export_keys;
3223 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003224}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003225
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003226#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003227void mbedtls_ssl_conf_async_private_cb(
3228 mbedtls_ssl_config *conf,
3229 mbedtls_ssl_async_sign_t *f_async_sign,
3230 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3231 mbedtls_ssl_async_resume_t *f_async_resume,
3232 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003233 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003234{
3235 conf->f_async_sign_start = f_async_sign;
3236 conf->f_async_decrypt_start = f_async_decrypt;
3237 conf->f_async_resume = f_async_resume;
3238 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003239 conf->p_async_config_data = async_config_data;
3240}
3241
Gilles Peskine449bd832023-01-11 14:50:10 +01003242void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003243{
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003245}
3246
Gilles Peskine449bd832023-01-11 14:50:10 +01003247void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003248{
Gilles Peskine449bd832023-01-11 14:50:10 +01003249 if (ssl->handshake == NULL) {
3250 return NULL;
3251 } else {
3252 return ssl->handshake->user_async_ctx;
3253 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003254}
3255
Gilles Peskine449bd832023-01-11 14:50:10 +01003256void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3257 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003258{
Gilles Peskine449bd832023-01-11 14:50:10 +01003259 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003260 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003262}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003263#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003264
Paul Bakker5121ce52009-01-03 21:22:43 +00003265/*
3266 * SSL get accessors
3267 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003268uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003269{
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 if (ssl->session != NULL) {
3271 return ssl->session->verify_result;
3272 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003273
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 if (ssl->session_negotiate != NULL) {
3275 return ssl->session_negotiate->verify_result;
3276 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003277
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003279}
3280
Gilles Peskine449bd832023-01-11 14:50:10 +01003281int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003282{
Gilles Peskine449bd832023-01-11 14:50:10 +01003283 if (ssl == NULL || ssl->session == NULL) {
3284 return 0;
3285 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003286
Gilles Peskine449bd832023-01-11 14:50:10 +01003287 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003288}
3289
Gilles Peskine449bd832023-01-11 14:50:10 +01003290const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003291{
Gilles Peskine449bd832023-01-11 14:50:10 +01003292 if (ssl == NULL || ssl->session == NULL) {
3293 return NULL;
3294 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003295
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003297}
3298
Gilles Peskine449bd832023-01-11 14:50:10 +01003299const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003300{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003301#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003302 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3303 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003304 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003306 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003308 }
3309 }
3310#endif
3311
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003313 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003315 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003317 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003319 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003320}
3321
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003322#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003323size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003324{
David Horstmann95d516f2021-05-04 18:36:56 +01003325 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003326 size_t read_mfl;
3327
Jerry Yuddda0502022-12-01 19:43:12 +08003328#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003329 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3331 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3332 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003333 }
Jerry Yuddda0502022-12-01 19:43:12 +08003334#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003335
3336 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003337 if (ssl->session_out != NULL) {
3338 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3339 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003340 max_len = read_mfl;
3341 }
3342 }
3343
Jerry Yuddda0502022-12-01 19:43:12 +08003344 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003345 if (ssl->session_negotiate != NULL) {
3346 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3347 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003348 max_len = read_mfl;
3349 }
3350 }
3351
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003353}
3354
Gilles Peskine449bd832023-01-11 14:50:10 +01003355size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003356{
3357 size_t max_len;
3358
3359 /*
3360 * Assume mfl_code is correct since it was checked when set
3361 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003363
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003364 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 if (ssl->session_out != NULL &&
3366 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3367 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003368 }
3369
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003370 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 if (ssl->session_negotiate != NULL &&
3372 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3373 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003374 }
3375
Gilles Peskine449bd832023-01-11 14:50:10 +01003376 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003377}
3378#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3379
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003380#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003381size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003382{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003383 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3385 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3386 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3387 return 0;
3388 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003389
Gilles Peskine449bd832023-01-11 14:50:10 +01003390 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3391 return ssl->mtu;
3392 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003393
Gilles Peskine449bd832023-01-11 14:50:10 +01003394 if (ssl->mtu == 0) {
3395 return ssl->handshake->mtu;
3396 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003397
Gilles Peskine449bd832023-01-11 14:50:10 +01003398 return ssl->mtu < ssl->handshake->mtu ?
3399 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003400}
3401#endif /* MBEDTLS_SSL_PROTO_DTLS */
3402
Gilles Peskine449bd832023-01-11 14:50:10 +01003403int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003404{
3405 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3406
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003407#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3408 !defined(MBEDTLS_SSL_PROTO_DTLS)
3409 (void) ssl;
3410#endif
3411
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003412#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003414
Gilles Peskine449bd832023-01-11 14:50:10 +01003415 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003416 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003417 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003418#endif
3419
3420#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003421 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3422 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3423 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003424 const size_t overhead = (size_t) ret;
3425
Gilles Peskine449bd832023-01-11 14:50:10 +01003426 if (ret < 0) {
3427 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003428 }
3429
Gilles Peskine449bd832023-01-11 14:50:10 +01003430 if (mtu <= overhead) {
3431 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3432 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3433 }
3434
3435 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003436 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003437 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003438 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003439#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003440
Hanno Becker0defedb2018-08-10 12:35:02 +01003441#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3442 !defined(MBEDTLS_SSL_PROTO_DTLS)
3443 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003444#endif
3445
Gilles Peskine449bd832023-01-11 14:50:10 +01003446 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003447}
3448
Gilles Peskine449bd832023-01-11 14:50:10 +01003449int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003450{
3451 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3452
3453#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3454 (void) ssl;
3455#endif
3456
3457#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003459
Gilles Peskine449bd832023-01-11 14:50:10 +01003460 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003461 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003462 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003463#endif
3464
Gilles Peskine449bd832023-01-11 14:50:10 +01003465 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003466}
3467
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003468#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003469const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003470{
Gilles Peskine449bd832023-01-11 14:50:10 +01003471 if (ssl == NULL || ssl->session == NULL) {
3472 return NULL;
3473 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003474
Hanno Beckere6824572019-02-07 13:18:46 +00003475#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003476 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003477#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003478 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003479#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003480}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003481#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003483#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003484int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3485 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003486{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003487 int ret;
3488
Gilles Peskine449bd832023-01-11 14:50:10 +01003489 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003490 dst == NULL ||
3491 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003492 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3493 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003494 }
3495
Hanno Beckere810bbc2021-05-14 16:01:05 +01003496 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3497 * idempotent: Each session can only be exported once.
3498 *
3499 * (This is in preparation for TLS 1.3 support where we will
3500 * need the ability to export multiple sessions (aka tickets),
3501 * which will be achieved by calling mbedtls_ssl_get_session()
3502 * multiple times until it fails.)
3503 *
3504 * Check whether we have already exported the current session,
3505 * and fail if so.
3506 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003507 if (ssl->session->exported == 1) {
3508 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3509 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003510
Gilles Peskine449bd832023-01-11 14:50:10 +01003511 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3512 if (ret != 0) {
3513 return ret;
3514 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003515
3516 /* Remember that we've exported the session. */
3517 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003518 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003519}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003521
Paul Bakker5121ce52009-01-03 21:22:43 +00003522/*
Hanno Beckera835da52019-05-16 12:39:07 +01003523 * Define ticket header determining Mbed TLS version
3524 * and structure of the ticket.
3525 */
3526
Hanno Becker94ef3b32019-05-16 12:50:45 +01003527/*
Hanno Becker50b59662019-05-28 14:30:45 +01003528 * Define bitflag determining compile-time settings influencing
3529 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003530 */
3531
Hanno Becker50b59662019-05-28 14:30:45 +01003532#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003533#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003534#else
Hanno Becker3e088662019-05-29 11:10:18 +01003535#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003536#endif /* MBEDTLS_HAVE_TIME */
3537
3538#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003539#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003540#else
Hanno Becker3e088662019-05-29 11:10:18 +01003541#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003542#endif /* MBEDTLS_X509_CRT_PARSE_C */
3543
3544#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003545#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003546#else
Hanno Becker3e088662019-05-29 11:10:18 +01003547#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003548#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3549
3550#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003551#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003552#else
Hanno Becker3e088662019-05-29 11:10:18 +01003553#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003554#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3555
Hanno Becker94ef3b32019-05-16 12:50:45 +01003556#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003557#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003558#else
Hanno Becker3e088662019-05-29 11:10:18 +01003559#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003560#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3561
Hanno Becker94ef3b32019-05-16 12:50:45 +01003562#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3563#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3564#else
3565#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3566#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3567
Hanno Becker3e088662019-05-29 11:10:18 +01003568#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3569#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3570#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3571#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003572#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3573#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003574
Hanno Becker50b59662019-05-28 14:30:45 +01003575#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003576 ((uint16_t) ( \
3577 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3578 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3579 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3580 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3581 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3582 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3583 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003584
Hanno Beckerf8787072019-05-16 12:41:07 +01003585static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003586 MBEDTLS_VERSION_MAJOR,
3587 MBEDTLS_VERSION_MINOR,
3588 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003589 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3590 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003591};
Hanno Beckera835da52019-05-16 12:39:07 +01003592
3593/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003594 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003595 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003596 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003597 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003598 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003599 * opaque mbedtls_version[3]; // library version: major, minor, patch
3600 * opaque session_format[2]; // library-version specific 16-bit field
3601 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003602 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003603 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003604 * Note: When updating the format, remember to keep
3605 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003606 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003607 * // In this version, `session_format` determines
3608 * // the setting of those compile-time
3609 * // configuration options which influence
3610 * // the structure of mbedtls_ssl_session.
3611 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003612 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003613 * // - TLS 1.2 (0x0303)
3614 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003615 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003616 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003617 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003618 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003619 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003620 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003621 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003622 *
3623 * };
3624 *
3625 * } serialized_session;
3626 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003627 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003628
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003629MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003630static int ssl_session_save(const mbedtls_ssl_session *session,
3631 unsigned char omit_header,
3632 unsigned char *buf,
3633 size_t buf_len,
3634 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003635{
3636 unsigned char *p = buf;
3637 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003638 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003639#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3640 size_t out_len;
3641 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3642#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003643 if (session == NULL) {
3644 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3645 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003646
Gilles Peskine449bd832023-01-11 14:50:10 +01003647 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003648 /*
3649 * Add Mbed TLS version identifier
3650 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003651 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003652
Gilles Peskine449bd832023-01-11 14:50:10 +01003653 if (used <= buf_len) {
3654 memcpy(p, ssl_serialized_session_header,
3655 sizeof(ssl_serialized_session_header));
3656 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003657 }
3658 }
3659
3660 /*
3661 * TLS version identifier
3662 */
3663 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003664 if (used <= buf_len) {
3665 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003666 }
3667
3668 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003669 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003670 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003671#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003672 case MBEDTLS_SSL_VERSION_TLS1_2:
3673 used += ssl_tls12_session_save(session, p, remaining_len);
3674 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003675#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3676
Jerry Yu251a12e2022-07-13 15:15:48 +08003677#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003678 case MBEDTLS_SSL_VERSION_TLS1_3:
3679 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3680 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3681 return ret;
3682 }
3683 used += out_len;
3684 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003685#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3686
Gilles Peskine449bd832023-01-11 14:50:10 +01003687 default:
3688 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003689 }
3690
3691 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003692 if (used > buf_len) {
3693 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3694 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003695
Gilles Peskine449bd832023-01-11 14:50:10 +01003696 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003697}
3698
3699/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003700 * Public wrapper for ssl_session_save()
3701 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003702int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3703 unsigned char *buf,
3704 size_t buf_len,
3705 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003706{
Gilles Peskine449bd832023-01-11 14:50:10 +01003707 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003708}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003709
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003710/*
3711 * Deserialize session, see mbedtls_ssl_session_save() for format.
3712 *
3713 * This internal version is wrapped by a public function that cleans up in
3714 * case of error, and has an extra option omit_header.
3715 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003716MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003717static int ssl_session_load(mbedtls_ssl_session *session,
3718 unsigned char omit_header,
3719 const unsigned char *buf,
3720 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003721{
3722 const unsigned char *p = buf;
3723 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003724 size_t remaining_len;
3725
3726
Gilles Peskine449bd832023-01-11 14:50:10 +01003727 if (session == NULL) {
3728 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3729 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003730
Gilles Peskine449bd832023-01-11 14:50:10 +01003731 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003732 /*
3733 * Check Mbed TLS version identifier
3734 */
3735
Gilles Peskine449bd832023-01-11 14:50:10 +01003736 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003738 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003739
3740 if (memcmp(p, ssl_serialized_session_header,
3741 sizeof(ssl_serialized_session_header)) != 0) {
3742 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3743 }
3744 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003745 }
3746
3747 /*
3748 * TLS version identifier
3749 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003750 if (1 > (size_t) (end - p)) {
3751 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3752 }
Glenn Straussda7851c2022-03-14 13:29:48 -04003753 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003754
3755 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003756 remaining_len = (end - p);
3757 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003758#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003759 case MBEDTLS_SSL_VERSION_TLS1_2:
3760 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003761#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3762
Jerry Yu438ddd82022-07-07 06:55:50 +00003763#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003764 case MBEDTLS_SSL_VERSION_TLS1_3:
3765 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003766#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3767
Gilles Peskine449bd832023-01-11 14:50:10 +01003768 default:
3769 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003770 }
3771}
3772
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003773/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003774 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003775 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003776int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3777 const unsigned char *buf,
3778 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003779{
Gilles Peskine449bd832023-01-11 14:50:10 +01003780 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003781
Gilles Peskine449bd832023-01-11 14:50:10 +01003782 if (ret != 0) {
3783 mbedtls_ssl_session_free(session);
3784 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003785
Gilles Peskine449bd832023-01-11 14:50:10 +01003786 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003787}
3788
3789/*
Paul Bakker1961b702013-01-25 14:49:24 +01003790 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003791 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003792MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003793static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003794{
3795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3796
Ronald Cron66dbf912022-02-02 15:33:46 +01003797 /*
3798 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003799 * that were written into the output buffer by the previous handshake step,
3800 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003801 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3802 * We proceed to the next handshake step only when all data from the
3803 * previous one have been sent to the peer, thus we make sure that this is
3804 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3805 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3806 * we have to wait before to go ahead.
3807 * In the case of TLS 1.3, handshake step handlers do not send data to the
3808 * peer. Data are only sent here and through
3809 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003810 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003811 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003812 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3813 return ret;
3814 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003815
3816#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003817 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3818 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3819 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3820 return ret;
3821 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003822 }
3823#endif /* MBEDTLS_SSL_PROTO_DTLS */
3824
Gilles Peskine449bd832023-01-11 14:50:10 +01003825 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003826}
3827
Gilles Peskine449bd832023-01-11 14:50:10 +01003828int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003829{
Hanno Becker41934dd2021-08-07 19:13:43 +01003830 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003831
Gilles Peskine449bd832023-01-11 14:50:10 +01003832 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003833 ssl->conf == NULL ||
3834 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003835 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3836 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003837 }
3838
Gilles Peskine449bd832023-01-11 14:50:10 +01003839 ret = ssl_prepare_handshake_step(ssl);
3840 if (ret != 0) {
3841 return ret;
3842 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003843
Gilles Peskine449bd832023-01-11 14:50:10 +01003844 ret = mbedtls_ssl_handle_pending_alert(ssl);
3845 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003846 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003847 }
Jerry Yue7047812021-09-13 19:26:39 +08003848
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003849 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3850 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3851 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3852
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003853#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003854 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3855 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
3856 mbedtls_ssl_states_str(ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003857
Gilles Peskine449bd832023-01-11 14:50:10 +01003858 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003859 case MBEDTLS_SSL_HELLO_REQUEST:
3860 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003861 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003862 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003863
Ronald Cron9f0fba32022-02-10 16:45:15 +01003864 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003865 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003866 break;
3867
3868 default:
3869#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003870 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3871 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3872 } else {
3873 ret = mbedtls_ssl_handshake_client_step(ssl);
3874 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003875#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003876 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003877#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003878 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003879#endif
3880 }
Jerry Yub9930e72021-08-06 17:11:51 +08003881 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003882#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003883#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003884 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6f135e12021-12-08 16:57:54 +01003885#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003886 if (mbedtls_ssl_conf_is_tls13_only(ssl->conf)) {
3887 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
3888 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003889#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003890
3891#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003892 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf)) {
3893 ret = mbedtls_ssl_handshake_server_step(ssl);
3894 }
Jerry Yub9930e72021-08-06 17:11:51 +08003895#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3896 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003897#endif
3898
Gilles Peskine449bd832023-01-11 14:50:10 +01003899 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003900 /* handshake_step return error. And it is same
3901 * with alert_reason.
3902 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003903 if (ssl->send_alert) {
3904 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003905 goto cleanup;
3906 }
3907 }
3908
3909cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003910 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003911}
3912
3913/*
3914 * Perform the SSL handshake
3915 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003916int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003917{
3918 int ret = 0;
3919
Hanno Beckera817ea42020-10-20 15:20:23 +01003920 /* Sanity checks */
3921
Gilles Peskine449bd832023-01-11 14:50:10 +01003922 if (ssl == NULL || ssl->conf == NULL) {
3923 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3924 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003925
Hanno Beckera817ea42020-10-20 15:20:23 +01003926#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003927 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3928 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3929 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3930 "mbedtls_ssl_set_timer_cb() for DTLS"));
3931 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003932 }
3933#endif /* MBEDTLS_SSL_PROTO_DTLS */
3934
Gilles Peskine449bd832023-01-11 14:50:10 +01003935 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003936
Hanno Beckera817ea42020-10-20 15:20:23 +01003937 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3939 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003940
Gilles Peskine449bd832023-01-11 14:50:10 +01003941 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003942 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003943 }
Paul Bakker1961b702013-01-25 14:49:24 +01003944 }
3945
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003947
Gilles Peskine449bd832023-01-11 14:50:10 +01003948 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003949}
3950
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003951#if defined(MBEDTLS_SSL_RENEGOTIATION)
3952#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003953/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003954 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003955 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003956MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003957static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003958{
Janos Follath865b3eb2019-12-16 11:46:15 +00003959 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003960
Gilles Peskine449bd832023-01-11 14:50:10 +01003961 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003962
3963 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003964 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3965 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003966
Gilles Peskine449bd832023-01-11 14:50:10 +01003967 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3968 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3969 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003970 }
3971
Gilles Peskine449bd832023-01-11 14:50:10 +01003972 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003973
Gilles Peskine449bd832023-01-11 14:50:10 +01003974 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003975}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003976#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003977
3978/*
3979 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003980 * - any side: calling mbedtls_ssl_renegotiate(),
3981 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3982 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003983 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003984 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003985 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003986 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003987int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003988{
Janos Follath865b3eb2019-12-16 11:46:15 +00003989 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003990
Gilles Peskine449bd832023-01-11 14:50:10 +01003991 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00003992
Gilles Peskine449bd832023-01-11 14:50:10 +01003993 if ((ret = ssl_handshake_init(ssl)) != 0) {
3994 return ret;
3995 }
Paul Bakker48916f92012-09-16 19:57:18 +00003996
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003997 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3998 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003999#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004000 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4001 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4002 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004003 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004004 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004005 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004006 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004007 }
4008#endif
4009
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004010 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4011 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004012
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4014 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4015 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004016 }
4017
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004019
Gilles Peskine449bd832023-01-11 14:50:10 +01004020 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004021}
4022
4023/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004024 * Renegotiate current connection on client,
4025 * or request renegotiation on server
4026 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004027int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004028{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004029 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004030
Gilles Peskine449bd832023-01-11 14:50:10 +01004031 if (ssl == NULL || ssl->conf == NULL) {
4032 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4033 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004034
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004035#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004036 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4038 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4039 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4040 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004042 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004043
4044 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004045 if (ssl->out_left != 0) {
4046 return mbedtls_ssl_flush_output(ssl);
4047 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004048
Gilles Peskine449bd832023-01-11 14:50:10 +01004049 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004050 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004051#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004052
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004053#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004054 /*
4055 * On client, either start the renegotiation process or,
4056 * if already in progress, continue the handshake
4057 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4059 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4060 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004061 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004062
4063 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4064 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4065 return ret;
4066 }
4067 } else {
4068 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4069 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4070 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004071 }
4072 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004073#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004074
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004076}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004077#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004078
Gilles Peskine449bd832023-01-11 14:50:10 +01004079void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004080{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004081 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4082
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004084 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004086
Brett Warrene0edc842021-08-17 09:53:13 +01004087#if defined(MBEDTLS_ECP_C)
4088#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004089 if (ssl->handshake->group_list_heap_allocated) {
4090 mbedtls_free((void *) handshake->group_list);
4091 }
Brett Warrene0edc842021-08-17 09:53:13 +01004092 handshake->group_list = NULL;
4093#endif /* MBEDTLS_DEPRECATED_REMOVED */
4094#endif /* MBEDTLS_ECP_C */
4095
Ronald Crone68ab4f2022-10-05 12:46:29 +02004096#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004097#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004098 if (ssl->handshake->sig_algs_heap_allocated) {
4099 mbedtls_free((void *) handshake->sig_algs);
4100 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004101 handshake->sig_algs = NULL;
4102#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004103#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 if (ssl->handshake->certificate_request_context) {
4105 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004106 }
4107#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004108#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004109
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004110#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4112 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004113 handshake->async_in_progress = 0;
4114 }
4115#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4116
Andrzej Kurek25f27152022-08-17 16:09:31 -04004117#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004118#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004120#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004121 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004122#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004123#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004124#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004125#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004127#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004128 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004129#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004130#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004131
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004132#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004134#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02004135#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004137#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004138
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004139#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004140#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004141 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004142 /*
4143 * Opaque keys are not stored in the handshake's data and it's the user
4144 * responsibility to destroy them. Clear ones, instead, are created by
4145 * the TLS library and should be destroyed at the same level
4146 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4148 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004149 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004150 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4151#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004153#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004154#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004156 handshake->ecjpake_cache = NULL;
4157 handshake->ecjpake_cache_len = 0;
4158#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004159#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004160
Janos Follath4ae5c292016-02-10 11:27:43 +00004161#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4162 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004163 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004165#endif
4166
Ronald Cron73fe8df2022-10-05 14:31:43 +02004167#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004168#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004169 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004170 /* The maintenance of the external PSK key slot is the
4171 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 if (ssl->handshake->psk_opaque_is_internal) {
4173 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004174 ssl->handshake->psk_opaque_is_internal = 0;
4175 }
4176 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4177 }
Neil Armstronge952a302022-05-03 10:22:14 +02004178#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 if (handshake->psk != NULL) {
4180 mbedtls_platform_zeroize(handshake->psk, handshake->psk_len);
4181 mbedtls_free(handshake->psk);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004182 }
Neil Armstronge952a302022-05-03 10:22:14 +02004183#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004184#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004186#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4187 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004188 /*
4189 * Free only the linked list wrapper, not the keys themselves
4190 * since the belong to the SNI callback
4191 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004193#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004194
Gilles Peskineeccd8882020-03-10 12:19:08 +01004195#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4197 if (handshake->ecrs_peer_cert != NULL) {
4198 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4199 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004200 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004201#endif
4202
Hanno Becker75173122019-02-06 16:18:31 +00004203#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4204 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004206#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4207
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004208#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4210 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004211#endif /* MBEDTLS_SSL_CLI_C &&
4212 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004213
4214#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 mbedtls_ssl_flight_free(handshake->flight);
4216 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004217#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004218
Ronald Cronf12b81d2022-03-15 10:42:41 +01004219#if defined(MBEDTLS_ECDH_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 (defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4221 if (handshake->ecdh_psa_privkey_is_external == 0) {
4222 psa_destroy_key(handshake->ecdh_psa_privkey);
4223 }
Hanno Becker4a63ed42019-01-08 11:39:35 +00004224#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
4225
Ronald Cron6f135e12021-12-08 16:57:54 +01004226#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 mbedtls_ssl_transform_free(handshake->transform_handshake);
4228 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004229#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004230 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4231 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004232#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004233#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004234
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004235
4236#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4237 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4238 * processes datagrams and the fact that a datagram is allowed to have
4239 * several records in it, it is possible that the I/O buffers are not
4240 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4242 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004243#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004244
Jerry Yuba9c7272021-10-30 11:54:10 +08004245 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 mbedtls_platform_zeroize(handshake,
4247 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004248}
4249
Gilles Peskine449bd832023-01-11 14:50:10 +01004250void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004251{
Gilles Peskine449bd832023-01-11 14:50:10 +01004252 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004253 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004255
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004256#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004258#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004259
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004260#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004261#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4262 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004264#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004266#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004267
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004269}
4270
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004271#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004272
4273#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4274#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4275#else
4276#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4277#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4278
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004279#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004280
4281#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4282#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4283#else
4284#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4285#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4286
4287#if defined(MBEDTLS_SSL_ALPN)
4288#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4289#else
4290#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4291#endif /* MBEDTLS_SSL_ALPN */
4292
4293#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4294#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4295#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4296#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4297
4298#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 ((uint32_t) ( \
4300 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4301 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4302 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4303 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4304 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4305 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4306 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4307 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004308
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004309static unsigned char ssl_serialized_context_header[] = {
4310 MBEDTLS_VERSION_MAJOR,
4311 MBEDTLS_VERSION_MINOR,
4312 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4314 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4315 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4316 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4317 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004318};
4319
Paul Bakker5121ce52009-01-03 21:22:43 +00004320/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004321 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004322 *
4323 * The format of the serialized data is:
4324 * (in the presentation language of TLS, RFC 8446 section 3)
4325 *
4326 * // header
4327 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004328 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004329 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004330 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004331 * Note: When updating the format, remember to keep these
4332 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004333 *
4334 * // session sub-structure
4335 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4336 * // transform sub-structure
4337 * uint8 random[64]; // ServerHello.random+ClientHello.random
4338 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4339 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4340 * // fields from ssl_context
4341 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4342 * uint64 in_window_top; // DTLS: last validated record seq_num
4343 * uint64 in_window; // DTLS: bitmask for replay protection
4344 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4345 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4346 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4347 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4348 *
4349 * Note that many fields of the ssl_context or sub-structures are not
4350 * serialized, as they fall in one of the following categories:
4351 *
4352 * 1. forced value (eg in_left must be 0)
4353 * 2. pointer to dynamically-allocated memory (eg session, transform)
4354 * 3. value can be re-derived from other data (eg session keys from MS)
4355 * 4. value was temporary (eg content of input buffer)
4356 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004357 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004358int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4359 unsigned char *buf,
4360 size_t buf_len,
4361 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004362{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004363 unsigned char *p = buf;
4364 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004365 size_t session_len;
4366 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004367
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004368 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004369 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4370 * this function's documentation.
4371 *
4372 * These are due to assumptions/limitations in the implementation. Some of
4373 * them are likely to stay (no handshake in progress) some might go away
4374 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004375 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004376 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4378 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4379 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004380 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 if (ssl->handshake != NULL) {
4382 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4383 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004384 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004385 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 if (ssl->transform == NULL || ssl->session == NULL) {
4387 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4388 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004389 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004390 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 if (mbedtls_ssl_check_pending(ssl) != 0) {
4392 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4393 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004394 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 if (ssl->out_left != 0) {
4396 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4397 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004398 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004399 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4401 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4402 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004403 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004404 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4406 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4407 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004408 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004409 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4411 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4412 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004413 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004414 /* Renegotiation must not be enabled */
4415#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4417 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4418 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004419 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004420#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004421
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004422 /*
4423 * Version and format identifier
4424 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004426
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 if (used <= buf_len) {
4428 memcpy(p, ssl_serialized_context_header,
4429 sizeof(ssl_serialized_context_header));
4430 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004431 }
4432
4433 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004434 * Session (length + data)
4435 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4437 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4438 return ret;
4439 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004440
4441 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (used <= buf_len) {
4443 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004444 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004445
Gilles Peskine449bd832023-01-11 14:50:10 +01004446 ret = ssl_session_save(ssl->session, 1,
4447 p, session_len, &session_len);
4448 if (ret != 0) {
4449 return ret;
4450 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004451
4452 p += session_len;
4453 }
4454
4455 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004456 * Transform
4457 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 used += sizeof(ssl->transform->randbytes);
4459 if (used <= buf_len) {
4460 memcpy(p, ssl->transform->randbytes,
4461 sizeof(ssl->transform->randbytes));
4462 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004463 }
4464
4465#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4466 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004468 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004470 p += ssl->transform->in_cid_len;
4471
4472 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004474 p += ssl->transform->out_cid_len;
4475 }
4476#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4477
4478 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004479 * Saved fields from top-level ssl_context structure
4480 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004481 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 if (used <= buf_len) {
4483 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004484 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004485 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004486
4487#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4488 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 if (used <= buf_len) {
4490 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004491 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004492
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004494 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004495 }
4496#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4497
4498#if defined(MBEDTLS_SSL_PROTO_DTLS)
4499 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004501 *p++ = ssl->disable_datagram_packing;
4502 }
4503#endif /* MBEDTLS_SSL_PROTO_DTLS */
4504
Jerry Yuae0b2e22021-10-08 15:21:19 +08004505 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 if (used <= buf_len) {
4507 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004508 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004509 }
4510
4511#if defined(MBEDTLS_SSL_PROTO_DTLS)
4512 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 if (used <= buf_len) {
4514 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004515 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004516 }
4517#endif /* MBEDTLS_SSL_PROTO_DTLS */
4518
4519#if defined(MBEDTLS_SSL_ALPN)
4520 {
4521 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004523 : 0;
4524
4525 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004527 *p++ = alpn_len;
4528
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 if (ssl->alpn_chosen != NULL) {
4530 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004531 p += alpn_len;
4532 }
4533 }
4534 }
4535#endif /* MBEDTLS_SSL_ALPN */
4536
4537 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004538 * Done
4539 */
4540 *olen = used;
4541
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 if (used > buf_len) {
4543 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4544 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004545
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004547
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004549}
4550
4551/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004552 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004553 *
4554 * This internal version is wrapped by a public function that cleans up in
4555 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004556 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004557MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004558static int ssl_context_load(mbedtls_ssl_context *ssl,
4559 const unsigned char *buf,
4560 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004561{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004562 const unsigned char *p = buf;
4563 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004564 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004565 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004566#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004567 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004568#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004569
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004570 /*
4571 * The context should have been freshly setup or reset.
4572 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004573 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004574 * renegotiating, or if the user mistakenly loaded a session first.)
4575 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4577 ssl->session != NULL) {
4578 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004579 }
4580
4581 /*
4582 * We can't check that the config matches the initial one, but we can at
4583 * least check it matches the requirements for serializing.
4584 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004586 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4587 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004588#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004589 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004590#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 0) {
4592 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004593 }
4594
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004596
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004597 /*
4598 * Check version identifier
4599 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4601 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004602 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004603
4604 if (memcmp(p, ssl_serialized_context_header,
4605 sizeof(ssl_serialized_context_header)) != 0) {
4606 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4607 }
4608 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004609
4610 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004611 * Session
4612 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 if ((size_t) (end - p) < 4) {
4614 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4615 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004616
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 session_len = ((size_t) p[0] << 24) |
4618 ((size_t) p[1] << 16) |
4619 ((size_t) p[2] << 8) |
4620 ((size_t) p[3]);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004621 p += 4;
4622
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004623 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004624 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004625 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004626 ssl->session_in = ssl->session;
4627 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004628 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004629
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 if ((size_t) (end - p) < session_len) {
4631 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4632 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004633
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 ret = ssl_session_load(ssl->session, 1, p, session_len);
4635 if (ret != 0) {
4636 mbedtls_ssl_session_free(ssl->session);
4637 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004638 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004639
4640 p += session_len;
4641
4642 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004643 * Transform
4644 */
4645
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004646 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004647 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004648#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004649 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004650 ssl->transform_in = ssl->transform;
4651 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004652 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004653#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004654
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004655#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4657 if (prf_func == NULL) {
4658 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4659 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004660
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004661 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4663 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4664 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004665
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 ret = ssl_tls12_populate_transform(ssl->transform,
4667 ssl->session->ciphersuite,
4668 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004669#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004671#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 prf_func,
4673 p, /* currently pointing to randbytes */
4674 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4675 ssl->conf->endpoint,
4676 ssl);
4677 if (ret != 0) {
4678 return ret;
4679 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004680#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004682
4683#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4684 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 if ((size_t) (end - p) < 1) {
4686 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4687 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004688
4689 ssl->transform->in_cid_len = *p++;
4690
Gilles Peskine449bd832023-01-11 14:50:10 +01004691 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4692 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4693 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004694
Gilles Peskine449bd832023-01-11 14:50:10 +01004695 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004696 p += ssl->transform->in_cid_len;
4697
4698 ssl->transform->out_cid_len = *p++;
4699
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4701 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4702 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004703
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004705 p += ssl->transform->out_cid_len;
4706#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4707
4708 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004709 * Saved fields from top-level ssl_context structure
4710 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 if ((size_t) (end - p) < 4) {
4712 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4713 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004714
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 ssl->badmac_seen = ((uint32_t) p[0] << 24) |
4716 ((uint32_t) p[1] << 16) |
4717 ((uint32_t) p[2] << 8) |
4718 ((uint32_t) p[3]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004719 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004720
4721#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 if ((size_t) (end - p) < 16) {
4723 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4724 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004725
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 ssl->in_window_top = ((uint64_t) p[0] << 56) |
4727 ((uint64_t) p[1] << 48) |
4728 ((uint64_t) p[2] << 40) |
4729 ((uint64_t) p[3] << 32) |
4730 ((uint64_t) p[4] << 24) |
4731 ((uint64_t) p[5] << 16) |
4732 ((uint64_t) p[6] << 8) |
4733 ((uint64_t) p[7]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004734 p += 8;
4735
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 ssl->in_window = ((uint64_t) p[0] << 56) |
4737 ((uint64_t) p[1] << 48) |
4738 ((uint64_t) p[2] << 40) |
4739 ((uint64_t) p[3] << 32) |
4740 ((uint64_t) p[4] << 24) |
4741 ((uint64_t) p[5] << 16) |
4742 ((uint64_t) p[6] << 8) |
4743 ((uint64_t) p[7]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004744 p += 8;
4745#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4746
4747#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 if ((size_t) (end - p) < 1) {
4749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4750 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004751
4752 ssl->disable_datagram_packing = *p++;
4753#endif /* MBEDTLS_SSL_PROTO_DTLS */
4754
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4756 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4757 }
4758 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4759 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004760
4761#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 if ((size_t) (end - p) < 2) {
4763 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4764 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004765
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004767 p += 2;
4768#endif /* MBEDTLS_SSL_PROTO_DTLS */
4769
4770#if defined(MBEDTLS_SSL_ALPN)
4771 {
4772 uint8_t alpn_len;
4773 const char **cur;
4774
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 if ((size_t) (end - p) < 1) {
4776 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4777 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004778
4779 alpn_len = *p++;
4780
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004782 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4784 if (strlen(*cur) == alpn_len &&
4785 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004786 ssl->alpn_chosen = *cur;
4787 break;
4788 }
4789 }
4790 }
4791
4792 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4794 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4795 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004796
4797 p += alpn_len;
4798 }
4799#endif /* MBEDTLS_SSL_ALPN */
4800
4801 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004802 * Forced fields from top-level ssl_context structure
4803 *
4804 * Most of them already set to the correct value by mbedtls_ssl_init() and
4805 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4806 */
4807 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004808 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004809
Hanno Becker361b10d2019-08-30 10:42:49 +01004810 /* Adjust pointers for header fields of outgoing records to
4811 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004813
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004814#if defined(MBEDTLS_SSL_PROTO_DTLS)
4815 ssl->in_epoch = 1;
4816#endif
4817
4818 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4819 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004820 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4821 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 if (ssl->handshake != NULL) {
4823 mbedtls_ssl_handshake_free(ssl);
4824 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004825 ssl->handshake = NULL;
4826 }
4827
4828 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004829 * Done - should have consumed entire buffer
4830 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 if (p != end) {
4832 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4833 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004834
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004836}
4837
4838/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004839 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004840 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004841int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4842 const unsigned char *buf,
4843 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004844{
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004846
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 if (ret != 0) {
4848 mbedtls_ssl_free(context);
4849 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004850
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004852}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004853#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004854
4855/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004856 * Free an SSL context
4857 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004858void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004859{
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004861 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004863
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004865
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004867#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4868 size_t out_buf_len = ssl->out_buf_len;
4869#else
4870 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4871#endif
4872
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 mbedtls_platform_zeroize(ssl->out_buf, out_buf_len);
4874 mbedtls_free(ssl->out_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004875 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004876 }
4877
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004879#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4880 size_t in_buf_len = ssl->in_buf_len;
4881#else
4882 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4883#endif
4884
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 mbedtls_platform_zeroize(ssl->in_buf, in_buf_len);
4886 mbedtls_free(ssl->in_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004887 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004888 }
4889
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 if (ssl->transform) {
4891 mbedtls_ssl_transform_free(ssl->transform);
4892 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004893 }
4894
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 if (ssl->handshake) {
4896 mbedtls_ssl_handshake_free(ssl);
4897 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004898
4899#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4901 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004902#endif
4903
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 mbedtls_ssl_session_free(ssl->session_negotiate);
4905 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004906 }
4907
Ronald Cron6f135e12021-12-08 16:57:54 +01004908#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 mbedtls_ssl_transform_free(ssl->transform_application);
4910 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004911#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004912
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 if (ssl->session) {
4914 mbedtls_ssl_session_free(ssl->session);
4915 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004916 }
4917
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004918#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 if (ssl->hostname != NULL) {
4920 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
4921 mbedtls_free(ssl->hostname);
Paul Bakker5121ce52009-01-03 21:22:43 +00004922 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004923#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004924
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004925#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004927#endif
4928
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004930
Paul Bakker86f04f42013-02-14 11:20:09 +01004931 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004933}
4934
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004935/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004936 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004937 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004938void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004939{
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004941}
4942
Gilles Peskineae270bf2021-06-02 00:05:29 +02004943/* The selection should be the same as mbedtls_x509_crt_profile_default in
4944 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004945 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004946 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004947 * about this list.
4948 */
Brett Warrene0edc842021-08-17 09:53:13 +01004949static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004950#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004951 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004952#endif
4953#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004954 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004955#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004956#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004957 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004958#endif
4959#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004960 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004961#endif
4962#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004963 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004964#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004965#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004966 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004967#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004968#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004969 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004970#endif
4971#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004972 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004973#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004974 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004975};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004976
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004977static int ssl_preset_suiteb_ciphersuites[] = {
4978 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4979 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4980 0
4981};
4982
Ronald Crone68ab4f2022-10-05 12:46:29 +02004983#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004984
Jerry Yu909df7b2022-01-22 11:56:27 +08004985/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004986 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004987 * rules SHOULD be upheld.
4988 * - No duplicate entries.
4989 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004990 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004991 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004992 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004993static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004994
Valerio Setti75fba322023-02-23 17:35:09 +01004995#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
4996 defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004997 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4998 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Valerio Setti75fba322023-02-23 17:35:09 +01004999#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 +08005000 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005001
Valerio Setti75fba322023-02-23 17:35:09 +01005002#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
5003 defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08005004 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5005 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Valerio Setti75fba322023-02-23 17:35:09 +01005006#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 +08005007 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
5008
Valerio Setti75fba322023-02-23 17:35:09 +01005009#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
5010 defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08005011 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
5012 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Valerio Setti75fba322023-02-23 17:35:09 +01005013#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 +08005014 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005015
Gilles Peskine449bd832023-01-11 14:50:10 +01005016#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
5017 defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005018 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005019#endif \
5020 /* 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 +08005021
Gilles Peskine449bd832023-01-11 14:50:10 +01005022#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
5023 defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005024 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005025#endif \
5026 /* 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 +08005027
Gilles Peskine449bd832023-01-11 14:50:10 +01005028#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
5029 defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005030 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005031#endif \
5032 /* 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 +08005033
Andrzej Kurek25f27152022-08-17 16:09:31 -04005034#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 +08005035 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
5036#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
5037
Andrzej Kurek25f27152022-08-17 16:09:31 -04005038#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 +08005039 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
5040#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
5041
Andrzej Kurek25f27152022-08-17 16:09:31 -04005042#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 +08005043 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
5044#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
5045
Gabor Mezei15b95a62022-05-09 16:37:58 +02005046 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005047};
5048
5049/* NOTICE: see above */
5050#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5051static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005052#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Valerio Setti75fba322023-02-23 17:35:09 +01005053#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005055#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005056#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5057 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5058#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005059#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005061#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005062#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04005063#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Valerio Setti75fba322023-02-23 17:35:09 +01005064#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005066#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005067#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5068 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5069#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005070#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005072#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005073#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04005074#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Valerio Setti75fba322023-02-23 17:35:09 +01005075#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005077#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005078#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5079 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5080#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005081#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005082 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005083#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005084#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005085 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005086};
5087#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5088/* NOTICE: see above */
5089static uint16_t ssl_preset_suiteb_sig_algs[] = {
5090
Andrzej Kurek25f27152022-08-17 16:09:31 -04005091#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 +08005092 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5093 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005094#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08005095 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
5096
Andrzej Kurek25f27152022-08-17 16:09:31 -04005097#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 +08005098 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5099 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005100#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu53037892022-01-25 11:02:06 +08005101 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005102
Gilles Peskine449bd832023-01-11 14:50:10 +01005103#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
5104 defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu909df7b2022-01-22 11:56:27 +08005105 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005106#endif \
5107 /* 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 +08005108
Andrzej Kurek25f27152022-08-17 16:09:31 -04005109#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 +08005110 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005111#endif /* MBEDTLS_RSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu53037892022-01-25 11:02:06 +08005112
Gabor Mezei15b95a62022-05-09 16:37:58 +02005113 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005114};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005115
Jerry Yu909df7b2022-01-22 11:56:27 +08005116/* NOTICE: see above */
5117#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5118static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005119#if defined(MBEDTLS_HAS_ALG_SHA_256_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_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +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_SHA256),
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*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04005127#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005128#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005130#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005131#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005133#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005134#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005135 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005136};
Jerry Yu909df7b2022-01-22 11:56:27 +08005137#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5138
Ronald Crone68ab4f2022-10-05 12:46:29 +02005139#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005140
Brett Warrene0edc842021-08-17 09:53:13 +01005141static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01005142#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005143 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005144#endif
5145#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005146 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005147#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005148 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005149};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005150
Ronald Crone68ab4f2022-10-05 12:46:29 +02005151#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005152/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005153 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005154MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005155static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005156{
5157 size_t i, j;
5158 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005159
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5161 for (j = 0; j < i; j++) {
5162 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005163 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 }
5165 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5166 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5167 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005168 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005169 }
5170 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005172}
5173
Ronald Crone68ab4f2022-10-05 12:46:29 +02005174#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005175
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005176/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005177 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005178 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005179int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5180 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005181{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005182#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005183 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005184#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005185
Ronald Crone68ab4f2022-10-05 12:46:29 +02005186#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5188 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5189 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005190 }
5191
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5193 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5194 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005195 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005196
5197#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5199 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5200 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005201 }
5202
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5204 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5205 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005206 }
5207#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005208#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005209
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005210 /* Use the functions here so that they are covered in tests,
5211 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 mbedtls_ssl_conf_endpoint(conf, endpoint);
5213 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005214
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005215 /*
5216 * Things that are common to all presets
5217 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005218#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005220 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5221#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5222 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5223#endif
5224 }
5225#endif
5226
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005227#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5228 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5229#endif
5230
5231#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5232 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5233#endif
5234
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005235#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005236 conf->f_cookie_write = ssl_cookie_write_dummy;
5237 conf->f_cookie_check = ssl_cookie_check_dummy;
5238#endif
5239
5240#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5241 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5242#endif
5243
Janos Follath088ce432017-04-10 12:42:31 +01005244#if defined(MBEDTLS_SSL_SRV_C)
5245 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005246 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005247#endif
5248
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005249#if defined(MBEDTLS_SSL_PROTO_DTLS)
5250 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5251 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5252#endif
5253
5254#if defined(MBEDTLS_SSL_RENEGOTIATION)
5255 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 memset(conf->renego_period, 0x00, 2);
5257 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005258#endif
5259
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005260#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005262 const unsigned char dhm_p[] =
5263 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5264 const unsigned char dhm_g[] =
5265 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005266
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5268 dhm_p, sizeof(dhm_p),
5269 dhm_g, sizeof(dhm_g))) != 0) {
5270 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005271 }
5272 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005273#endif
5274
Ronald Cron6f135e12021-12-08 16:57:54 +01005275#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005276
5277#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 mbedtls_ssl_tls13_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005279#if defined(MBEDTLS_SSL_SRV_C)
5280 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005282#endif
5283#endif /* MBEDTLS_SSL_EARLY_DATA */
5284
Jerry Yud0766ec2022-09-22 10:46:57 +08005285#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005286 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005288#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005289 /*
5290 * Allow all TLS 1.3 key exchange modes by default.
5291 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005292 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005293#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005294
Gilles Peskine449bd832023-01-11 14:50:10 +01005295 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005296#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005297 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005298 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005299#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005301#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005303#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005305 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5306 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 } else {
5308 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
XiaokangQian4d3a6042022-04-21 13:46:17 +00005309 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5310 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5311 }
5312#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5313 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5314 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5315#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5316 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5317 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5318#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005320#endif
5321 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005322
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005323 /*
5324 * Preset-specific defaults
5325 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005327 /*
5328 * NSA Suite B
5329 */
5330 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005331
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005332 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005333
5334#if defined(MBEDTLS_X509_CRT_PARSE_C)
5335 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005336#endif
5337
Ronald Crone68ab4f2022-10-05 12:46:29 +02005338#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005339#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005341 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005343#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005345#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005346
Brett Warrene0edc842021-08-17 09:53:13 +01005347#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5348 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005349#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005350 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005351 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005352
5353 /*
5354 * Default
5355 */
5356 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005357
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005358 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005359
5360#if defined(MBEDTLS_X509_CRT_PARSE_C)
5361 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5362#endif
5363
Ronald Crone68ab4f2022-10-05 12:46:29 +02005364#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005365#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005367 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005369#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005371#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005372
Brett Warrene0edc842021-08-17 09:53:13 +01005373#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5374 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005375#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005376 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005377
5378#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5379 conf->dhm_min_bitlen = 1024;
5380#endif
5381 }
5382
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005384}
5385
5386/*
5387 * Free mbedtls_ssl_config
5388 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005389void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005390{
5391#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 mbedtls_mpi_free(&conf->dhm_P);
5393 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005394#endif
5395
Ronald Cron73fe8df2022-10-05 14:31:43 +02005396#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005397#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005399 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5400 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005401#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 if (conf->psk != NULL) {
5403 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
5404 mbedtls_free(conf->psk);
Azim Khan27e8a122018-03-21 14:24:11 +00005405 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005406 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005407 }
5408
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 if (conf->psk_identity != NULL) {
5410 mbedtls_platform_zeroize(conf->psk_identity, conf->psk_identity_len);
5411 mbedtls_free(conf->psk_identity);
Azim Khan27e8a122018-03-21 14:24:11 +00005412 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005413 conf->psk_identity_len = 0;
5414 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005415#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005416
5417#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005418 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005419#endif
5420
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005422}
5423
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005424#if defined(MBEDTLS_PK_C) && \
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005425 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_CAN_ECDSA_SOME))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005426/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005427 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005428 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005429unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005430{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005431#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005432 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5433 return MBEDTLS_SSL_SIG_RSA;
5434 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005435#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005436#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5438 return MBEDTLS_SSL_SIG_ECDSA;
5439 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005440#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005442}
5443
Gilles Peskine449bd832023-01-11 14:50:10 +01005444unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005445{
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005447 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005448 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005449 case MBEDTLS_PK_ECDSA:
5450 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005452 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005454 }
5455}
5456
Gilles Peskine449bd832023-01-11 14:50:10 +01005457mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005458{
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005460#if defined(MBEDTLS_RSA_C)
5461 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005463#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005464#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005465 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005467#endif
5468 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005470 }
5471}
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005472#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_PK_CAN_ECDSA_SOME ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005473
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005474/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005475 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005476 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005477mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005478{
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 switch (hash) {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005480#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005481 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005483#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005484#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005485 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 return MBEDTLS_MD_SHA1;
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_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005489 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005491#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005492#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005493 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005495#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005496#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005497 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005499#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005500#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005501 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005503#endif
5504 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005506 }
5507}
5508
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005509/*
5510 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005512unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005513{
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 switch (md) {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005515#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005516 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005518#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005519#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005520 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 return MBEDTLS_SSL_HASH_SHA1;
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_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005524 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005526#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005527#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005528 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005530#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005531#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005532 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005534#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005535#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005536 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005537 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005538#endif
5539 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005540 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005541 }
5542}
5543
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005544/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005545 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005546 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005547 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005548int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005549{
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005551
Gilles Peskine449bd832023-01-11 14:50:10 +01005552 if (group_list == NULL) {
5553 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005554 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005555
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 for (; *group_list != 0; group_list++) {
5557 if (*group_list == tls_id) {
5558 return 0;
5559 }
5560 }
5561
5562 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005563}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005564
5565#if defined(MBEDTLS_ECP_C)
5566/*
5567 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5568 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005569int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005570{
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005572
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005574 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005576
Gilles Peskine449bd832023-01-11 14:50:10 +01005577 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005578}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02005579#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005580
Gilles Peskine449bd832023-01-11 14:50:10 +01005581#if defined(MBEDTLS_DEBUG_C)
Valerio Setti67419f02023-01-04 16:12:42 +01005582#define EC_NAME(_name_) _name_
5583#else
5584#define EC_NAME(_name_) NULL
5585#endif
5586
Valerio Setti18c9fed2022-12-30 17:44:24 +01005587static const struct {
5588 uint16_t tls_id;
5589 mbedtls_ecp_group_id ecp_group_id;
5590 psa_ecc_family_t psa_family;
5591 uint16_t bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 const char *name;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005593} tls_id_match_table[] =
5594{
5595#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521, EC_NAME("secp521r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005597#endif
5598#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512, EC_NAME("brainpoolP512r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005600#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005601#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384, EC_NAME("secp384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005603#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005604#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384, EC_NAME("brainpoolP384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005606#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005607#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256, EC_NAME("secp256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005609#endif
5610#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256, EC_NAME("secp256k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005612#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005613#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256, EC_NAME("brainpoolP256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005615#endif
5616#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005617 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224, EC_NAME("secp224r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005618#endif
5619#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224, EC_NAME("secp224k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005621#endif
5622#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192, EC_NAME("secp192r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005624#endif
5625#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192, EC_NAME("secp192k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005627#endif
5628#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255, EC_NAME("x25519") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005630#endif
5631#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448, EC_NAME("x448") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005633#endif
5634 { 0, MBEDTLS_ECP_DP_NONE, 0, 0, NULL },
5635};
5636
Gilles Peskine449bd832023-01-11 14:50:10 +01005637int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
5638 psa_ecc_family_t *family,
5639 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005640{
Gilles Peskine449bd832023-01-11 14:50:10 +01005641 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5642 if (tls_id_match_table[i].tls_id == tls_id) {
5643 if (family != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005644 *family = tls_id_match_table[i].psa_family;
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 }
5646 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005647 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005649 return PSA_SUCCESS;
5650 }
5651 }
5652
5653 return PSA_ERROR_NOT_SUPPORTED;
5654}
5655
Gilles Peskine449bd832023-01-11 14:50:10 +01005656mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005657{
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5659 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005660 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005662 }
5663
5664 return MBEDTLS_ECP_DP_NONE;
5665}
5666
Gilles Peskine449bd832023-01-11 14:50:10 +01005667uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005668{
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5670 i++) {
5671 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005672 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005674 }
5675
5676 return 0;
5677}
5678
Valerio Setti67419f02023-01-04 16:12:42 +01005679#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005680const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005681{
Gilles Peskine449bd832023-01-11 14:50:10 +01005682 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5683 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005684 return tls_id_match_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005686 }
5687
5688 return NULL;
5689}
Valerio Setti67419f02023-01-04 16:12:42 +01005690#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005691
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005692#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005693int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5694 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5695 int cert_endpoint,
5696 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005697{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005698 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005699 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005700 const char *ext_oid;
5701 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005702
Gilles Peskine449bd832023-01-11 14:50:10 +01005703 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005704 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005705 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005706 case MBEDTLS_KEY_EXCHANGE_RSA:
5707 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005708 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005709 break;
5710
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005711 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5712 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5713 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5714 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005715 break;
5716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005717 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5718 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005719 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005720 break;
5721
5722 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005723 case MBEDTLS_KEY_EXCHANGE_NONE:
5724 case MBEDTLS_KEY_EXCHANGE_PSK:
5725 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5726 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005727 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005728 usage = 0;
5729 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005731 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5732 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005733 }
5734
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005736 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005737 ret = -1;
5738 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005739
Gilles Peskine449bd832023-01-11 14:50:10 +01005740 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005741 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5743 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005744 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005746 }
5747
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005749 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005750 ret = -1;
5751 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005752
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005754}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005755#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005756
Jerry Yu148165c2021-09-24 23:20:59 +08005757#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005758int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5759 const mbedtls_md_type_t md,
5760 unsigned char *dst,
5761 size_t dst_len,
5762 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005763{
Ronald Cronf6893e12022-01-07 22:09:01 +01005764 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5765 psa_hash_operation_t *hash_operation_to_clone;
5766 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5767
Jerry Yu148165c2021-09-24 23:20:59 +08005768 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005769
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 switch (md) {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005771#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005772 case MBEDTLS_MD_SHA384:
5773 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5774 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005775#endif
5776
Andrzej Kurek25f27152022-08-17 16:09:31 -04005777#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005778 case MBEDTLS_MD_SHA256:
5779 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5780 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005781#endif
5782
Gilles Peskine449bd832023-01-11 14:50:10 +01005783 default:
5784 goto exit;
5785 }
5786
5787 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5788 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005789 goto exit;
5790 }
5791
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5793 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005794 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005796
5797exit:
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005798#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
5799 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
5800 (void) ssl;
5801#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005802 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005803}
5804#else /* MBEDTLS_USE_PSA_CRYPTO */
5805
Andrzej Kurek25f27152022-08-17 16:09:31 -04005806#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005807MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005808static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5809 unsigned char *dst,
5810 size_t dst_len,
5811 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005812{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005813 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005814 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005815
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 if (dst_len < 48) {
5817 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5818 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005819
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005820 mbedtls_md_init(&sha384);
5821 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005822 if (ret != 0) {
5823 goto exit;
5824 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005825 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005826 if (ret != 0) {
5827 goto exit;
5828 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005829
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005830 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005831 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005832 goto exit;
5833 }
5834
5835 *olen = 48;
5836
5837exit:
5838
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005839 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005841}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005842#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005843
Andrzej Kurek25f27152022-08-17 16:09:31 -04005844#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005845MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005846static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5847 unsigned char *dst,
5848 size_t dst_len,
5849 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005850{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005851 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005852 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005853
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 if (dst_len < 32) {
5855 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5856 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005857
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005858 mbedtls_md_init(&sha256);
5859 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5860 if (ret != 0) {
5861 goto exit;
5862 }
5863 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5864 if (ret != 0) {
5865 goto exit;
5866 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005867
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005868 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5869 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005870 goto exit;
5871 }
5872
5873 *olen = 32;
5874
5875exit:
5876
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005877 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005879}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005880#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005881
Gilles Peskine449bd832023-01-11 14:50:10 +01005882int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5883 const mbedtls_md_type_t md,
5884 unsigned char *dst,
5885 size_t dst_len,
5886 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005887{
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005889
Andrzej Kurek25f27152022-08-17 16:09:31 -04005890#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 case MBEDTLS_MD_SHA384:
5892 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005893#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005894
Andrzej Kurek25f27152022-08-17 16:09:31 -04005895#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 case MBEDTLS_MD_SHA256:
5897 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005898#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005899
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 default:
Andrzej Kurek409248a2022-10-24 10:33:21 -04005901#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
5903 (void) ssl;
5904 (void) dst;
5905 (void) dst_len;
5906 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005907#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005909 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005910 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005911}
XiaokangQian647719a2021-12-07 09:16:29 +00005912
Jerry Yu148165c2021-09-24 23:20:59 +08005913#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005914
Ronald Crone68ab4f2022-10-05 12:46:29 +02005915#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005916/* mbedtls_ssl_parse_sig_alg_ext()
5917 *
5918 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5919 * value (TLS 1.3 RFC8446):
5920 * enum {
5921 * ....
5922 * ecdsa_secp256r1_sha256( 0x0403 ),
5923 * ecdsa_secp384r1_sha384( 0x0503 ),
5924 * ecdsa_secp521r1_sha512( 0x0603 ),
5925 * ....
5926 * } SignatureScheme;
5927 *
5928 * struct {
5929 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5930 * } SignatureSchemeList;
5931 *
5932 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5933 * value (TLS 1.2 RFC5246):
5934 * enum {
5935 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5936 * sha512(6), (255)
5937 * } HashAlgorithm;
5938 *
5939 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5940 * SignatureAlgorithm;
5941 *
5942 * struct {
5943 * HashAlgorithm hash;
5944 * SignatureAlgorithm signature;
5945 * } SignatureAndHashAlgorithm;
5946 *
5947 * SignatureAndHashAlgorithm
5948 * supported_signature_algorithms<2..2^16-2>;
5949 *
5950 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5951 * generalization of the TLS 1.2 signature algorithm extension.
5952 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5953 * `SignatureScheme` field of TLS 1.3
5954 *
5955 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005956int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5957 const unsigned char *buf,
5958 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005959{
5960 const unsigned char *p = buf;
5961 size_t supported_sig_algs_len = 0;
5962 const unsigned char *supported_sig_algs_end;
5963 uint16_t sig_alg;
5964 uint32_t common_idx = 0;
5965
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5967 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005968 p += 2;
5969
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 memset(ssl->handshake->received_sig_algs, 0,
5971 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005972
Gilles Peskine449bd832023-01-11 14:50:10 +01005973 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005974 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 while (p < supported_sig_algs_end) {
5976 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5977 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005978 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5980 sig_alg,
5981 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005982#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005983 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5984 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5985 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005986 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005987 }
5988#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005989
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5991 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005992
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005994 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5995 common_idx += 1;
5996 }
5997 }
5998 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 if (p != end) {
6000 MBEDTLS_SSL_DEBUG_MSG(1,
6001 ("Signature algorithms extension length misaligned"));
6002 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6003 MBEDTLS_ERR_SSL_DECODE_ERROR);
6004 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006005 }
6006
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 if (common_idx == 0) {
6008 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6009 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6010 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6011 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006012 }
6013
Gabor Mezei15b95a62022-05-09 16:37:58 +02006014 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006016}
6017
Ronald Crone68ab4f2022-10-05 12:46:29 +02006018#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006019
Jerry Yudc7bd172022-02-17 13:44:15 +08006020#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6021
6022#if defined(MBEDTLS_USE_PSA_CRYPTO)
6023
Gilles Peskine449bd832023-01-11 14:50:10 +01006024static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6025 mbedtls_svc_key_id_t key,
6026 psa_algorithm_t alg,
6027 const unsigned char *raw_psk, size_t raw_psk_length,
6028 const unsigned char *seed, size_t seed_length,
6029 const unsigned char *label, size_t label_length,
6030 const unsigned char *other_secret,
6031 size_t other_secret_length,
6032 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006033{
6034 psa_status_t status;
6035
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 status = psa_key_derivation_setup(derivation, alg);
6037 if (status != PSA_SUCCESS) {
6038 return status;
6039 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006040
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6042 status = psa_key_derivation_input_bytes(derivation,
6043 PSA_KEY_DERIVATION_INPUT_SEED,
6044 seed, seed_length);
6045 if (status != PSA_SUCCESS) {
6046 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006047 }
6048
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 if (other_secret != NULL) {
6050 status = psa_key_derivation_input_bytes(derivation,
6051 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6052 other_secret, other_secret_length);
6053 if (status != PSA_SUCCESS) {
6054 return status;
6055 }
6056 }
6057
6058 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006059 status = psa_key_derivation_input_bytes(
6060 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 raw_psk, raw_psk_length);
6062 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006063 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006065 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 if (status != PSA_SUCCESS) {
6067 return status;
6068 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006069
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 status = psa_key_derivation_input_bytes(derivation,
6071 PSA_KEY_DERIVATION_INPUT_LABEL,
6072 label, label_length);
6073 if (status != PSA_SUCCESS) {
6074 return status;
6075 }
6076 } else {
6077 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006078 }
6079
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 status = psa_key_derivation_set_capacity(derivation, capacity);
6081 if (status != PSA_SUCCESS) {
6082 return status;
6083 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006084
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006086}
6087
Andrzej Kurek57d10632022-10-24 10:32:01 -04006088#if defined(PSA_WANT_ALG_SHA_384) || \
6089 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006090MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006091static int tls_prf_generic(mbedtls_md_type_t md_type,
6092 const unsigned char *secret, size_t slen,
6093 const char *label,
6094 const unsigned char *random, size_t rlen,
6095 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006096{
6097 psa_status_t status;
6098 psa_algorithm_t alg;
6099 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6100 psa_key_derivation_operation_t derivation =
6101 PSA_KEY_DERIVATION_OPERATION_INIT;
6102
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006104 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006106 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006108
6109 /* Normally a "secret" should be long enough to be impossible to
6110 * find by brute force, and in particular should not be empty. But
6111 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6112 * and for this use case it makes sense to have a 0-length "secret".
6113 * Since the key API doesn't allow importing a key of length 0,
6114 * keep master_key=0, which setup_psa_key_derivation() understands
6115 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006117 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6119 psa_set_key_algorithm(&key_attributes, alg);
6120 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006121
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6123 if (status != PSA_SUCCESS) {
6124 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6125 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006126 }
6127
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 status = setup_psa_key_derivation(&derivation,
6129 master_key, alg,
6130 NULL, 0,
6131 random, rlen,
6132 (unsigned char const *) label,
6133 (size_t) strlen(label),
6134 NULL, 0,
6135 dlen);
6136 if (status != PSA_SUCCESS) {
6137 psa_key_derivation_abort(&derivation);
6138 psa_destroy_key(master_key);
6139 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006140 }
6141
Gilles Peskine449bd832023-01-11 14:50:10 +01006142 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6143 if (status != PSA_SUCCESS) {
6144 psa_key_derivation_abort(&derivation);
6145 psa_destroy_key(master_key);
6146 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006147 }
6148
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 status = psa_key_derivation_abort(&derivation);
6150 if (status != PSA_SUCCESS) {
6151 psa_destroy_key(master_key);
6152 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006153 }
6154
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 if (!mbedtls_svc_key_id_is_null(master_key)) {
6156 status = psa_destroy_key(master_key);
6157 }
6158 if (status != PSA_SUCCESS) {
6159 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6160 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006161
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006163}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006164#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006165#else /* MBEDTLS_USE_PSA_CRYPTO */
6166
Andrzej Kurek57d10632022-10-24 10:32:01 -04006167#if defined(MBEDTLS_MD_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 (defined(MBEDTLS_SHA256_C) || \
6169 defined(MBEDTLS_SHA384_C))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006170MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006171static int tls_prf_generic(mbedtls_md_type_t md_type,
6172 const unsigned char *secret, size_t slen,
6173 const char *label,
6174 const unsigned char *random, size_t rlen,
6175 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006176{
6177 size_t nb;
6178 size_t i, j, k, md_len;
6179 unsigned char *tmp;
6180 size_t tmp_len = 0;
6181 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6182 const mbedtls_md_info_t *md_info;
6183 mbedtls_md_context_t md_ctx;
6184 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6185
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006187
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6189 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6190 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006191
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006193
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 tmp_len = md_len + strlen(label) + rlen;
6195 tmp = mbedtls_calloc(1, tmp_len);
6196 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006197 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6198 goto exit;
6199 }
6200
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 nb = strlen(label);
6202 memcpy(tmp + md_len, label, nb);
6203 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006204 nb += rlen;
6205
6206 /*
6207 * Compute P_<hash>(secret, label + random)[0..dlen]
6208 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006210 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006212
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6214 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006215 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 }
6217 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6218 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006219 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 }
6221 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6222 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006223 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006225
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 for (i = 0; i < dlen; i += md_len) {
6227 ret = mbedtls_md_hmac_reset(&md_ctx);
6228 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006229 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 }
6231 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6232 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006233 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 }
6235 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6236 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006237 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006239
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 ret = mbedtls_md_hmac_reset(&md_ctx);
6241 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006242 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 }
6244 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6245 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006246 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 }
6248 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6249 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006250 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006252
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006254
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006256 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006258 }
6259
6260exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006262
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 if (tmp != NULL) {
6264 mbedtls_platform_zeroize(tmp, tmp_len);
6265 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006266
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006268
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006270
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006272}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006273#endif /* MBEDTLS_MD_C && ( MBEDTLS_SHA256_C || MBEDTLS_SHA384_C ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006274#endif /* MBEDTLS_USE_PSA_CRYPTO */
6275
Andrzej Kurek25f27152022-08-17 16:09:31 -04006276#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006277MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006278static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6279 const char *label,
6280 const unsigned char *random, size_t rlen,
6281 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006282{
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6284 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006285}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04006286#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006287
Andrzej Kurek25f27152022-08-17 16:09:31 -04006288#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006289MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006290static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6291 const char *label,
6292 const unsigned char *random, size_t rlen,
6293 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006294{
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6296 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006297}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04006298#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006299
Jerry Yuf009d862022-02-17 14:01:37 +08006300/*
6301 * Set appropriate PRF function and other SSL / TLS1.2 functions
6302 *
6303 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006304 * - hash associated with the ciphersuite (only used by TLS 1.2)
6305 *
6306 * Outputs:
6307 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6308 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006309MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006310static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6311 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006312{
Andrzej Kurek25f27152022-08-17 16:09:31 -04006313#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01006314 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006315 handshake->tls_prf = tls_prf_sha384;
6316 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6317 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006319#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04006320#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuf009d862022-02-17 14:01:37 +08006321 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006322 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006323 handshake->tls_prf = tls_prf_sha256;
6324 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6325 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6326 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006327#else
Jerry Yuf009d862022-02-17 14:01:37 +08006328 {
Jerry Yuf009d862022-02-17 14:01:37 +08006329 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006330 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006332 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006333#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006334
Gilles Peskine449bd832023-01-11 14:50:10 +01006335 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006336}
Jerry Yud6ab2352022-02-17 14:03:43 +08006337
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006338/*
6339 * Compute master secret if needed
6340 *
6341 * Parameters:
6342 * [in/out] handshake
6343 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6344 * (PSA-PSK) ciphersuite_info, psk_opaque
6345 * [out] premaster (cleared)
6346 * [out] master
6347 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6348 * debug: conf->f_dbg, conf->p_dbg
6349 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006350 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006351 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006352MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006353static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6354 unsigned char *master,
6355 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006356{
6357 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6358
6359 /* cf. RFC 5246, Section 8.1:
6360 * "The master secret is always exactly 48 bytes in length." */
6361 size_t const master_secret_len = 48;
6362
6363#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6364 unsigned char session_hash[48];
6365#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6366
6367 /* The label for the KDF used for key expansion.
6368 * This is either "master secret" or "extended master secret"
6369 * depending on whether the Extended Master Secret extension
6370 * is used. */
6371 char const *lbl = "master secret";
6372
Przemek Stekielae4ed302022-04-05 17:15:55 +02006373 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006374 * - If the Extended Master Secret extension is not used,
6375 * this is ClientHello.Random + ServerHello.Random
6376 * (see Sect. 8.1 in RFC 5246).
6377 * - If the Extended Master Secret extension is used,
6378 * this is the transcript of the handshake so far.
6379 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006380 unsigned char const *seed = handshake->randbytes;
6381 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006382
6383#if !defined(MBEDTLS_DEBUG_C) && \
6384 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6385 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006387 ssl = NULL; /* make sure we don't use it except for those cases */
6388 (void) ssl;
6389#endif
6390
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 if (handshake->resume != 0) {
6392 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6393 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006394 }
6395
6396#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006398 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006399 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006400 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6401 if (ret != 0) {
6402 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6403 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006404
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6406 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006407 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006408#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006409
Przemek Stekiel99114f32022-04-22 11:20:09 +02006410#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006411 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006413 /* Perform PSK-to-MS expansion in a single step. */
6414 psa_status_t status;
6415 psa_algorithm_t alg;
6416 mbedtls_svc_key_id_t psk;
6417 psa_key_derivation_operation_t derivation =
6418 PSA_KEY_DERIVATION_OPERATION_INIT;
6419 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6420
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006422
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006424
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006426 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006427 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006428 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006429 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006430
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006431 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006432 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006433
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006435 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006436 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006437 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006438 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006439 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006440 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006441 other_secret_len = 48;
6442 other_secret = handshake->premaster + 2;
6443 break;
6444 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006445 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006446 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6447 other_secret = handshake->premaster + 2;
6448 break;
6449 default:
6450 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006451 }
6452
Gilles Peskine449bd832023-01-11 14:50:10 +01006453 status = setup_psa_key_derivation(&derivation, psk, alg,
6454 ssl->conf->psk, ssl->conf->psk_len,
6455 seed, seed_len,
6456 (unsigned char const *) lbl,
6457 (size_t) strlen(lbl),
6458 other_secret, other_secret_len,
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_output_bytes(&derivation,
6466 master,
6467 master_secret_len);
6468 if (status != PSA_SUCCESS) {
6469 psa_key_derivation_abort(&derivation);
6470 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006471 }
6472
Gilles Peskine449bd832023-01-11 14:50:10 +01006473 status = psa_key_derivation_abort(&derivation);
6474 if (status != PSA_SUCCESS) {
6475 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6476 }
6477 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006478#endif
6479 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006480#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6482 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006483 psa_status_t status;
6484 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6485 psa_key_derivation_operation_t derivation =
6486 PSA_KEY_DERIVATION_OPERATION_INIT;
6487
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006489
6490 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6491
Gilles Peskine449bd832023-01-11 14:50:10 +01006492 status = psa_key_derivation_setup(&derivation, alg);
6493 if (status != PSA_SUCCESS) {
6494 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006495 }
6496
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 status = psa_key_derivation_set_capacity(&derivation,
6498 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6499 if (status != PSA_SUCCESS) {
6500 psa_key_derivation_abort(&derivation);
6501 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006502 }
6503
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6505 &derivation);
6506 if (status != PSA_SUCCESS) {
6507 psa_key_derivation_abort(&derivation);
6508 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006509 }
6510
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 status = psa_key_derivation_output_bytes(&derivation,
6512 handshake->premaster,
6513 handshake->pmslen);
6514 if (status != PSA_SUCCESS) {
6515 psa_key_derivation_abort(&derivation);
6516 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6517 }
6518
6519 status = psa_key_derivation_abort(&derivation);
6520 if (status != PSA_SUCCESS) {
6521 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006522 }
6523 }
6524#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006525 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6526 lbl, seed, seed_len,
6527 master,
6528 master_secret_len);
6529 if (ret != 0) {
6530 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6531 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006532 }
6533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6535 handshake->premaster,
6536 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006537
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 mbedtls_platform_zeroize(handshake->premaster,
6539 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006540 }
6541
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006543}
6544
Gilles Peskine449bd832023-01-11 14:50:10 +01006545int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006546{
6547 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6548 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6549 ssl->handshake->ciphersuite_info;
6550
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006552
6553 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 ret = ssl_set_handshake_prfs(ssl->handshake,
6555 ciphersuite_info->mac);
6556 if (ret != 0) {
6557 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6558 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006559 }
6560
6561 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 ret = ssl_compute_master(ssl->handshake,
6563 ssl->session_negotiate->master,
6564 ssl);
6565 if (ret != 0) {
6566 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6567 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006568 }
6569
6570 /* Swap the client and server random values:
6571 * - MS derivation wanted client+server (RFC 5246 8.1)
6572 * - key derivation wants server+client (RFC 5246 6.3) */
6573 {
6574 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 memcpy(tmp, ssl->handshake->randbytes, 64);
6576 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6577 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6578 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006579 }
6580
6581 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6583 ssl->session_negotiate->ciphersuite,
6584 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006585#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006586 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006587#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006588 ssl->handshake->tls_prf,
6589 ssl->handshake->randbytes,
6590 ssl->tls_version,
6591 ssl->conf->endpoint,
6592 ssl);
6593 if (ret != 0) {
6594 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6595 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006596 }
6597
6598 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006599 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6600 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006601
Gilles Peskine449bd832023-01-11 14:50:10 +01006602 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006603
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006605}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006606
Gilles Peskine449bd832023-01-11 14:50:10 +01006607int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006608{
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 switch (md) {
Andrzej Kurek25f27152022-08-17 16:09:31 -04006610#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006611 case MBEDTLS_SSL_HASH_SHA384:
6612 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6613 break;
6614#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04006615#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006616 case MBEDTLS_SSL_HASH_SHA256:
6617 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6618 break;
6619#endif
6620 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006621 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006622 }
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006623#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
6624 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
6625 (void) ssl;
6626#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006627 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006628}
6629
Andrzej Kurek25f27152022-08-17 16:09:31 -04006630#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006631int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6632 unsigned char *hash,
6633 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006634{
6635#if defined(MBEDTLS_USE_PSA_CRYPTO)
6636 size_t hash_size;
6637 psa_status_t status;
6638 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
6639
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify sha256"));
6641 status = psa_hash_clone(&ssl->handshake->fin_sha256_psa, &sha256_psa);
6642 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006643 goto exit;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006644 }
6645
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 status = psa_hash_finish(&sha256_psa, hash, 32, &hash_size);
6647 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006648 goto exit;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006649 }
6650
6651 *hlen = 32;
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6653 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006654
6655exit:
6656 psa_hash_abort(&sha256_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05006657 return PSA_TO_MD_ERR(status);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006658#else
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006659 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006660 mbedtls_md_context_t sha256;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006661
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006662 mbedtls_md_init(&sha256);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006663
Gilles Peskine449bd832023-01-11 14:50:10 +01006664 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify sha256"));
Jerry Yu8392e0d2022-02-17 14:10:24 +08006665
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006666 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6667 if (ret != 0) {
6668 goto exit;
6669 }
6670 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6671 if (ret != 0) {
6672 goto exit;
6673 }
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006674
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006675 ret = mbedtls_md_finish(&sha256, hash);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006676 if (ret != 0) {
6677 goto exit;
6678 }
Jerry Yu8392e0d2022-02-17 14:10:24 +08006679
6680 *hlen = 32;
6681
Gilles Peskine449bd832023-01-11 14:50:10 +01006682 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6683 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
Jerry Yu8392e0d2022-02-17 14:10:24 +08006684
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006685exit:
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006686 mbedtls_md_free(&sha256);
Manuel Pégourié-Gonnard8e176f72023-02-09 10:33:54 +01006687 return ret;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006688#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006689}
Andrzej Kurek25f27152022-08-17 16:09:31 -04006690#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006691
Andrzej Kurek25f27152022-08-17 16:09:31 -04006692#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006693int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6694 unsigned char *hash,
6695 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006696{
6697#if defined(MBEDTLS_USE_PSA_CRYPTO)
6698 size_t hash_size;
6699 psa_status_t status;
6700 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
6701
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify sha384"));
6703 status = psa_hash_clone(&ssl->handshake->fin_sha384_psa, &sha384_psa);
6704 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006705 goto exit;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006706 }
6707
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 status = psa_hash_finish(&sha384_psa, hash, 48, &hash_size);
6709 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006710 goto exit;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006711 }
6712
6713 *hlen = 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006714 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6715 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006716
6717exit:
6718 psa_hash_abort(&sha384_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05006719 return PSA_TO_MD_ERR(status);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006720#else
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006721 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006722 mbedtls_md_context_t sha384;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006723
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006724 mbedtls_md_init(&sha384);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006725
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify sha384"));
Jerry Yuc1cb3842022-02-17 14:13:48 +08006727
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006728 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006729 if (ret != 0) {
6730 goto exit;
6731 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006732 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006733 if (ret != 0) {
6734 goto exit;
6735 }
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006736
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006737 ret = mbedtls_md_finish(&sha384, hash);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006738 if (ret != 0) {
6739 goto exit;
6740 }
Jerry Yuc1cb3842022-02-17 14:13:48 +08006741
6742 *hlen = 48;
6743
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6745 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
Jerry Yuc1cb3842022-02-17 14:13:48 +08006746
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006747exit:
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006748 mbedtls_md_free(&sha384);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006749 return ret;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006750#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006751}
Andrzej Kurek25f27152022-08-17 16:09:31 -04006752#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006753
Neil Armstrong80f6f322022-05-03 17:56:38 +02006754#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6755 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006756int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006757{
6758 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006760 const unsigned char *psk = NULL;
6761 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006763
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006765 /*
6766 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006767 * checked before calling this function.
6768 *
6769 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006770 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006771 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6773 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6774 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006775 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006776 }
6777
6778 /*
6779 * PMS = struct {
6780 * opaque other_secret<0..2^16-1>;
6781 * opaque psk<0..2^16-1>;
6782 * };
6783 * with "other_secret" depending on the particular key exchange
6784 */
6785#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006786 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6787 if (end - p < 2) {
6788 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6789 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006790
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006792 p += 2;
6793
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 if (end < p || (size_t) (end - p) < psk_len) {
6795 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6796 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006797
Gilles Peskine449bd832023-01-11 14:50:10 +01006798 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006799 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006801#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6802#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006804 /*
6805 * other_secret already set by the ClientKeyExchange message,
6806 * and is 48 bytes long
6807 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 if (end - p < 2) {
6809 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6810 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006811
6812 *p++ = 0;
6813 *p++ = 48;
6814 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006816#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6817#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006819 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6820 size_t len;
6821
6822 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006823 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6824 p + 2, end - (p + 2), &len,
6825 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6826 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6827 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006828 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006830 p += 2 + len;
6831
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6833 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006834#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006835#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006837 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6838 size_t zlen;
6839
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6841 p + 2, end - (p + 2),
6842 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6843 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6844 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006845 }
6846
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006848 p += 2 + zlen;
6849
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6851 MBEDTLS_DEBUG_ECDH_Z);
6852 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006853#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006854 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6856 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006857 }
6858
6859 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 if (end - p < 2) {
6861 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6862 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006863
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006865 p += 2;
6866
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 if (end < p || (size_t) (end - p) < psk_len) {
6868 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6869 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006870
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006872 p += psk_len;
6873
6874 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6875
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006877}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006878#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006879
6880#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006881MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006882static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006883
6884#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006885int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006886{
6887 /* If renegotiation is not enforced, retransmit until we would reach max
6888 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006890 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6891 unsigned char doublings = 1;
6892
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006894 ++doublings;
6895 ratio >>= 1;
6896 }
6897
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 if (++ssl->renego_records_seen > doublings) {
6899 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6900 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006901 }
6902 }
6903
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006905}
6906#endif
6907#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006908
Jerry Yud9526692022-02-17 14:23:47 +08006909/*
6910 * Handshake functions
6911 */
6912#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6913/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006914int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006915{
6916 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6917 ssl->handshake->ciphersuite_info;
6918
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006920
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6922 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006923 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006925 }
6926
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6928 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006929}
6930
Gilles Peskine449bd832023-01-11 14:50:10 +01006931int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006932{
6933 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6934 ssl->handshake->ciphersuite_info;
6935
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006937
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6939 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006940 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006941 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006942 }
6943
Gilles Peskine449bd832023-01-11 14:50:10 +01006944 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6945 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006946}
6947
6948#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6949/* Some certificate support -> implement write and parse */
6950
Gilles Peskine449bd832023-01-11 14:50:10 +01006951int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006952{
6953 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6954 size_t i, n;
6955 const mbedtls_x509_crt *crt;
6956 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6957 ssl->handshake->ciphersuite_info;
6958
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006960
Gilles Peskine449bd832023-01-11 14:50:10 +01006961 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
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#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6969 if (ssl->handshake->client_auth == 0) {
6970 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006971 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006973 }
6974 }
6975#endif /* MBEDTLS_SSL_CLI_C */
6976#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6978 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006979 /* Should never happen because we shouldn't have picked the
6980 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006981 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006982 }
6983 }
6984#endif
6985
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006987
6988 /*
6989 * 0 . 0 handshake type
6990 * 1 . 3 handshake length
6991 * 4 . 6 length of all certs
6992 * 7 . 9 length of cert. 1
6993 * 10 . n-1 peer certificate
6994 * n . n+2 length of cert. 2
6995 * n+3 . ... upper level cert, etc.
6996 */
6997 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006999
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007001 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007002 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7003 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7004 " > %" MBEDTLS_PRINTF_SIZET,
7005 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7006 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007007 }
7008
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7010 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7011 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007012
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007014 i += n; crt = crt->next;
7015 }
7016
Gilles Peskine449bd832023-01-11 14:50:10 +01007017 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7018 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7019 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007020
7021 ssl->out_msglen = i;
7022 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7023 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7024
7025 ssl->state++;
7026
Gilles Peskine449bd832023-01-11 14:50:10 +01007027 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7028 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7029 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007030 }
7031
Gilles Peskine449bd832023-01-11 14:50:10 +01007032 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007033
Gilles Peskine449bd832023-01-11 14:50:10 +01007034 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007035}
7036
7037#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7038
7039#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007040MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007041static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7042 unsigned char *crt_buf,
7043 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007044{
7045 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7046
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 if (peer_crt == NULL) {
7048 return -1;
7049 }
Jerry Yud9526692022-02-17 14:23:47 +08007050
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 if (peer_crt->raw.len != crt_buf_len) {
7052 return -1;
7053 }
Jerry Yud9526692022-02-17 14:23:47 +08007054
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007056}
7057#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007058MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007059static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7060 unsigned char *crt_buf,
7061 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007062{
7063 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7064 unsigned char const * const peer_cert_digest =
7065 ssl->session->peer_cert_digest;
7066 mbedtls_md_type_t const peer_cert_digest_type =
7067 ssl->session->peer_cert_digest_type;
7068 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007070 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7071 size_t digest_len;
7072
Gilles Peskine449bd832023-01-11 14:50:10 +01007073 if (peer_cert_digest == NULL || digest_info == NULL) {
7074 return -1;
7075 }
Jerry Yud9526692022-02-17 14:23:47 +08007076
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 digest_len = mbedtls_md_get_size(digest_info);
7078 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7079 return -1;
7080 }
Jerry Yud9526692022-02-17 14:23:47 +08007081
Gilles Peskine449bd832023-01-11 14:50:10 +01007082 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7083 if (ret != 0) {
7084 return -1;
7085 }
Jerry Yud9526692022-02-17 14:23:47 +08007086
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007088}
7089#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7090#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7091
7092/*
7093 * Once the certificate message is read, parse it into a cert chain and
7094 * perform basic checks, but leave actual verification to the caller
7095 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007096MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007097static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7098 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007099{
7100 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7101#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007102 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007103#endif
7104 size_t i, n;
7105 uint8_t alert;
7106
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7108 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7109 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7110 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7111 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007112 }
7113
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7115 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7116 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7117 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007118 }
7119
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7121 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7122 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7123 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7124 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007125 }
7126
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007128
7129 /*
7130 * Same message structure as in mbedtls_ssl_write_certificate()
7131 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007133
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 if (ssl->in_msg[i] != 0 ||
7135 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7136 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7137 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7138 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7139 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007140 }
7141
7142 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7143 i += 3;
7144
7145 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007147 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 if (i + 3 > ssl->in_hslen) {
7149 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7150 mbedtls_ssl_send_alert_message(ssl,
7151 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7152 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7153 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007154 }
7155 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7156 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 if (ssl->in_msg[i] != 0) {
7158 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7159 mbedtls_ssl_send_alert_message(ssl,
7160 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7161 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7162 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007163 }
7164
7165 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007167 | (unsigned int) ssl->in_msg[i + 2];
7168 i += 3;
7169
Gilles Peskine449bd832023-01-11 14:50:10 +01007170 if (n < 128 || i + n > ssl->in_hslen) {
7171 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7172 mbedtls_ssl_send_alert_message(ssl,
7173 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7174 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7175 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007176 }
7177
7178 /* Check if we're handling the first CRT in the chain. */
7179#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007181 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007183 /* During client-side renegotiation, check that the server's
7184 * end-CRTs hasn't changed compared to the initial handshake,
7185 * mitigating the triple handshake attack. On success, reuse
7186 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007187 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7188 if (ssl_check_peer_crt_unchanged(ssl,
7189 &ssl->in_msg[i],
7190 n) != 0) {
7191 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7192 mbedtls_ssl_send_alert_message(ssl,
7193 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7194 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7195 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007196 }
7197
7198 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007199 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007200 }
7201#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7202
7203 /* Parse the next certificate in the chain. */
7204#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007206#else
7207 /* If we don't need to store the CRT chain permanently, parse
7208 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007210#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007212 case 0: /*ok*/
7213 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7214 /* Ignore certificate with an unknown algorithm: maybe a
7215 prior certificate was already trusted. */
7216 break;
7217
7218 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7219 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7220 goto crt_parse_der_failed;
7221
7222 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7223 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7224 goto crt_parse_der_failed;
7225
7226 default:
7227 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007228crt_parse_der_failed:
7229 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7230 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7231 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007232 }
7233
7234 i += n;
7235 }
7236
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7238 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007239}
7240
7241#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007242MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007243static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007244{
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7246 return -1;
7247 }
Jerry Yud9526692022-02-17 14:23:47 +08007248
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007250 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7251 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7253 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7254 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007255 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007256 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007257}
7258#endif /* MBEDTLS_SSL_SRV_C */
7259
7260/* Check if a certificate message is expected.
7261 * Return either
7262 * - SSL_CERTIFICATE_EXPECTED, or
7263 * - SSL_CERTIFICATE_SKIP
7264 * indicating whether a Certificate message is expected or not.
7265 */
7266#define SSL_CERTIFICATE_EXPECTED 0
7267#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007268MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007269static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7270 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007271{
7272 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7273 ssl->handshake->ciphersuite_info;
7274
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7276 return SSL_CERTIFICATE_SKIP;
7277 }
Jerry Yud9526692022-02-17 14:23:47 +08007278
7279#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7281 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7282 return SSL_CERTIFICATE_SKIP;
7283 }
Jerry Yud9526692022-02-17 14:23:47 +08007284
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007286 ssl->session_negotiate->verify_result =
7287 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007288 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007289 }
7290 }
7291#else
7292 ((void) authmode);
7293#endif /* MBEDTLS_SSL_SRV_C */
7294
Gilles Peskine449bd832023-01-11 14:50:10 +01007295 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007296}
7297
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007298MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007299static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7300 int authmode,
7301 mbedtls_x509_crt *chain,
7302 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007303{
7304 int ret = 0;
7305 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7306 ssl->handshake->ciphersuite_info;
7307 int have_ca_chain = 0;
7308
7309 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7310 void *p_vrfy;
7311
Gilles Peskine449bd832023-01-11 14:50:10 +01007312 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7313 return 0;
7314 }
Jerry Yud9526692022-02-17 14:23:47 +08007315
Gilles Peskine449bd832023-01-11 14:50:10 +01007316 if (ssl->f_vrfy != NULL) {
7317 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007318 f_vrfy = ssl->f_vrfy;
7319 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007320 } else {
7321 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007322 f_vrfy = ssl->conf->f_vrfy;
7323 p_vrfy = ssl->conf->p_vrfy;
7324 }
7325
7326 /*
7327 * Main check: verify certificate
7328 */
7329#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007330 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007331 ((void) rs_ctx);
7332 have_ca_chain = 1;
7333
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007335 ret = mbedtls_x509_crt_verify_with_ca_cb(
7336 chain,
7337 ssl->conf->f_ca_cb,
7338 ssl->conf->p_ca_cb,
7339 ssl->conf->cert_profile,
7340 ssl->hostname,
7341 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007342 f_vrfy, p_vrfy);
7343 } else
Jerry Yud9526692022-02-17 14:23:47 +08007344#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7345 {
7346 mbedtls_x509_crt *ca_chain;
7347 mbedtls_x509_crl *ca_crl;
7348
7349#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007350 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007351 ca_chain = ssl->handshake->sni_ca_chain;
7352 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 } else
Jerry Yud9526692022-02-17 14:23:47 +08007354#endif
7355 {
7356 ca_chain = ssl->conf->ca_chain;
7357 ca_crl = ssl->conf->ca_crl;
7358 }
7359
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007361 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 }
Jerry Yud9526692022-02-17 14:23:47 +08007363
7364 ret = mbedtls_x509_crt_verify_restartable(
7365 chain,
7366 ca_chain, ca_crl,
7367 ssl->conf->cert_profile,
7368 ssl->hostname,
7369 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007371 }
7372
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 if (ret != 0) {
7374 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007375 }
7376
7377#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007378 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7379 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7380 }
Jerry Yud9526692022-02-17 14:23:47 +08007381#endif
7382
7383 /*
7384 * Secondary checks: always done, but change 'ret' only if it was 0
7385 */
7386
7387#if defined(MBEDTLS_ECP_C)
7388 {
7389 const mbedtls_pk_context *pk = &chain->pk;
7390
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007391 /* If certificate uses an EC key, make sure the curve is OK.
7392 * This is a public key, so it can't be opaque, so can_do() is a good
7393 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007394 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007395 /* and in the unlikely case the above assumption no longer holds
7396 * we are making sure that pk_ec() here does not return a NULL
7397 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 const mbedtls_ecp_keypair *ec = mbedtls_pk_ec(*pk);
7399 if (ec == NULL) {
7400 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_pk_ec() returned NULL"));
7401 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007402 }
Jerry Yud9526692022-02-17 14:23:47 +08007403
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 if (mbedtls_ssl_check_curve(ssl, ec->grp.id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007405 ssl->session_negotiate->verify_result |=
7406 MBEDTLS_X509_BADCERT_BAD_KEY;
7407
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7409 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007410 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007412 }
Jerry Yud9526692022-02-17 14:23:47 +08007413 }
7414 }
7415#endif /* MBEDTLS_ECP_C */
7416
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 if (mbedtls_ssl_check_cert_usage(chain,
7418 ciphersuite_info,
7419 !ssl->conf->endpoint,
7420 &ssl->session_negotiate->verify_result) != 0) {
7421 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7422 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007423 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 }
Jerry Yud9526692022-02-17 14:23:47 +08007425 }
7426
7427 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7428 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7429 * with details encoded in the verification flags. All other kinds
7430 * of error codes, including those from the user provided f_vrfy
7431 * functions, are treated as fatal and lead to a failure of
7432 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7434 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7435 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007436 ret = 0;
7437 }
7438
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7440 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007441 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7442 }
7443
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007445 uint8_t alert;
7446
7447 /* The certificate may have been rejected for several reasons.
7448 Pick one and send the corresponding alert. Which alert to send
7449 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007451 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007453 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
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_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007457 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007459 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007461 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007463 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007465 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007467 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007469 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007471 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 }
7473 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7474 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007475 }
7476
7477#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 if (ssl->session_negotiate->verify_result != 0) {
7479 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7480 (unsigned int) ssl->session_negotiate->verify_result));
7481 } else {
7482 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007483 }
7484#endif /* MBEDTLS_DEBUG_C */
7485
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007487}
7488
7489#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007490MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007491static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7492 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007493{
7494 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7495 /* Remember digest of the peer's end-CRT. */
7496 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7498 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7499 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7500 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7501 mbedtls_ssl_send_alert_message(ssl,
7502 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7503 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007504
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007506 }
7507
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 ret = mbedtls_md(mbedtls_md_info_from_type(
7509 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7510 start, len,
7511 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007512
7513 ssl->session_negotiate->peer_cert_digest_type =
7514 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7515 ssl->session_negotiate->peer_cert_digest_len =
7516 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7517
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007519}
7520
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007521MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007522static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7523 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007524{
7525 unsigned char *end = start + len;
7526 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7527
7528 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7530 ret = mbedtls_pk_parse_subpubkey(&start, end,
7531 &ssl->handshake->peer_pubkey);
7532 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007533 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007535 }
7536
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007538}
7539#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7540
Gilles Peskine449bd832023-01-11 14:50:10 +01007541int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007542{
7543 int ret = 0;
7544 int crt_expected;
7545#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7546 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7547 ? ssl->handshake->sni_authmode
7548 : ssl->conf->authmode;
7549#else
7550 const int authmode = ssl->conf->authmode;
7551#endif
7552 void *rs_ctx = NULL;
7553 mbedtls_x509_crt *chain = NULL;
7554
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007556
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7558 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7559 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007560 goto exit;
7561 }
7562
7563#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 if (ssl->handshake->ecrs_enabled &&
7565 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007566 chain = ssl->handshake->ecrs_peer_cert;
7567 ssl->handshake->ecrs_peer_cert = NULL;
7568 goto crt_verify;
7569 }
7570#endif
7571
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007573 /* mbedtls_ssl_read_record may have sent an alert already. We
7574 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007576 goto exit;
7577 }
7578
7579#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007581 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7582
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007584 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 }
Jerry Yud9526692022-02-17 14:23:47 +08007586
7587 goto exit;
7588 }
7589#endif /* MBEDTLS_SSL_SRV_C */
7590
7591 /* Clear existing peer CRT structure in case we tried to
7592 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007594
Gilles Peskine449bd832023-01-11 14:50:10 +01007595 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7596 if (chain == NULL) {
7597 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7598 sizeof(mbedtls_x509_crt)));
7599 mbedtls_ssl_send_alert_message(ssl,
7600 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7601 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007602
7603 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7604 goto exit;
7605 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007607
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 ret = ssl_parse_certificate_chain(ssl, chain);
7609 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007610 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 }
Jerry Yud9526692022-02-17 14:23:47 +08007612
7613#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007615 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 }
Jerry Yud9526692022-02-17 14:23:47 +08007617
7618crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007620 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 }
Jerry Yud9526692022-02-17 14:23:47 +08007622#endif
7623
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 ret = ssl_parse_certificate_verify(ssl, authmode,
7625 chain, rs_ctx);
7626 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007627 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 }
Jerry Yud9526692022-02-17 14:23:47 +08007629
7630#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7631 {
7632 unsigned char *crt_start, *pk_start;
7633 size_t crt_len, pk_len;
7634
7635 /* We parse the CRT chain without copying, so
7636 * these pointers point into the input buffer,
7637 * and are hence still valid after freeing the
7638 * CRT chain. */
7639
7640 crt_start = chain->raw.p;
7641 crt_len = chain->raw.len;
7642
7643 pk_start = chain->pk_raw.p;
7644 pk_len = chain->pk_raw.len;
7645
7646 /* Free the CRT structures before computing
7647 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 mbedtls_x509_crt_free(chain);
7649 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007650 chain = NULL;
7651
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7653 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007654 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 }
Jerry Yud9526692022-02-17 14:23:47 +08007656
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7658 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007659 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 }
Jerry Yud9526692022-02-17 14:23:47 +08007661 }
7662#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7663 /* Pass ownership to session structure. */
7664 ssl->session_negotiate->peer_cert = chain;
7665 chain = NULL;
7666#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7667
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007669
7670exit:
7671
Gilles Peskine449bd832023-01-11 14:50:10 +01007672 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007673 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007674 }
Jerry Yud9526692022-02-17 14:23:47 +08007675
7676#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007678 ssl->handshake->ecrs_peer_cert = chain;
7679 chain = NULL;
7680 }
7681#endif
7682
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 if (chain != NULL) {
7684 mbedtls_x509_crt_free(chain);
7685 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007686 }
7687
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007689}
7690#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7691
Andrzej Kurek25f27152022-08-17 16:09:31 -04007692#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007693static int ssl_calc_finished_tls_sha256(
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007695{
7696 int len = 12;
7697 const char *sender;
7698 unsigned char padbuf[32];
7699#if defined(MBEDTLS_USE_PSA_CRYPTO)
7700 size_t hash_size;
7701 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
7702 psa_status_t status;
7703#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007704 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007705 mbedtls_md_context_t sha256;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007706#endif
7707
7708 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007710 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007711 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007712
Gilles Peskine449bd832023-01-11 14:50:10 +01007713 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007714 ? "client finished"
7715 : "server finished";
7716
7717#if defined(MBEDTLS_USE_PSA_CRYPTO)
7718 sha256_psa = psa_hash_operation_init();
7719
Gilles Peskine449bd832023-01-11 14:50:10 +01007720 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls sha256"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007721
Gilles Peskine449bd832023-01-11 14:50:10 +01007722 status = psa_hash_clone(&ssl->handshake->fin_sha256_psa, &sha256_psa);
7723 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007724 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007725 }
7726
Gilles Peskine449bd832023-01-11 14:50:10 +01007727 status = psa_hash_finish(&sha256_psa, padbuf, sizeof(padbuf), &hash_size);
7728 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007729 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007730 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, 32);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007732#else
7733
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007734 mbedtls_md_init(&sha256);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007735
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls sha256"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007737
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007738 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
7739 if (ret != 0) {
7740 goto exit;
7741 }
7742 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
7743 if (ret != 0) {
7744 goto exit;
7745 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007746
7747 /*
7748 * TLSv1.2:
7749 * hash = PRF( master, finished_label,
7750 * Hash( handshake ) )[0.11]
7751 */
7752
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007753 ret = mbedtls_md_finish(&sha256, padbuf);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007754 if (ret != 0) {
7755 goto exit;
7756 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007757#endif /* MBEDTLS_USE_PSA_CRYPTO */
7758
Manuel Pégourié-Gonnard0ac71c02023-02-24 12:13:55 +01007759 MBEDTLS_SSL_DEBUG_BUF(4, "finished sha256 output", padbuf, 32);
7760
Gilles Peskine449bd832023-01-11 14:50:10 +01007761 ssl->handshake->tls_prf(session->master, 48, sender,
7762 padbuf, 32, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007763
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007765
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007767
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007769
7770exit:
7771#if defined(MBEDTLS_USE_PSA_CRYPTO)
7772 psa_hash_abort(&sha256_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05007773 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007774#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007775 mbedtls_md_free(&sha256);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007776 return ret;
7777#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007778}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04007779#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007780
Jerry Yub7ba49e2022-02-17 14:25:53 +08007781
Andrzej Kurek25f27152022-08-17 16:09:31 -04007782#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007783static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007785{
7786 int len = 12;
7787 const char *sender;
7788 unsigned char padbuf[48];
7789#if defined(MBEDTLS_USE_PSA_CRYPTO)
7790 size_t hash_size;
7791 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
7792 psa_status_t status;
7793#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007794 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007795 mbedtls_md_context_t sha384;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007796#endif
7797
7798 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 if (!session) {
Jerry Yub7ba49e2022-02-17 14:25:53 +08007800 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007802
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007804 ? "client finished"
7805 : "server finished";
7806
7807#if defined(MBEDTLS_USE_PSA_CRYPTO)
7808 sha384_psa = psa_hash_operation_init();
7809
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls sha384"));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007811
Gilles Peskine449bd832023-01-11 14:50:10 +01007812 status = psa_hash_clone(&ssl->handshake->fin_sha384_psa, &sha384_psa);
7813 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007814 goto exit;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007815 }
7816
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 status = psa_hash_finish(&sha384_psa, padbuf, sizeof(padbuf), &hash_size);
7818 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007819 goto exit;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007820 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, 48);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007822#else
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007823 mbedtls_md_init(&sha384);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007824
Gilles Peskine449bd832023-01-11 14:50:10 +01007825 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls sha384"));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007826
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007827 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007828 if (ret != 0) {
7829 goto exit;
7830 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007831 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007832 if (ret != 0) {
7833 goto exit;
7834 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007835
7836 /*
7837 * TLSv1.2:
7838 * hash = PRF( master, finished_label,
7839 * Hash( handshake ) )[0.11]
7840 */
7841
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007842 ret = mbedtls_md_finish(&sha384, padbuf);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007843 if (ret != 0) {
7844 goto exit;
7845 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007846#endif
7847
Manuel Pégourié-Gonnard0ac71c02023-02-24 12:13:55 +01007848 MBEDTLS_SSL_DEBUG_BUF(4, "finished sha384 output", padbuf, 48);
7849
Gilles Peskine449bd832023-01-11 14:50:10 +01007850 ssl->handshake->tls_prf(session->master, 48, sender,
7851 padbuf, 48, buf, len);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007852
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007854
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007856
Gilles Peskine449bd832023-01-11 14:50:10 +01007857 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007858
7859exit:
7860#if defined(MBEDTLS_USE_PSA_CRYPTO)
7861 psa_hash_abort(&sha384_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05007862 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007863#else
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007864 mbedtls_md_free(&sha384);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007865 return ret;
7866#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yub7ba49e2022-02-17 14:25:53 +08007867}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04007868#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007869
Gilles Peskine449bd832023-01-11 14:50:10 +01007870void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007871{
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007873
7874 /*
7875 * Free our handshake params
7876 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007877 mbedtls_ssl_handshake_free(ssl);
7878 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007879 ssl->handshake = NULL;
7880
7881 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007882 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007883 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 if (ssl->transform) {
7885 mbedtls_ssl_transform_free(ssl->transform);
7886 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007887 }
7888 ssl->transform = ssl->transform_negotiate;
7889 ssl->transform_negotiate = NULL;
7890
Gilles Peskine449bd832023-01-11 14:50:10 +01007891 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007892}
7893
Gilles Peskine449bd832023-01-11 14:50:10 +01007894void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007895{
7896 int resume = ssl->handshake->resume;
7897
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007899
7900#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007902 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7903 ssl->renego_records_seen = 0;
7904 }
7905#endif
7906
7907 /*
7908 * Free the previous session and switch in the current one
7909 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007911#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7912 /* RFC 7366 3.1: keep the EtM state */
7913 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007915#endif
7916
Gilles Peskine449bd832023-01-11 14:50:10 +01007917 mbedtls_ssl_session_free(ssl->session);
7918 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007919 }
7920 ssl->session = ssl->session_negotiate;
7921 ssl->session_negotiate = NULL;
7922
7923 /*
7924 * Add cache entry
7925 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007927 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007928 resume == 0) {
7929 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7930 ssl->session->id,
7931 ssl->session->id_len,
7932 ssl->session) != 0) {
7933 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7934 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007935 }
7936
7937#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7939 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007940 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007942
7943 /* Keep last flight around in case we need to resend it:
7944 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007945 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7946 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007947#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007948 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007949
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007950 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007951
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007953}
7954
Gilles Peskine449bd832023-01-11 14:50:10 +01007955int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007956{
7957 int ret, hash_len;
7958
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007960
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007962
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007963 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7964 if (ret != 0) {
7965 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7966 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007967
7968 /*
7969 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7970 * may define some other value. Currently (early 2016), no defined
7971 * ciphersuite does this (and this is unlikely to change as activity has
7972 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7973 */
7974 hash_len = 12;
7975
7976#if defined(MBEDTLS_SSL_RENEGOTIATION)
7977 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007979#endif
7980
7981 ssl->out_msglen = 4 + hash_len;
7982 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7983 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7984
7985 /*
7986 * In case of session resuming, invert the client and server
7987 * ChangeCipherSpec messages order.
7988 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007990#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007992 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007994#endif
7995#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007996 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007997 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007999#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008001 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008002 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008003
8004 /*
8005 * Switch to our negotiated transform and session parameters for outbound
8006 * data.
8007 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008009
8010#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008012 unsigned char i;
8013
8014 /* Remember current epoch settings for resending */
8015 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8017 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008018
8019 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008020 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008021
8022
8023 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 for (i = 2; i > 0; i--) {
8025 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008026 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 }
8028 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008029
8030 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 if (i == 0) {
8032 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8033 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008034 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008036#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008038
8039 ssl->transform_out = ssl->transform_negotiate;
8040 ssl->session_out = ssl->session_negotiate;
8041
8042#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008043 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8044 mbedtls_ssl_send_flight_completed(ssl);
8045 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008046#endif
8047
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8049 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8050 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008051 }
8052
8053#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8055 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8056 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8057 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008058 }
8059#endif
8060
Gilles Peskine449bd832023-01-11 14:50:10 +01008061 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008062
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008064}
8065
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008066#define SSL_MAX_HASH_LEN 12
8067
Gilles Peskine449bd832023-01-11 14:50:10 +01008068int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008069{
8070 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8071 unsigned int hash_len = 12;
8072 unsigned char buf[SSL_MAX_HASH_LEN];
8073
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008075
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008076 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8077 if (ret != 0) {
8078 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8079 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008080
Gilles Peskine449bd832023-01-11 14:50:10 +01008081 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8082 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008083 goto exit;
8084 }
8085
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8087 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8088 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8089 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008090 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8091 goto exit;
8092 }
8093
Gilles Peskine449bd832023-01-11 14:50:10 +01008094 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8095 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8096 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008097 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8098 goto exit;
8099 }
8100
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8102 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8103 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8104 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008105 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8106 goto exit;
8107 }
8108
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8110 buf, hash_len) != 0) {
8111 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8112 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8113 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008114 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8115 goto exit;
8116 }
8117
8118#if defined(MBEDTLS_SSL_RENEGOTIATION)
8119 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008121#endif
8122
Gilles Peskine449bd832023-01-11 14:50:10 +01008123 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008124#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008126 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008127 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008128#endif
8129#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008130 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008131 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008132 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008133#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008134 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008135 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008136 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008137
8138#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008139 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8140 mbedtls_ssl_recv_flight_completed(ssl);
8141 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008142#endif
8143
Gilles Peskine449bd832023-01-11 14:50:10 +01008144 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008145
8146exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 mbedtls_platform_zeroize(buf, hash_len);
8148 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008149}
8150
Jerry Yu392112c2022-02-17 14:34:10 +08008151#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8152/*
8153 * Helper to get TLS 1.2 PRF from ciphersuite
8154 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008156static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008157{
Jerry Yu392112c2022-02-17 14:34:10 +08008158 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008159 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Andrzej Kurek68327742022-10-03 06:18:18 -04008160#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01008161 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8162 return tls_prf_sha384;
8163 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008164#endif
Andrzej Kurek894edde2022-09-29 06:31:14 -04008165#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
8166 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008167 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8168 return tls_prf_sha256;
8169 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008170 }
8171#endif
8172#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
8173 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
8174 (void) ciphersuite_info;
8175#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008176
Gilles Peskine449bd832023-01-11 14:50:10 +01008177 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008178}
8179#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008180
Gilles Peskine449bd832023-01-11 14:50:10 +01008181static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008182{
8183 ((void) tls_prf);
Andrzej Kurek25f27152022-08-17 16:09:31 -04008184#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01008185 if (tls_prf == tls_prf_sha384) {
8186 return MBEDTLS_SSL_TLS_PRF_SHA384;
8187 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008188#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04008189#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01008190 if (tls_prf == tls_prf_sha256) {
8191 return MBEDTLS_SSL_TLS_PRF_SHA256;
8192 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008193#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008194 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008195}
8196
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008197/*
8198 * Populate a transform structure with session keys and all the other
8199 * necessary information.
8200 *
8201 * Parameters:
8202 * - [in/out]: transform: structure to populate
8203 * [in] must be just initialised with mbedtls_ssl_transform_init()
8204 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8205 * - [in] ciphersuite
8206 * - [in] master
8207 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008208 * - [in] tls_prf: pointer to PRF to use for key derivation
8209 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008210 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008211 * - [in] endpoint: client or server
8212 * - [in] ssl: used for:
8213 * - ssl->conf->{f,p}_export_keys
8214 * [in] optionally used for:
8215 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8216 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008217MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008218static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8219 int ciphersuite,
8220 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008221#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008222 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008223#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008224 ssl_tls_prf_t tls_prf,
8225 const unsigned char randbytes[64],
8226 mbedtls_ssl_protocol_version tls_version,
8227 unsigned endpoint,
8228 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008229{
8230 int ret = 0;
8231 unsigned char keyblk[256];
8232 unsigned char *key1;
8233 unsigned char *key2;
8234 unsigned char *mac_enc;
8235 unsigned char *mac_dec;
8236 size_t mac_key_len = 0;
8237 size_t iv_copy_len;
8238 size_t keylen;
8239 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008240 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008241#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008242 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008243 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008244#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008245
8246#if defined(MBEDTLS_USE_PSA_CRYPTO)
8247 psa_key_type_t key_type;
8248 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8249 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008250 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008251 size_t key_bits;
8252 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8253#endif
8254
8255#if !defined(MBEDTLS_DEBUG_C) && \
8256 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008257 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008258 ssl = NULL; /* make sure we don't use it except for these cases */
8259 (void) ssl;
8260 }
8261#endif
8262
8263 /*
8264 * Some data just needs copying into the structure
8265 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008266#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008267 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008268#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008269 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008270
8271#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008273#endif
8274
8275#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008276 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008277 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8278 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008280 }
8281#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8282
8283 /*
8284 * Get various info structures
8285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8287 if (ciphersuite_info == NULL) {
8288 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8289 ciphersuite));
8290 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008291 }
8292
Neil Armstrongab555e02022-04-04 11:07:59 +02008293 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008294#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008296#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008298
Gilles Peskine449bd832023-01-11 14:50:10 +01008299 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008300 transform->taglen =
8301 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008302 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008303
8304#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008305 if ((status = mbedtls_ssl_cipher_to_psa(ciphersuite_info->cipher,
8306 transform->taglen,
8307 &alg,
8308 &key_type,
8309 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008310 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008312 goto end;
8313 }
8314#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008315 cipher_info = mbedtls_cipher_info_from_type(ciphersuite_info->cipher);
8316 if (cipher_info == NULL) {
8317 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8318 ciphersuite_info->cipher));
8319 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008320 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008321#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008322
Neil Armstronge4512952022-03-08 09:08:22 +01008323#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008324 mac_alg = mbedtls_hash_info_psa_from_md(ciphersuite_info->mac);
8325 if (mac_alg == 0) {
8326 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_hash_info_psa_from_md for %u not found",
8327 (unsigned) ciphersuite_info->mac));
8328 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008329 }
8330#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008331 md_info = mbedtls_md_info_from_type(ciphersuite_info->mac);
8332 if (md_info == NULL) {
8333 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8334 (unsigned) ciphersuite_info->mac));
8335 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008336 }
Neil Armstronge4512952022-03-08 09:08:22 +01008337#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008338
8339#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8340 /* Copy own and peer's CID if the use of the CID
8341 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008342 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8343 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008344
8345 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008346 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8347 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8348 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008349
8350 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008351 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8352 ssl->handshake->peer_cid_len);
8353 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8354 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008355 }
8356#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8357
8358 /*
8359 * Compute key block using the PRF
8360 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008361 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8362 if (ret != 0) {
8363 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8364 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008365 }
8366
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8368 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8369 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8370 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8371 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008372
8373 /*
8374 * Determine the appropriate key, IV and MAC length.
8375 */
8376
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008377#if defined(MBEDTLS_USE_PSA_CRYPTO)
8378 keylen = PSA_BITS_TO_BYTES(key_bits);
8379#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008380 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008381#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008382
8383#if defined(MBEDTLS_GCM_C) || \
8384 defined(MBEDTLS_CCM_C) || \
8385 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008386 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008387 size_t explicit_ivlen;
8388
8389 transform->maclen = 0;
8390 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008391
8392 /* All modes haves 96-bit IVs, but the length of the static parts vary
8393 * with mode and version:
8394 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8395 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8396 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8397 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8398 * sequence number).
8399 */
8400 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008401
8402 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008403#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008404 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008405#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008406 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8407 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008408#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008409
Gilles Peskine449bd832023-01-11 14:50:10 +01008410 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008411 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008412 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008413 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008414 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008415
8416 /* Minimum length of encrypted record */
8417 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8418 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008419 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008420#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8421#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008422 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008423 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008424 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008425#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008426 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008427#else
8428 size_t block_size = cipher_info->block_size;
8429#endif /* MBEDTLS_USE_PSA_CRYPTO */
8430
8431#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008432 /* Get MAC length */
8433 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8434#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008435 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008436 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8437 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8438 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008439 goto end;
8440 }
8441
8442 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008443 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008444#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008445 transform->maclen = mac_key_len;
8446
8447 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008448#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008449 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008450#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008451 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008452#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008453
8454 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008455 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008456 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008457 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008458 /*
8459 * GenericBlockCipher:
8460 * 1. if EtM is in use: one block plus MAC
8461 * otherwise: * first multiple of blocklen greater than maclen
8462 * 2. IV
8463 */
8464#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008466 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008467 + block_size;
8468 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008469#endif
8470 {
8471 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008472 + block_size
8473 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008474 }
8475
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008477 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008478 } else {
8479 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008480 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8481 goto end;
8482 }
8483 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008484 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008485#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8486 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008487 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8488 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008489 }
8490
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8492 (unsigned) keylen,
8493 (unsigned) transform->minlen,
8494 (unsigned) transform->ivlen,
8495 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008496
8497 /*
8498 * Finally setup the cipher contexts, IVs and MAC secrets.
8499 */
8500#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008501 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008502 key1 = keyblk + mac_key_len * 2;
8503 key2 = keyblk + mac_key_len * 2 + keylen;
8504
8505 mac_enc = keyblk;
8506 mac_dec = keyblk + mac_key_len;
8507
Gilles Peskine449bd832023-01-11 14:50:10 +01008508 iv_copy_len = (transform->fixed_ivlen) ?
8509 transform->fixed_ivlen : transform->ivlen;
8510 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8511 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8512 iv_copy_len);
8513 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008514#endif /* MBEDTLS_SSL_CLI_C */
8515#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008517 key1 = keyblk + mac_key_len * 2 + keylen;
8518 key2 = keyblk + mac_key_len * 2;
8519
8520 mac_enc = keyblk + mac_key_len;
8521 mac_dec = keyblk;
8522
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 iv_copy_len = (transform->fixed_ivlen) ?
8524 transform->fixed_ivlen : transform->ivlen;
8525 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8526 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8527 iv_copy_len);
8528 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008529#endif /* MBEDTLS_SSL_SRV_C */
8530 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008532 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8533 goto end;
8534 }
8535
Gilles Peskine449bd832023-01-11 14:50:10 +01008536 if (ssl != NULL && ssl->f_export_keys != NULL) {
8537 ssl->f_export_keys(ssl->p_export_keys,
8538 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8539 master, 48,
8540 randbytes + 32,
8541 randbytes,
8542 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008543 }
8544
8545#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008546 transform->psa_alg = alg;
8547
Gilles Peskine449bd832023-01-11 14:50:10 +01008548 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8549 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8550 psa_set_key_algorithm(&attributes, alg);
8551 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008552
Gilles Peskine449bd832023-01-11 14:50:10 +01008553 if ((status = psa_import_key(&attributes,
8554 key1,
8555 PSA_BITS_TO_BYTES(key_bits),
8556 &transform->psa_key_enc)) != PSA_SUCCESS) {
8557 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008558 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008559 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008560 goto end;
8561 }
8562
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008564
Gilles Peskine449bd832023-01-11 14:50:10 +01008565 if ((status = psa_import_key(&attributes,
8566 key2,
8567 PSA_BITS_TO_BYTES(key_bits),
8568 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008569 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008571 goto end;
8572 }
8573 }
8574#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8576 cipher_info)) != 0) {
8577 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008578 goto end;
8579 }
8580
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8582 cipher_info)) != 0) {
8583 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008584 goto end;
8585 }
8586
Gilles Peskine449bd832023-01-11 14:50:10 +01008587 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8588 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8589 MBEDTLS_ENCRYPT)) != 0) {
8590 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008591 goto end;
8592 }
8593
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8595 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8596 MBEDTLS_DECRYPT)) != 0) {
8597 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008598 goto end;
8599 }
8600
8601#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008602 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8603 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8604 MBEDTLS_PADDING_NONE)) != 0) {
8605 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008606 goto end;
8607 }
8608
Gilles Peskine449bd832023-01-11 14:50:10 +01008609 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8610 MBEDTLS_PADDING_NONE)) != 0) {
8611 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008612 goto end;
8613 }
8614 }
8615#endif /* MBEDTLS_CIPHER_MODE_CBC */
8616#endif /* MBEDTLS_USE_PSA_CRYPTO */
8617
Neil Armstrong29c0c042022-03-17 17:47:28 +01008618#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8619 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8620 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008621 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008622#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008623 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008624
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8626 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8627 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008628
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 if ((status = psa_import_key(&attributes,
8630 mac_enc, mac_key_len,
8631 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008632 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008633 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008634 goto end;
8635 }
8636
Gilles Peskine449bd832023-01-11 14:50:10 +01008637 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8638 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008639#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008640 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008641#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008643 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008644 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8645 PSA_KEY_USAGE_VERIFY_HASH);
8646 } else {
8647 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8648 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008649
Gilles Peskine449bd832023-01-11 14:50:10 +01008650 if ((status = psa_import_key(&attributes,
8651 mac_dec, mac_key_len,
8652 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008653 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008654 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008655 goto end;
8656 }
8657#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008658 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8659 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008660 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008661 }
8662 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8663 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008664 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008665 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008666#endif /* MBEDTLS_USE_PSA_CRYPTO */
8667 }
8668#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8669
8670 ((void) mac_dec);
8671 ((void) mac_enc);
8672
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008673end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008674 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8675 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008676}
8677
Valerio Settia08b1a42022-11-17 15:10:02 +01008678#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8679 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008680int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 psa_pake_operation_t *pake_ctx,
8682 const unsigned char *buf,
8683 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008684{
8685 psa_status_t status;
8686 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008687 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008688 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8689 * At round two perform a single cycle
8690 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008691 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008692
Gilles Peskine449bd832023-01-11 14:50:10 +01008693 for (; remaining_steps > 0; remaining_steps--) {
8694 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008695 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008696 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008697 /* Length is stored at the first byte */
8698 size_t length = buf[input_offset];
8699 input_offset += 1;
8700
Gilles Peskine449bd832023-01-11 14:50:10 +01008701 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008702 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8703 }
8704
Gilles Peskine449bd832023-01-11 14:50:10 +01008705 status = psa_pake_input(pake_ctx, step,
8706 buf + input_offset, length);
8707 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008708 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008709 }
8710
8711 input_offset += length;
8712 }
8713 }
8714
Gilles Peskine449bd832023-01-11 14:50:10 +01008715 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008716 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008717 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008718
Gilles Peskine449bd832023-01-11 14:50:10 +01008719 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008720}
8721
Valerio Setti6b3dab02022-11-17 17:14:54 +01008722int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008723 psa_pake_operation_t *pake_ctx,
8724 unsigned char *buf,
8725 size_t len, size_t *olen,
8726 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008727{
8728 psa_status_t status;
8729 size_t output_offset = 0;
8730 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008731 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008732 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8733 * At round two perform a single cycle
8734 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008735 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008736
Gilles Peskine449bd832023-01-11 14:50:10 +01008737 for (; remaining_steps > 0; remaining_steps--) {
8738 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8739 step <= PSA_PAKE_STEP_ZK_PROOF;
8740 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008741 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008742 * For each step, prepend 1 byte with the length of the data as
8743 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008744 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008745 status = psa_pake_output(pake_ctx, step,
8746 buf + output_offset + 1,
8747 len - output_offset - 1,
8748 &output_len);
8749 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008750 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008751 }
8752
Valerio Setti99d88c12022-11-22 16:03:43 +01008753 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008754
8755 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008756 }
8757 }
8758
8759 *olen = output_offset;
8760
Gilles Peskine449bd832023-01-11 14:50:10 +01008761 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008762}
Valerio Settia08b1a42022-11-17 15:10:02 +01008763#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8764
Jerry Yuee40f9d2022-02-17 14:55:16 +08008765#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008766int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8767 unsigned char *hash, size_t *hashlen,
8768 unsigned char *data, size_t data_len,
8769 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008770{
8771 psa_status_t status;
8772 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008773 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008774
Gilles Peskine449bd832023-01-11 14:50:10 +01008775 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008776
Gilles Peskine449bd832023-01-11 14:50:10 +01008777 if ((status = psa_hash_setup(&hash_operation,
8778 hash_alg)) != PSA_SUCCESS) {
8779 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008780 goto exit;
8781 }
8782
Gilles Peskine449bd832023-01-11 14:50:10 +01008783 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8784 64)) != PSA_SUCCESS) {
8785 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008786 goto exit;
8787 }
8788
Gilles Peskine449bd832023-01-11 14:50:10 +01008789 if ((status = psa_hash_update(&hash_operation,
8790 data, data_len)) != PSA_SUCCESS) {
8791 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008792 goto exit;
8793 }
8794
Gilles Peskine449bd832023-01-11 14:50:10 +01008795 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8796 hashlen)) != PSA_SUCCESS) {
8797 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8798 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008799 }
8800
8801exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008802 if (status != PSA_SUCCESS) {
8803 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8804 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8805 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008806 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008807 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008808 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8809 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008810 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008811 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008812 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008813 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008814 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008815 }
8816 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008817 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008818}
8819
8820#else
8821
Gilles Peskine449bd832023-01-11 14:50:10 +01008822int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8823 unsigned char *hash, size_t *hashlen,
8824 unsigned char *data, size_t data_len,
8825 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008826{
8827 int ret = 0;
8828 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008829 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8830 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008831
Gilles Peskine449bd832023-01-11 14:50:10 +01008832 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008833
Gilles Peskine449bd832023-01-11 14:50:10 +01008834 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008835
8836 /*
8837 * digitally-signed struct {
8838 * opaque client_random[32];
8839 * opaque server_random[32];
8840 * ServerDHParams params;
8841 * };
8842 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008843 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8844 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008845 goto exit;
8846 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008847 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8848 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008849 goto exit;
8850 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008851 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8852 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008853 goto exit;
8854 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008855 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8856 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008857 goto exit;
8858 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008859 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8860 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008861 goto exit;
8862 }
8863
8864exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008865 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008866
Gilles Peskine449bd832023-01-11 14:50:10 +01008867 if (ret != 0) {
8868 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8869 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8870 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008871
Gilles Peskine449bd832023-01-11 14:50:10 +01008872 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008873}
8874#endif /* MBEDTLS_USE_PSA_CRYPTO */
8875
Jerry Yud9d91da2022-02-17 14:57:06 +08008876#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8877
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008878/* Find the preferred hash for a given signature algorithm. */
8879unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008880 mbedtls_ssl_context *ssl,
8881 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008882{
Gabor Mezei078e8032022-04-27 21:17:56 +02008883 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008884 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008885
Gilles Peskine449bd832023-01-11 14:50:10 +01008886 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8887 return MBEDTLS_SSL_HASH_NONE;
8888 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008889
Gilles Peskine449bd832023-01-11 14:50:10 +01008890 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008891 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008892 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8893 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008894 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008895 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8896 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008897
Gilles Peskine449bd832023-01-11 14:50:10 +01008898 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008899#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008900 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008901 psa_algorithm_t psa_hash_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +01008902 mbedtls_hash_info_psa_from_md(hash_alg_received);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008903
Gilles Peskine449bd832023-01-11 14:50:10 +01008904 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8905 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8906 PSA_ALG_ECDSA(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
Gilles Peskine449bd832023-01-11 14:50:10 +01008911 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8912 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8913 PSA_ALG_RSA_PKCS1V15_SIGN(
8914 psa_hash_alg),
8915 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008916 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008917 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008918 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008919#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008920
Gilles Peskine449bd832023-01-11 14:50:10 +01008921 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008922 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008923 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008924
Gilles Peskine449bd832023-01-11 14:50:10 +01008925 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008926}
8927
8928#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8929
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008930/* Serialization of TLS 1.2 sessions:
8931 *
8932 * struct {
8933 * uint64 start_time;
8934 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008935 * uint8 session_id_len; // at most 32
8936 * opaque session_id[32];
8937 * opaque master[48]; // fixed length in the standard
8938 * uint32 verify_result;
8939 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8940 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8941 * uint32 ticket_lifetime;
8942 * uint8 mfl_code; // up to 255 according to standard
8943 * uint8 encrypt_then_mac; // 0 or 1
8944 * } serialized_session_tls12;
8945 *
8946 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008947static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8948 unsigned char *buf,
8949 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008950{
8951 unsigned char *p = buf;
8952 size_t used = 0;
8953
8954#if defined(MBEDTLS_HAVE_TIME)
8955 uint64_t start;
8956#endif
8957#if defined(MBEDTLS_X509_CRT_PARSE_C)
8958#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8959 size_t cert_len;
8960#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8961#endif /* MBEDTLS_X509_CRT_PARSE_C */
8962
8963 /*
8964 * Time
8965 */
8966#if defined(MBEDTLS_HAVE_TIME)
8967 used += 8;
8968
Gilles Peskine449bd832023-01-11 14:50:10 +01008969 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008970 start = (uint64_t) session->start;
8971
Gilles Peskine449bd832023-01-11 14:50:10 +01008972 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008973 p += 8;
8974 }
8975#endif /* MBEDTLS_HAVE_TIME */
8976
8977 /*
8978 * Basic mandatory fields
8979 */
8980 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008981 + 1 /* id_len */
8982 + sizeof(session->id)
8983 + sizeof(session->master)
8984 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008985
Gilles Peskine449bd832023-01-11 14:50:10 +01008986 if (used <= buf_len) {
8987 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008988 p += 2;
8989
Gilles Peskine449bd832023-01-11 14:50:10 +01008990 *p++ = MBEDTLS_BYTE_0(session->id_len);
8991 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008992 p += 32;
8993
Gilles Peskine449bd832023-01-11 14:50:10 +01008994 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008995 p += 48;
8996
Gilles Peskine449bd832023-01-11 14:50:10 +01008997 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008998 p += 4;
8999 }
9000
9001 /*
9002 * Peer's end-entity certificate
9003 */
9004#if defined(MBEDTLS_X509_CRT_PARSE_C)
9005#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01009006 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009007 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01009008 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009009 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009010 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009011
9012 used += 3 + cert_len;
9013
Gilles Peskine449bd832023-01-11 14:50:10 +01009014 if (used <= buf_len) {
9015 *p++ = MBEDTLS_BYTE_2(cert_len);
9016 *p++ = MBEDTLS_BYTE_1(cert_len);
9017 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009018
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 if (session->peer_cert != NULL) {
9020 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009021 p += cert_len;
9022 }
9023 }
9024#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01009025 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009026 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009027 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009028 *p++ = (unsigned char) session->peer_cert_digest_type;
9029 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009030 memcpy(p, session->peer_cert_digest,
9031 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009032 p += session->peer_cert_digest_len;
9033 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009034 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009035 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009036 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009037 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9038 *p++ = 0;
9039 }
9040 }
9041#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9042#endif /* MBEDTLS_X509_CRT_PARSE_C */
9043
9044 /*
9045 * Session ticket if any, plus associated data
9046 */
9047#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9048 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9049
Gilles Peskine449bd832023-01-11 14:50:10 +01009050 if (used <= buf_len) {
9051 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9052 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9053 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009054
Gilles Peskine449bd832023-01-11 14:50:10 +01009055 if (session->ticket != NULL) {
9056 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009057 p += session->ticket_len;
9058 }
9059
Gilles Peskine449bd832023-01-11 14:50:10 +01009060 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009061 p += 4;
9062 }
9063#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9064
9065 /*
9066 * Misc extension-related info
9067 */
9068#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9069 used += 1;
9070
Gilles Peskine449bd832023-01-11 14:50:10 +01009071 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009072 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009073 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009074#endif
9075
9076#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9077 used += 1;
9078
Gilles Peskine449bd832023-01-11 14:50:10 +01009079 if (used <= buf_len) {
9080 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9081 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009082#endif
9083
Gilles Peskine449bd832023-01-11 14:50:10 +01009084 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009085}
9086
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009087MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009088static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9089 const unsigned char *buf,
9090 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009091{
9092#if defined(MBEDTLS_HAVE_TIME)
9093 uint64_t start;
9094#endif
9095#if defined(MBEDTLS_X509_CRT_PARSE_C)
9096#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9097 size_t cert_len;
9098#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9099#endif /* MBEDTLS_X509_CRT_PARSE_C */
9100
9101 const unsigned char *p = buf;
9102 const unsigned char * const end = buf + len;
9103
9104 /*
9105 * Time
9106 */
9107#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009108 if (8 > (size_t) (end - p)) {
9109 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9110 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009111
Gilles Peskine449bd832023-01-11 14:50:10 +01009112 start = ((uint64_t) p[0] << 56) |
9113 ((uint64_t) p[1] << 48) |
9114 ((uint64_t) p[2] << 40) |
9115 ((uint64_t) p[3] << 32) |
9116 ((uint64_t) p[4] << 24) |
9117 ((uint64_t) p[5] << 16) |
9118 ((uint64_t) p[6] << 8) |
9119 ((uint64_t) p[7]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009120 p += 8;
9121
9122 session->start = (time_t) start;
9123#endif /* MBEDTLS_HAVE_TIME */
9124
9125 /*
9126 * Basic mandatory fields
9127 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009128 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9129 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9130 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009131
Gilles Peskine449bd832023-01-11 14:50:10 +01009132 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009133 p += 2;
9134
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009135 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009136 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009137 p += 32;
9138
Gilles Peskine449bd832023-01-11 14:50:10 +01009139 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009140 p += 48;
9141
Gilles Peskine449bd832023-01-11 14:50:10 +01009142 session->verify_result = ((uint32_t) p[0] << 24) |
9143 ((uint32_t) p[1] << 16) |
9144 ((uint32_t) p[2] << 8) |
9145 ((uint32_t) p[3]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009146 p += 4;
9147
9148 /* Immediately clear invalid pointer values that have been read, in case
9149 * we exit early before we replaced them with valid ones. */
9150#if defined(MBEDTLS_X509_CRT_PARSE_C)
9151#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9152 session->peer_cert = NULL;
9153#else
9154 session->peer_cert_digest = NULL;
9155#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9156#endif /* MBEDTLS_X509_CRT_PARSE_C */
9157#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9158 session->ticket = NULL;
9159#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9160
9161 /*
9162 * Peer certificate
9163 */
9164#if defined(MBEDTLS_X509_CRT_PARSE_C)
9165#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9166 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009167 if (3 > (size_t) (end - p)) {
9168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9169 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009170
Gilles Peskine449bd832023-01-11 14:50:10 +01009171 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009172 p += 3;
9173
Gilles Peskine449bd832023-01-11 14:50:10 +01009174 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009175 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9176
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 if (cert_len > (size_t) (end - p)) {
9178 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9179 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009180
Gilles Peskine449bd832023-01-11 14:50:10 +01009181 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009182
Gilles Peskine449bd832023-01-11 14:50:10 +01009183 if (session->peer_cert == NULL) {
9184 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9185 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009186
Gilles Peskine449bd832023-01-11 14:50:10 +01009187 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009188
Gilles Peskine449bd832023-01-11 14:50:10 +01009189 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9190 p, cert_len)) != 0) {
9191 mbedtls_x509_crt_free(session->peer_cert);
9192 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009193 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009194 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009195 }
9196
9197 p += cert_len;
9198 }
9199#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9200 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009201 if (2 > (size_t) (end - p)) {
9202 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9203 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009204
9205 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9206 session->peer_cert_digest_len = (size_t) *p++;
9207
Gilles Peskine449bd832023-01-11 14:50:10 +01009208 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009209 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9211 if (md_info == NULL) {
9212 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9213 }
9214 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9215 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9216 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009217
Gilles Peskine449bd832023-01-11 14:50:10 +01009218 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9219 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9220 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009221
9222 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009223 mbedtls_calloc(1, session->peer_cert_digest_len);
9224 if (session->peer_cert_digest == NULL) {
9225 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9226 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009227
Gilles Peskine449bd832023-01-11 14:50:10 +01009228 memcpy(session->peer_cert_digest, p,
9229 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009230 p += session->peer_cert_digest_len;
9231 }
9232#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9233#endif /* MBEDTLS_X509_CRT_PARSE_C */
9234
9235 /*
9236 * Session ticket and associated data
9237 */
9238#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009239 if (3 > (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_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009244 p += 3;
9245
Gilles Peskine449bd832023-01-11 14:50:10 +01009246 if (session->ticket_len != 0) {
9247 if (session->ticket_len > (size_t) (end - p)) {
9248 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9249 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009250
Gilles Peskine449bd832023-01-11 14:50:10 +01009251 session->ticket = mbedtls_calloc(1, session->ticket_len);
9252 if (session->ticket == NULL) {
9253 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9254 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009255
Gilles Peskine449bd832023-01-11 14:50:10 +01009256 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009257 p += session->ticket_len;
9258 }
9259
Gilles Peskine449bd832023-01-11 14:50:10 +01009260 if (4 > (size_t) (end - p)) {
9261 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9262 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009263
Gilles Peskine449bd832023-01-11 14:50:10 +01009264 session->ticket_lifetime = ((uint32_t) p[0] << 24) |
9265 ((uint32_t) p[1] << 16) |
9266 ((uint32_t) p[2] << 8) |
9267 ((uint32_t) p[3]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009268 p += 4;
9269#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9270
9271 /*
9272 * Misc extension-related info
9273 */
9274#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
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->mfl_code = *p++;
9280#endif
9281
9282#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009283 if (1 > (size_t) (end - p)) {
9284 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9285 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009286
9287 session->encrypt_then_mac = *p++;
9288#endif
9289
9290 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009291 if (p != end) {
9292 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9293 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009294
Gilles Peskine449bd832023-01-11 14:50:10 +01009295 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009296}
Jerry Yudc7bd172022-02-17 13:44:15 +08009297#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9298
XiaokangQian75d40ef2022-04-20 11:05:24 +00009299int mbedtls_ssl_validate_ciphersuite(
9300 const mbedtls_ssl_context *ssl,
9301 const mbedtls_ssl_ciphersuite_t *suite_info,
9302 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009303 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009304{
9305 (void) ssl;
9306
Gilles Peskine449bd832023-01-11 14:50:10 +01009307 if (suite_info == NULL) {
9308 return -1;
9309 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009310
Gilles Peskine449bd832023-01-11 14:50:10 +01009311 if ((suite_info->min_tls_version > max_tls_version) ||
9312 (suite_info->max_tls_version < min_tls_version)) {
9313 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009314 }
9315
XiaokangQian060d8672022-04-21 09:24:56 +00009316#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009317#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009318#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009319 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9320 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009321#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009322 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9323 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009324#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009325 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009326 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009327 }
9328#endif
9329
9330 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9331#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009332 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9333 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9334 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009335 }
9336#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9337#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9338
Gilles Peskine449bd832023-01-11 14:50:10 +01009339 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009340}
9341
Ronald Crone68ab4f2022-10-05 12:46:29 +02009342#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009343/*
9344 * Function for writing a signature algorithm extension.
9345 *
9346 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9347 * value (TLS 1.3 RFC8446):
9348 * enum {
9349 * ....
9350 * ecdsa_secp256r1_sha256( 0x0403 ),
9351 * ecdsa_secp384r1_sha384( 0x0503 ),
9352 * ecdsa_secp521r1_sha512( 0x0603 ),
9353 * ....
9354 * } SignatureScheme;
9355 *
9356 * struct {
9357 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9358 * } SignatureSchemeList;
9359 *
9360 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9361 * value (TLS 1.2 RFC5246):
9362 * enum {
9363 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9364 * sha512(6), (255)
9365 * } HashAlgorithm;
9366 *
9367 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9368 * SignatureAlgorithm;
9369 *
9370 * struct {
9371 * HashAlgorithm hash;
9372 * SignatureAlgorithm signature;
9373 * } SignatureAndHashAlgorithm;
9374 *
9375 * SignatureAndHashAlgorithm
9376 * supported_signature_algorithms<2..2^16-2>;
9377 *
9378 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9379 * generalization of the TLS 1.2 signature algorithm extension.
9380 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9381 * `SignatureScheme` field of TLS 1.3
9382 *
9383 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009384int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9385 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009386{
9387 unsigned char *p = buf;
9388 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9389 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9390
9391 *out_len = 0;
9392
Gilles Peskine449bd832023-01-11 14:50:10 +01009393 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009394
9395 /* Check if we have space for header and length field:
9396 * - extension_type (2 bytes)
9397 * - extension_data_length (2 bytes)
9398 * - supported_signature_algorithms_length (2 bytes)
9399 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009400 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009401 p += 6;
9402
9403 /*
9404 * Write supported_signature_algorithms
9405 */
9406 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009407 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9408 if (sig_alg == NULL) {
9409 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9410 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009411
Gilles Peskine449bd832023-01-11 14:50:10 +01009412 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9413 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9414 *sig_alg,
9415 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9416 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009417 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009418 }
9419 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9420 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009421 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009422 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9423 *sig_alg,
9424 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009425 }
9426
9427 /* Length of supported_signature_algorithms */
9428 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009429 if (supported_sig_alg_len == 0) {
9430 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9431 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009432 }
9433
Gilles Peskine449bd832023-01-11 14:50:10 +01009434 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9435 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9436 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009437
XiaokangQianeaf36512022-04-24 09:07:44 +00009438 *out_len = p - buf;
9439
9440#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009441 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009442#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009443
Gilles Peskine449bd832023-01-11 14:50:10 +01009444 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009445}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009446#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009447
XiaokangQian40a35232022-05-07 09:02:40 +00009448#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009449/*
9450 * mbedtls_ssl_parse_server_name_ext
9451 *
9452 * Structure of server_name extension:
9453 *
9454 * enum {
9455 * host_name(0), (255)
9456 * } NameType;
9457 * opaque HostName<1..2^16-1>;
9458 *
9459 * struct {
9460 * NameType name_type;
9461 * select (name_type) {
9462 * case host_name: HostName;
9463 * } name;
9464 * } ServerName;
9465 * struct {
9466 * ServerName server_name_list<1..2^16-1>
9467 * } ServerNameList;
9468 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009469MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009470int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9471 const unsigned char *buf,
9472 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009473{
9474 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9475 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009476 size_t server_name_list_len, hostname_len;
9477 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009478
Gilles Peskine449bd832023-01-11 14:50:10 +01009479 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009480
Gilles Peskine449bd832023-01-11 14:50:10 +01009481 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9482 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009483 p += 2;
9484
Gilles Peskine449bd832023-01-11 14:50:10 +01009485 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009486 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009487 while (p < server_name_list_end) {
9488 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9489 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9490 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9491 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009492
Gilles Peskine449bd832023-01-11 14:50:10 +01009493 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009494 /* sni_name is intended to be used only during the parsing of the
9495 * ClientHello message (it is reset to NULL before the end of
9496 * the message parsing). Thus it is ok to just point to the
9497 * reception buffer and not make a copy of it.
9498 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009499 ssl->handshake->sni_name = p + 3;
9500 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009501 if (ssl->conf->f_sni == NULL) {
9502 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009503 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009504 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9505 ssl, p + 3, hostname_len);
9506 if (ret != 0) {
9507 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9508 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9509 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9510 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9511 }
9512 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009513 }
9514
9515 p += hostname_len + 3;
9516 }
9517
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009519}
9520#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9521
XiaokangQianacb39922022-06-17 10:18:48 +00009522#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009523MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009524int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9525 const unsigned char *buf,
9526 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009527{
9528 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009529 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009530 const unsigned char *protocol_name_list;
9531 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009532 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009533
9534 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009535 if (ssl->conf->alpn_list == NULL) {
9536 return 0;
9537 }
XiaokangQianacb39922022-06-17 10:18:48 +00009538
9539 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009540 * RFC7301, section 3.1
9541 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009542 *
XiaokangQianc7403452022-06-23 03:24:12 +00009543 * struct {
9544 * ProtocolName protocol_name_list<2..2^16-1>
9545 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009546 */
9547
XiaokangQianc7403452022-06-23 03:24:12 +00009548 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009549 * protocol_name_list_len 2 bytes
9550 * protocol_name_len 1 bytes
9551 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009552 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009553 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009554
Gilles Peskine449bd832023-01-11 14:50:10 +01009555 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009556 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009557 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009558 protocol_name_list = p;
9559 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009560
9561 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009562 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009563 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009564 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9565 protocol_name_len);
9566 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009567 MBEDTLS_SSL_PEND_FATAL_ALERT(
9568 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9570 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009571 }
9572
9573 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009574 }
9575
9576 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009577 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9578 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009579 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009580 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009581 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009582 if (protocol_name_len == alpn_len &&
9583 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009584 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009585 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009586 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009587
9588 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009589 }
9590 }
9591
XiaokangQian95d5f542022-06-24 02:29:26 +00009592 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009593 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009594 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9595 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9596 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009597}
9598
Gilles Peskine449bd832023-01-11 14:50:10 +01009599int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9600 unsigned char *buf,
9601 unsigned char *end,
9602 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009603{
9604 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009605 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009606 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009607
Gilles Peskine449bd832023-01-11 14:50:10 +01009608 if (ssl->alpn_chosen == NULL) {
9609 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009610 }
9611
Gilles Peskine449bd832023-01-11 14:50:10 +01009612 protocol_name_len = strlen(ssl->alpn_chosen);
9613 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009614
Gilles Peskine449bd832023-01-11 14:50:10 +01009615 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009616 /*
9617 * 0 . 1 ext identifier
9618 * 2 . 3 ext length
9619 * 4 . 5 protocol list length
9620 * 6 . 6 protocol name length
9621 * 7 . 7+n protocol name
9622 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009623 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009624
XiaokangQian95d5f542022-06-24 02:29:26 +00009625 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009626
Gilles Peskine449bd832023-01-11 14:50:10 +01009627 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9628 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009629 /* Note: the length of the chosen protocol has been checked to be less
9630 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9631 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009632 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009633
Gilles Peskine449bd832023-01-11 14:50:10 +01009634 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009635
9636#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009637 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009638#endif
9639
Gilles Peskine449bd832023-01-11 14:50:10 +01009640 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009641}
9642#endif /* MBEDTLS_SSL_ALPN */
9643
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009644#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009645 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009646 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009647 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009648int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9649 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009650{
9651 /* Initialize to suppress unnecessary compiler warning */
9652 size_t hostname_len = 0;
9653
9654 /* Check if new hostname is valid before
9655 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009656 if (hostname != NULL) {
9657 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009658
Gilles Peskine449bd832023-01-11 14:50:10 +01009659 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9660 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9661 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009662 }
9663
9664 /* Now it's clear that we will overwrite the old hostname,
9665 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009666 if (session->hostname != NULL) {
9667 mbedtls_platform_zeroize(session->hostname,
9668 strlen(session->hostname));
9669 mbedtls_free(session->hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009670 }
9671
9672 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009673 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009674 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009675 } else {
9676 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9677 if (session->hostname == NULL) {
9678 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9679 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009680
Gilles Peskine449bd832023-01-11 14:50:10 +01009681 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009682 }
9683
Gilles Peskine449bd832023-01-11 14:50:10 +01009684 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009685}
Xiaokang Qian03409292022-10-12 02:49:52 +00009686#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9687 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009688 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009689 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009691#endif /* MBEDTLS_SSL_TLS_C */