blob: 0ff0e6435dbb148e9ef59e60c4f59536004571f3 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
SimonBd5800b72016-04-26 07:43:27 +010028#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010029
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000030#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010031#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010032#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000033#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040034
Janos Follath73c616b2019-12-18 15:07:04 +000035#include "mbedtls/debug.h"
36#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050037#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010038#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020039#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020040
Rich Evans00ab4702015-02-06 13:43:58 +000041#include <string.h>
42
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050043#if defined(MBEDTLS_USE_PSA_CRYPTO)
44#include "mbedtls/psa_util.h"
45#include "psa/crypto.h"
46#endif
Manuel Pégourié-Gonnard07018f92022-09-15 11:29:35 +020047#include "mbedtls/legacy_or_psa.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050048
Janos Follath23bdca02016-10-07 14:47:14 +010049#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000050#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020051#endif
52
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050053#if defined(MBEDTLS_USE_PSA_CRYPTO)
54#define PSA_TO_MBEDTLS_ERR(status) PSA_TO_MBEDTLS_ERR_LIST(status, \
55 psa_to_ssl_errors, \
56 psa_generic_status_to_mbedtls)
Andrzej Kurekdaf5b562023-03-03 05:52:28 -050057#define PSA_TO_MD_ERR(status) PSA_TO_MBEDTLS_ERR_LIST(status, \
58 psa_to_md_errors, \
59 psa_generic_status_to_mbedtls)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050060#endif
61
Ronald Cronad8c17b2022-06-10 17:18:09 +020062#if defined(MBEDTLS_TEST_HOOKS)
63static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
64
65void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010066 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020067{
68 chk_buf_ptr_fail_args.cur = cur;
69 chk_buf_ptr_fail_args.end = end;
70 chk_buf_ptr_fail_args.need = need;
71}
72
Gilles Peskine449bd832023-01-11 14:50:10 +010073void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020074{
Gilles Peskine449bd832023-01-11 14:50:10 +010075 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020076}
77
Gilles Peskine449bd832023-01-11 14:50:10 +010078int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020079{
Gilles Peskine449bd832023-01-11 14:50:10 +010080 return (chk_buf_ptr_fail_args.cur != args->cur) ||
81 (chk_buf_ptr_fail_args.end != args->end) ||
82 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020083}
84#endif /* MBEDTLS_TEST_HOOKS */
85
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020086#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010087
Hanno Beckera0e20d02019-05-15 14:03:01 +010088#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010089/* Top-level Connection ID API */
90
Gilles Peskine449bd832023-01-11 14:50:10 +010091int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
92 size_t len,
93 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010094{
Gilles Peskine449bd832023-01-11 14:50:10 +010095 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
96 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
97 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010098
Gilles Peskine449bd832023-01-11 14:50:10 +010099 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
100 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +0100102 }
103
104 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100105 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100107}
108
Gilles Peskine449bd832023-01-11 14:50:10 +0100109int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
110 int enable,
111 unsigned char const *own_cid,
112 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100113{
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
115 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
116 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100117
Hanno Beckerca092242019-04-25 16:01:49 +0100118 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100119 if (enable == MBEDTLS_SSL_CID_DISABLED) {
120 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
121 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100122 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100123 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
124 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 if (own_cid_len != ssl->conf->cid_len) {
127 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
128 (unsigned) own_cid_len,
129 (unsigned) ssl->conf->cid_len));
130 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100131 }
132
Gilles Peskine449bd832023-01-11 14:50:10 +0100133 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100134 /* Truncation is not an issue here because
135 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
136 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100137
Gilles Peskine449bd832023-01-11 14:50:10 +0100138 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100139}
140
Gilles Peskine449bd832023-01-11 14:50:10 +0100141int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
142 int *enabled,
143 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
144 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000145{
146 *enabled = MBEDTLS_SSL_CID_DISABLED;
147
Gilles Peskine449bd832023-01-11 14:50:10 +0100148 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
149 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
150 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000151
152 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
153 * zero as this is indistinguishable from not requesting to use
154 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100155 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
156 return 0;
157 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000160 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100161 if (own_cid != NULL) {
162 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
163 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000164 }
165
166 *enabled = MBEDTLS_SSL_CID_ENABLED;
167
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000169}
170
Gilles Peskine449bd832023-01-11 14:50:10 +0100171int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
172 int *enabled,
173 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
174 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100175{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100176 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177
Gilles Peskine449bd832023-01-11 14:50:10 +0100178 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
179 mbedtls_ssl_is_handshake_over(ssl) == 0) {
180 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100181 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100182
Hanno Beckerc5f24222019-05-03 12:54:52 +0100183 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
184 * were used, but client and server requested the empty CID.
185 * This is indistinguishable from not using the CID extension
186 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100187 if (ssl->transform_in->in_cid_len == 0 &&
188 ssl->transform_in->out_cid_len == 0) {
189 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100190 }
191
Gilles Peskine449bd832023-01-11 14:50:10 +0100192 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100193 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 if (peer_cid != NULL) {
195 memcpy(peer_cid, ssl->transform_in->out_cid,
196 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100197 }
198 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100199
200 *enabled = MBEDTLS_SSL_CID_ENABLED;
201
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100203}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100204#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200209/*
210 * Convert max_fragment_length codes to length.
211 * RFC 6066 says:
212 * enum{
213 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
214 * } MaxFragmentLength;
215 * and we add 0 -> extension unused
216 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100217static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200218{
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 switch (mfl) {
220 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
221 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
222 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
223 return 512;
224 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
225 return 1024;
226 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
227 return 2048;
228 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
229 return 4096;
230 default:
231 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000232 }
233}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200235
Gilles Peskine449bd832023-01-11 14:50:10 +0100236int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
237 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200238{
Gilles Peskine449bd832023-01-11 14:50:10 +0100239 mbedtls_ssl_session_free(dst);
240 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800241#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
242 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000243#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
244 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000245 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800246#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000247#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800248
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000250
251#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000253 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200254
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
256 if (dst->peer_cert == NULL) {
257 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
258 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259
Gilles Peskine449bd832023-01-11 14:50:10 +0100260 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200261
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
263 src->peer_cert->raw.len)) != 0) {
264 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200265 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100266 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200267 }
268 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000269#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100270 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100272 mbedtls_calloc(1, src->peer_cert_digest_len);
273 if (dst->peer_cert_digest == NULL) {
274 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
275 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000276
Gilles Peskine449bd832023-01-11 14:50:10 +0100277 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
278 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000279 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000280 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000281 }
282#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200285
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200286#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 if (src->ticket != NULL) {
288 dst->ticket = mbedtls_calloc(1, src->ticket_len);
289 if (dst->ticket == NULL) {
290 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
291 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200292
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200294 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000295
296#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
297 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000299 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
301 if (ret != 0) {
302 return ret;
303 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000304 }
305#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
306 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200307#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200308
Gilles Peskine449bd832023-01-11 14:50:10 +0100309 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200310}
311
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500312#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200313MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100314static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500315{
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
317 if (resized_buffer == NULL) {
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500318 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500320
321 /* We want to copy len_new bytes when downsizing the buffer, and
322 * len_old bytes when upsizing, so we choose the smaller of two sizes,
323 * to fit one buffer into another. Size checks, ensuring that no data is
324 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 memcpy(resized_buffer, *buffer,
326 (len_new < *len_old) ? len_new : *len_old);
327 mbedtls_platform_zeroize(*buffer, *len_old);
328 mbedtls_free(*buffer);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500329
330 *buffer = resized_buffer;
331 *len_old = len_new;
332
333 return 0;
334}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200335
Gilles Peskine449bd832023-01-11 14:50:10 +0100336static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
337 size_t in_buf_new_len,
338 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200339{
340 int modified = 0;
341 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
342 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200344 written_in = ssl->in_msg - ssl->in_buf;
345 iv_offset_in = ssl->in_iv - ssl->in_buf;
346 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200348 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 ssl->in_buf_len < in_buf_new_len) {
350 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
351 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
352 } else {
353 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
354 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200355 modified = 1;
356 }
357 }
358 }
359
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200361 written_out = ssl->out_msg - ssl->out_buf;
362 iv_offset_out = ssl->out_iv - ssl->out_buf;
363 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100364 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200365 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 ssl->out_buf_len < out_buf_new_len) {
367 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
368 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
369 } else {
370 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
371 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200372 modified = 1;
373 }
374 }
375 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100376 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200377 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200379 /* Fields below might not be properly updated with record
380 * splitting or with CID, so they are manually updated here. */
381 ssl->out_msg = ssl->out_buf + written_out;
382 ssl->out_len = ssl->out_buf + len_offset_out;
383 ssl->out_iv = ssl->out_buf + iv_offset_out;
384
385 ssl->in_msg = ssl->in_buf + written_in;
386 ssl->in_len = ssl->in_buf + len_offset_in;
387 ssl->in_iv = ssl->in_buf + iv_offset_in;
388 }
389}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500390#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
391
Jerry Yudb8c48a2022-01-27 14:54:54 +0800392#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800393
394#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100395typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
396 const char *label,
397 const unsigned char *random, size_t rlen,
398 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800399
Gilles Peskine449bd832023-01-11 14:50:10 +0100400static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800401
402#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
403
404/* Type for the TLS PRF */
405typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
406 const unsigned char *, size_t,
407 unsigned char *, size_t);
408
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200409MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100410static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
411 int ciphersuite,
412 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200413#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100414 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200415#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 ssl_tls_prf_t tls_prf,
417 const unsigned char randbytes[64],
418 mbedtls_ssl_protocol_version tls_version,
419 unsigned endpoint,
420 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800421
Andrzej Kurek25f27152022-08-17 16:09:31 -0400422#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200423MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100424static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300425 const char *label,
426 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100428static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
429static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100430
431#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
432
433#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
434MBEDTLS_CHECK_RETURN_CRITICAL
435static int tls_prf_sha384(const unsigned char *secret, size_t slen,
436 const char *label,
437 const unsigned char *random, size_t rlen,
438 unsigned char *dstbuf, size_t dlen);
439
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100440static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
441static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100442#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
443
444static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
445 unsigned char *buf,
446 size_t buf_len);
447
448MBEDTLS_CHECK_RETURN_CRITICAL
449static int ssl_tls12_session_load(mbedtls_ssl_session *session,
450 const unsigned char *buf,
451 size_t len);
452#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
453
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100454static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100455
456#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100457static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100458#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
459
460#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100461static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100462#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
463
464int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
465 const unsigned char *secret, size_t slen,
466 const char *label,
467 const unsigned char *random, size_t rlen,
468 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300469{
470 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
471
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300473#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek25f27152022-08-17 16:09:31 -0400474#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300475 case MBEDTLS_SSL_TLS_PRF_SHA384:
476 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 break;
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400478#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -0400479#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300480 case MBEDTLS_SSL_TLS_PRF_SHA256:
481 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100482 break;
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400483#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300484#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 default:
486 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300487 }
488
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300490}
491
Jerry Yuc73c6182022-02-08 20:29:25 +0800492#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100493static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800494{
495#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100496 if (session->peer_cert != NULL) {
497 mbedtls_x509_crt_free(session->peer_cert);
498 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800499 session->peer_cert = NULL;
500 }
501#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800503 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800505 session->peer_cert_digest = NULL;
506 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
507 session->peer_cert_digest_len = 0;
508 }
509#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
510}
511#endif /* MBEDTLS_X509_CRT_PARSE_C */
512
Gilles Peskine449bd832023-01-11 14:50:10 +0100513uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800514{
Gilles Peskine449bd832023-01-11 14:50:10 +0100515 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800516 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800518
519 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800521
522 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100523 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800524
525 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100526 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800527
528 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100529 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800530
531 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800533
534 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800536
537 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800539
540 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800542
543 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800545
546 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800548
549 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800551
552 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800554
555 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800557
558 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800560
561 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800563
564 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800566
567 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800569
570 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800572
573 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800575
576 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800578
579 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800581
582 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800584
585 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800587
588 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800590
591 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800593
594 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100595 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800596
597 }
598
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800600}
601
Gilles Peskine449bd832023-01-11 14:50:10 +0100602uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800603{
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800605}
606
Jerry Yud25cab02022-10-31 12:48:30 +0800607#if defined(MBEDTLS_DEBUG_C)
608static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800609 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800610 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
611 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
612 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
613 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
614 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
615 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
616 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
617 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
618 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
619 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
620 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
621 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
622 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
623 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
624 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
625 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
626 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
627 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
628 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
629 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
630 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
631 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
632 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
633 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
634 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
635 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
636 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket"
637};
638
Gilles Peskine449bd832023-01-11 14:50:10 +0100639static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800640 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
641 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
642 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
643 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
644 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
645 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
646 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
647 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
648 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
649 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
650 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
651 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
652 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
653 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
654 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
655 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
656 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
657 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
658 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
659 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
660 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
661 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
662 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
663 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
664 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
665 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
666 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
667 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET
668};
669
Gilles Peskine449bd832023-01-11 14:50:10 +0100670const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800671{
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 return extension_name_table[
673 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800674}
675
Gilles Peskine449bd832023-01-11 14:50:10 +0100676static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800677{
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800679 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800681 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800683 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800685 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800687 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800689 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800691 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800693 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800695}
696
Gilles Peskine449bd832023-01-11 14:50:10 +0100697void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
698 int level, const char *file, int line,
699 int hs_msg_type, unsigned int extension_type,
700 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800701{
702 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800704 mbedtls_debug_print_msg(
705 ssl, level, file, line,
706 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 ssl_tls13_get_hs_msg_name(hs_msg_type),
708 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800709 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800711 return;
712 }
713
714 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100715 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800716 mbedtls_debug_print_msg(
717 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
719 mbedtls_ssl_get_extension_name(extension_type), extension_type,
720 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800721 return;
722 }
723
724 mbedtls_debug_print_msg(
725 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100726 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
727 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800728}
729
Gilles Peskine449bd832023-01-11 14:50:10 +0100730void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
731 int level, const char *file, int line,
732 int hs_msg_type, uint32_t extensions_mask,
733 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800734{
735
Gilles Peskine449bd832023-01-11 14:50:10 +0100736 for (unsigned i = 0;
737 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
738 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800739 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800740 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800742 }
743}
744
Pengyu Lvee455c02023-01-12 14:37:24 +0800745#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
746#define ARRAY_LENGTH(a) (sizeof(a) / sizeof(*(a)))
747
748static const char *ticket_flag_name_table[] =
749{
750 [0] = "ALLOW_PSK_RESUMPTION",
751 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
752 [3] = "ALLOW_EARLY_DATA",
753};
754
Pengyu Lv4938a562023-01-16 11:28:49 +0800755void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
756 int level, const char *file, int line,
757 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800758{
759 size_t i;
760
761 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800762 "print ticket_flags (0x%02x)", flags);
763
764 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800765
766 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800768 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
769 ticket_flag_name_table[i]);
770 }
771 }
772}
773#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
774
Jerry Yud25cab02022-10-31 12:48:30 +0800775#endif /* MBEDTLS_DEBUG_C */
776
Gilles Peskine449bd832023-01-11 14:50:10 +0100777void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
778 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800779{
780 ((void) ciphersuite_info);
781
Andrzej Kurek25f27152022-08-17 16:09:31 -0400782#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800784 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800786#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400787#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800789 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
792 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 return;
795 }
796}
797
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100798int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100799 unsigned hs_type,
800 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100801{
802 unsigned char hs_hdr[4];
803
804 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100805 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
806 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
807 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
808 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100809
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100810 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100811}
812
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100813int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100814 unsigned hs_type,
815 unsigned char const *msg,
816 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100817{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818 int ret;
819 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100820 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100821 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100822 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100824}
825
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100826int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800827{
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100828#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) || \
829 defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100830#if defined(MBEDTLS_USE_PSA_CRYPTO)
831 psa_status_t status;
832#else
833 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
834#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100835#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800836 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100837#endif /* SHA-256 or SHA-384 */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400838#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800839#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100840 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
841 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500842 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100843 }
844 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
845 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500846 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100847 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800848#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100849 mbedtls_md_free(&ssl->handshake->fin_sha256);
850 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100851 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
852 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
853 0);
854 if (ret != 0) {
855 return ret;
856 }
857 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 if (ret != 0) {
859 return ret;
860 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800861#endif
862#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400863#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800864#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100865 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
866 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500867 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100868 }
869 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
870 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500871 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100872 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800873#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100874 mbedtls_md_free(&ssl->handshake->fin_sha384);
875 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100876 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
877 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
878 if (ret != 0) {
879 return ret;
880 }
881 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100882 if (ret != 0) {
883 return ret;
884 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800885#endif
886#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100887 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800888}
889
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100890static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100891 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800892{
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100893#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) || \
894 defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100895#if defined(MBEDTLS_USE_PSA_CRYPTO)
896 psa_status_t status;
897#else
898 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
899#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100900#else /* SHA-256 or SHA-384 */
901 ((void) ssl);
902 (void) buf;
903 (void) len;
904#endif /* SHA-256 or SHA-384 */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400905#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800906#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100907 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
908 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500909 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100910 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800911#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100912 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 if (ret != 0) {
914 return ret;
915 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800916#endif
917#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400918#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800919#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100920 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
921 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500922 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100923 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800924#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100925 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100926 if (ret != 0) {
927 return ret;
928 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800929#endif
930#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100931 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800932}
933
Andrzej Kurek25f27152022-08-17 16:09:31 -0400934#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100935static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100936 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800937{
938#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500939 return PSA_TO_MD_ERR(psa_hash_update(
940 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800941#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100942 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800943#endif
944}
945#endif
946
Andrzej Kurek25f27152022-08-17 16:09:31 -0400947#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100948static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100949 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800950{
951#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500952 return PSA_TO_MD_ERR(psa_hash_update(
953 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800954#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100955 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800956#endif
957}
958#endif
959
Gilles Peskine449bd832023-01-11 14:50:10 +0100960static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200961{
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200963
Andrzej Kurek25f27152022-08-17 16:09:31 -0400964#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500965#if defined(MBEDTLS_USE_PSA_CRYPTO)
966 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100968 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200969#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400971#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500972#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500973 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500974#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100975 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200976#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500977#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200978
979 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100980
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100982 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200983#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200984#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200986#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200987#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200988#if defined(MBEDTLS_USE_PSA_CRYPTO)
989 handshake->psa_pake_ctx = psa_pake_operation_init();
990 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
991#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200993#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200994#if defined(MBEDTLS_SSL_CLI_C)
995 handshake->ecjpake_cache = NULL;
996 handshake->ecjpake_cache_len = 0;
997#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200998#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200999
Gilles Peskineeccd8882020-03-10 12:19:08 +01001000#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001002#endif
1003
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001004#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1005 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1006#endif
Hanno Becker75173122019-02-06 16:18:31 +00001007
1008#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1009 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001011#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001012}
1013
Gilles Peskine449bd832023-01-11 14:50:10 +01001014void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001015{
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001017
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001018#if defined(MBEDTLS_USE_PSA_CRYPTO)
1019 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1020 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001021#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1023 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001024#endif
1025
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001026#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001027#if defined(MBEDTLS_USE_PSA_CRYPTO)
1028 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1029 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001030#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001031 mbedtls_md_init(&transform->md_ctx_enc);
1032 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001033#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001034#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001035}
1036
Gilles Peskine449bd832023-01-11 14:50:10 +01001037void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001038{
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001040}
1041
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001042MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001043static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001044{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001045 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1046
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001047 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001048#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 if (ssl->transform_negotiate) {
1050 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1051 }
Jerry Yu2e199812022-12-01 18:57:19 +08001052#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 if (ssl->session_negotiate) {
1054 mbedtls_ssl_session_free(ssl->session_negotiate);
1055 }
1056 if (ssl->handshake) {
1057 mbedtls_ssl_handshake_free(ssl);
1058 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001059
Jerry Yu2e199812022-12-01 18:57:19 +08001060#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001061 /*
1062 * Either the pointers are now NULL or cleared properly and can be freed.
1063 * Now allocate missing structures.
1064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 if (ssl->transform_negotiate == NULL) {
1066 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001067 }
Jerry Yu2e199812022-12-01 18:57:19 +08001068#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001069
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 if (ssl->session_negotiate == NULL) {
1071 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001072 }
Paul Bakker48916f92012-09-16 19:57:18 +00001073
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 if (ssl->handshake == NULL) {
1075 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001076 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001077#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1078 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001079
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1081 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001082#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001083
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001084 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001086#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001087 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001088#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 ssl->session_negotiate == NULL) {
1090 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001091
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001093 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001094
1095#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001097 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001098#endif
1099
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001101 ssl->session_negotiate = NULL;
1102
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001104 }
1105
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001106 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 mbedtls_ssl_session_init(ssl->session_negotiate);
1108 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001109
Jerry Yu2e199812022-12-01 18:57:19 +08001110#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001112#endif
1113
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001114 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001115 ret = mbedtls_ssl_reset_checksum(ssl);
1116 if (ret != 0) {
1117 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1118 return ret;
1119 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001120
Jerry Yud0766ec2022-09-22 10:46:57 +08001121#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1122 defined(MBEDTLS_SSL_SRV_C) && \
1123 defined(MBEDTLS_SSL_SESSION_TICKETS)
1124 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001126#endif
1127
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001130 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001133 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001135 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001137
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001139 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001140#endif
1141
Brett Warrene0edc842021-08-17 09:53:13 +01001142/*
1143 * curve_list is translated to IANA TLS group identifiers here because
1144 * mbedtls_ssl_conf_curves returns void and so can't return
1145 * any error codes.
1146 */
1147#if defined(MBEDTLS_ECP_C)
1148#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1149 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001151 size_t length;
1152 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1153
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE) &&
1155 (length < MBEDTLS_ECP_DP_MAX); length++) {
1156 }
Brett Warrene0edc842021-08-17 09:53:13 +01001157
1158 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1160 if (group_list == NULL) {
1161 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1162 }
Brett Warrene0edc842021-08-17 09:53:13 +01001163
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001165 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 curve_list[i]);
1167 if (tls_id == 0) {
1168 mbedtls_free(group_list);
1169 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001170 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001171 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001172 }
1173
1174 group_list[length] = 0;
1175
1176 ssl->handshake->group_list = group_list;
1177 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001179 ssl->handshake->group_list = ssl->conf->group_list;
1180 ssl->handshake->group_list_heap_allocated = 0;
1181 }
1182#endif /* MBEDTLS_DEPRECATED_REMOVED */
1183#endif /* MBEDTLS_ECP_C */
1184
Ronald Crone68ab4f2022-10-05 12:46:29 +02001185#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001186#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001187#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001188 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1189 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1191 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001192 const int *md;
1193 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001194 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001195 uint16_t *p;
1196
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001197 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1198 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1199 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001200
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1202 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001203 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 }
Valerio Setti75fba322023-02-23 17:35:09 +01001205#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001207#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001208
Jerry Yub476a442022-01-21 18:14:45 +08001209#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001211#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001212 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1213 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1214 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001215 }
1216
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1218 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1219 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1222 sizeof(uint16_t));
1223 if (ssl->handshake->sig_algs == NULL) {
1224 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1225 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001226
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 p = (uint16_t *) ssl->handshake->sig_algs;
1228 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1229 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1230 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001231 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 }
Valerio Setti75fba322023-02-23 17:35:09 +01001233#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001234 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001235 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001236#endif
1237#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001240#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001241 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001242 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001243 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001245#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001247 ssl->handshake->sig_algs_heap_allocated = 0;
1248 }
Jerry Yucc539102022-06-27 16:27:35 +08001249#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001250#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001251 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001252}
1253
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001254#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001255/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001256MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001257static int ssl_cookie_write_dummy(void *ctx,
1258 unsigned char **p, unsigned char *end,
1259 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001260{
1261 ((void) ctx);
1262 ((void) p);
1263 ((void) end);
1264 ((void) cli_id);
1265 ((void) cli_id_len);
1266
Gilles Peskine449bd832023-01-11 14:50:10 +01001267 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001268}
1269
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001270MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001271static int ssl_cookie_check_dummy(void *ctx,
1272 const unsigned char *cookie, size_t cookie_len,
1273 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001274{
1275 ((void) ctx);
1276 ((void) cookie);
1277 ((void) cookie_len);
1278 ((void) cli_id);
1279 ((void) cli_id_len);
1280
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001282}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001283#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001284
Paul Bakker5121ce52009-01-03 21:22:43 +00001285/*
1286 * Initialize an SSL context
1287 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001288void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001289{
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001291}
1292
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001293MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001294static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001295{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001296 const mbedtls_ssl_config *conf = ssl->conf;
1297
Ronald Cron6f135e12021-12-08 16:57:54 +01001298#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1300 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1301 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1302 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001303 }
1304
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1306 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001307 }
1308#endif
1309
1310#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1312 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1313 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001314 }
1315#endif
1316
Ronald Cron6f135e12021-12-08 16:57:54 +01001317#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1319 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1320 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1321 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001322 }
1323
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 if (conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
1325 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS 1.3 server is not supported yet."));
1326 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian8f9dfe42022-04-15 02:52:39 +00001327 }
1328
1329
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1331 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001332 }
1333#endif
1334
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1336 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001337}
1338
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001339MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001340static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1341{
1342 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 ret = ssl_conf_version_check(ssl);
1344 if (ret != 0) {
1345 return ret;
1346 }
Jerry Yu60835a82021-08-04 10:13:52 +08001347
Jerry Yudef7ae42022-10-30 14:13:19 +08001348#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1349 /* RFC 8446 section 4.4.3
1350 *
1351 * If the verification fails, the receiver MUST terminate the handshake with
1352 * a "decrypt_error" alert.
1353 *
1354 * If the client is configured as TLS 1.3 only with optional verify, return
1355 * bad config.
1356 *
1357 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001358 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1359 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001360 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1361 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1362 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001364 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 1, ("Optional verify auth mode "
1366 "is not available for TLS 1.3 client"));
1367 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001368 }
1369#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1370
Jerry Yu60835a82021-08-04 10:13:52 +08001371 /* Space for further checks */
1372
Gilles Peskine449bd832023-01-11 14:50:10 +01001373 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001374}
1375
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001376/*
1377 * Setup an SSL context
1378 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1381 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001382{
Janos Follath865b3eb2019-12-16 11:46:15 +00001383 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001384 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1385 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001386
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001387 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001388
Gilles Peskine449bd832023-01-11 14:50:10 +01001389 if ((ret = ssl_conf_check(ssl)) != 0) {
1390 return ret;
1391 }
Jerry Yu60835a82021-08-04 10:13:52 +08001392
Paul Bakker62f2dee2012-09-28 07:31:51 +00001393 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001394 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001395 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001396
1397 /* Set to NULL in case of an error condition */
1398 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001399
Darryl Greenb33cc762019-11-28 14:29:44 +00001400#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1401 ssl->in_buf_len = in_buf_len;
1402#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1404 if (ssl->in_buf == NULL) {
1405 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001406 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001407 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001408 }
1409
Darryl Greenb33cc762019-11-28 14:29:44 +00001410#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1411 ssl->out_buf_len = out_buf_len;
1412#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1414 if (ssl->out_buf == NULL) {
1415 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001416 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001417 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001418 }
1419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001421
Johan Pascalb62bb512015-12-03 21:56:45 +01001422#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001424#endif
1425
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001427 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001431
1432error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 mbedtls_free(ssl->in_buf);
1434 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001435
1436 ssl->conf = NULL;
1437
Darryl Greenb33cc762019-11-28 14:29:44 +00001438#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1439 ssl->in_buf_len = 0;
1440 ssl->out_buf_len = 0;
1441#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001442 ssl->in_buf = NULL;
1443 ssl->out_buf = NULL;
1444
1445 ssl->in_hdr = NULL;
1446 ssl->in_ctr = NULL;
1447 ssl->in_len = NULL;
1448 ssl->in_iv = NULL;
1449 ssl->in_msg = NULL;
1450
1451 ssl->out_hdr = NULL;
1452 ssl->out_ctr = NULL;
1453 ssl->out_len = NULL;
1454 ssl->out_iv = NULL;
1455 ssl->out_msg = NULL;
1456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001458}
1459
1460/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001461 * Reset an initialized and used SSL context for re-use while retaining
1462 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001463 *
1464 * If partial is non-zero, keep data in the input buffer and client ID.
1465 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001466 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001467void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1468 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001469{
Darryl Greenb33cc762019-11-28 14:29:44 +00001470#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1471 size_t in_buf_len = ssl->in_buf_len;
1472 size_t out_buf_len = ssl->out_buf_len;
1473#else
1474 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1475 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1476#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001477
Hanno Beckerb0302c42021-08-03 09:39:42 +01001478#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1479 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001480#endif
1481
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001482 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001484
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001486
1487 /* Reset incoming message parsing */
1488 ssl->in_offt = NULL;
1489 ssl->nb_zero = 0;
1490 ssl->in_msgtype = 0;
1491 ssl->in_msglen = 0;
1492 ssl->in_hslen = 0;
1493 ssl->keep_current_message = 0;
1494 ssl->transform_in = NULL;
1495
1496#if defined(MBEDTLS_SSL_PROTO_DTLS)
1497 ssl->next_record_offset = 0;
1498 ssl->in_epoch = 0;
1499#endif
1500
1501 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001505 }
1506
Ronald Cronad8c17b2022-06-10 17:18:09 +02001507 ssl->send_alert = 0;
1508
Hanno Beckerb0302c42021-08-03 09:39:42 +01001509 /* Reset outgoing message writing */
1510 ssl->out_msgtype = 0;
1511 ssl->out_msglen = 0;
1512 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 memset(ssl->out_buf, 0, out_buf_len);
1514 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001515 ssl->transform_out = NULL;
1516
1517#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001519#endif
1520
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 if (ssl->transform) {
1523 mbedtls_ssl_transform_free(ssl->transform);
1524 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001525 ssl->transform = NULL;
1526 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001527#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1528
XiaokangQian2b01dc32022-01-21 02:53:13 +00001529#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 mbedtls_ssl_transform_free(ssl->transform_application);
1531 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532 ssl->transform_application = NULL;
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001535#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1537 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001538 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001539#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1542 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001543 ssl->handshake->transform_handshake = NULL;
1544 }
1545
XiaokangQian2b01dc32022-01-21 02:53:13 +00001546#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001547}
1548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001550{
1551 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1552
1553 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1554
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001556
1557 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558#if defined(MBEDTLS_SSL_RENEGOTIATION)
1559 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001560 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001561
1562 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1564 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001565#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001567
Hanno Beckerb0302c42021-08-03 09:39:42 +01001568 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001569 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 if (ssl->session) {
1571 mbedtls_ssl_session_free(ssl->session);
1572 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001573 ssl->session = NULL;
1574 }
1575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001577 ssl->alpn_chosen = NULL;
1578#endif
1579
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001580#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001581 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001582#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001584#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 if (free_cli_id) {
1586 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001587 ssl->cli_id = NULL;
1588 ssl->cli_id_len = 0;
1589 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001590#endif
1591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 if ((ret = ssl_handshake_init(ssl)) != 0) {
1593 return ret;
1594 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001597}
1598
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001599/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001600 * Reset an initialized and used SSL context for re-use while retaining
1601 * all application-set variables, function pointers and data.
1602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001603int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001604{
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001606}
1607
1608/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001609 * SSL set accessors
1610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001611void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001612{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001613 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001614}
1615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001619}
1620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001622void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001623{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001624 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001625}
1626#endif
1627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001629{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001630 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001631}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001633#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001634
Gilles Peskine449bd832023-01-11 14:50:10 +01001635void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1636 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001637{
1638 ssl->disable_datagram_packing = !allow_packing;
1639}
1640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1642 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001643{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001644 conf->hs_timeout_min = min;
1645 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001646}
1647#endif
1648
Gilles Peskine449bd832023-01-11 14:50:10 +01001649void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001650{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001651 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001652}
1653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001655void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1656 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1657 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001658{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001659 conf->f_vrfy = f_vrfy;
1660 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001661}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001663
Gilles Peskine449bd832023-01-11 14:50:10 +01001664void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1665 int (*f_rng)(void *, unsigned char *, size_t),
1666 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001667{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001668 conf->f_rng = f_rng;
1669 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001670}
1671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1673 void (*f_dbg)(void *, int, const char *, int, const char *),
1674 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001675{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001676 conf->f_dbg = f_dbg;
1677 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001678}
1679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1681 void *p_bio,
1682 mbedtls_ssl_send_t *f_send,
1683 mbedtls_ssl_recv_t *f_recv,
1684 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001685{
1686 ssl->p_bio = p_bio;
1687 ssl->f_send = f_send;
1688 ssl->f_recv = f_recv;
1689 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001690}
1691
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001692#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001693void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001694{
1695 ssl->mtu = mtu;
1696}
1697#endif
1698
Gilles Peskine449bd832023-01-11 14:50:10 +01001699void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001700{
1701 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001702}
1703
Gilles Peskine449bd832023-01-11 14:50:10 +01001704void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1705 void *p_timer,
1706 mbedtls_ssl_set_timer_t *f_set_timer,
1707 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001708{
1709 ssl->p_timer = p_timer;
1710 ssl->f_set_timer = f_set_timer;
1711 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001712
1713 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001715}
1716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001718void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1719 void *p_cache,
1720 mbedtls_ssl_cache_get_t *f_get_cache,
1721 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001722{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001723 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001724 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001725 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001726}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001730int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001731{
Janos Follath865b3eb2019-12-16 11:46:15 +00001732 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001735 session == NULL ||
1736 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1738 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001739 }
1740
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 if (ssl->handshake->resume == 1) {
1742 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1743 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001744
Jerry Yu21092062022-10-10 21:21:31 +08001745#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001747 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001751 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1753 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1754 session->ciphersuite));
1755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001756 }
Jerry Yu40afab62022-10-08 10:42:13 +08001757 }
Jerry Yu21092062022-10-10 21:21:31 +08001758#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1761 session)) != 0) {
1762 return ret;
1763 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001764
Paul Bakker0a597072012-09-25 21:55:46 +00001765 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001768}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1772 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001773{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001774 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001775}
1776
Ronald Cron6f135e12021-12-08 16:57:54 +01001777#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001778void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1779 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001780{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001781 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001782}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001783
1784#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001785void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
1786 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787{
1788 conf->early_data_enabled = early_data_enabled;
1789}
Jerry Yucc4e0072022-11-22 17:22:22 +08001790
1791#if defined(MBEDTLS_SSL_SRV_C)
1792void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001794{
Jerry Yu39da9852022-12-06 16:58:36 +08001795 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001796}
1797#endif /* MBEDTLS_SSL_SRV_C */
1798
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001799#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001800#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001803void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1804 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001805{
1806 conf->cert_profile = profile;
1807}
1808
Gilles Peskine449bd832023-01-11 14:50:10 +01001809static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001810{
1811 mbedtls_ssl_key_cert *cur = key_cert, *next;
1812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001814 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001816 cur = next;
1817 }
1818}
1819
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001820/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001821MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001822static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1823 mbedtls_x509_crt *cert,
1824 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001825{
niisato8ee24222018-06-25 19:05:48 +09001826 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001829 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001831 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001833 }
1834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1836 if (new_cert == NULL) {
1837 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1838 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001839
niisato8ee24222018-06-25 19:05:48 +09001840 new_cert->cert = cert;
1841 new_cert->key = key;
1842 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001843
Glenn Strauss36872db2022-01-22 05:06:31 -05001844 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001846 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001848 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 }
niisato8ee24222018-06-25 19:05:48 +09001852 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001853 }
1854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001856}
1857
Gilles Peskine449bd832023-01-11 14:50:10 +01001858int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001859 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001861{
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001863}
1864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001866 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001868{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001869 conf->ca_chain = ca_chain;
1870 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001871
1872#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1873 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1874 * cannot be used together. */
1875 conf->f_ca_cb = NULL;
1876 conf->p_ca_cb = NULL;
1877#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001878}
Hanno Becker5adaad92019-03-27 16:54:37 +00001879
1880#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001881void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1882 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1883 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001884{
1885 conf->f_ca_cb = f_ca_cb;
1886 conf->p_ca_cb = p_ca_cb;
1887
1888 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1889 * cannot be used together. */
1890 conf->ca_chain = NULL;
1891 conf->ca_crl = NULL;
1892}
1893#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001895
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001896#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001897const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1898 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001899{
1900 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001902}
1903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1905 mbedtls_x509_crt *own_cert,
1906 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001907{
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1909 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001910}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1913 mbedtls_x509_crt *ca_chain,
1914 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001915{
1916 ssl->handshake->sni_ca_chain = ca_chain;
1917 ssl->handshake->sni_ca_crl = ca_crl;
1918}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001919
Glenn Strauss999ef702022-03-11 01:37:23 -05001920#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001921void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1922 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001923{
1924 ssl->handshake->dn_hints = crt;
1925}
1926#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1927
Gilles Peskine449bd832023-01-11 14:50:10 +01001928void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1929 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001930{
1931 ssl->handshake->sni_authmode = authmode;
1932}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001933#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1934
Hanno Becker8927c832019-04-03 12:52:50 +01001935#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001936void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1937 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1938 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001939{
1940 ssl->f_vrfy = f_vrfy;
1941 ssl->p_vrfy = p_vrfy;
1942}
1943#endif
1944
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001945#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001946
Valerio Setti016f6822022-12-09 14:17:50 +01001947#if defined(MBEDTLS_USE_PSA_CRYPTO)
1948static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 mbedtls_ssl_context *ssl,
1950 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001951{
1952 psa_status_t status;
1953 psa_pake_role_t psa_role;
1954 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
1955
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1957 psa_pake_cs_set_primitive(&cipher_suite,
1958 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1959 PSA_ECC_FAMILY_SECP_R1,
1960 256));
1961 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001962
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1964 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001965 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02001969 psa_role = PSA_PAKE_ROLE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 } else {
Neil Armstrongca7d5062022-05-31 14:43:23 +02001971 psa_role = PSA_PAKE_ROLE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001973
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 status = psa_pake_set_role(&ssl->handshake->psa_pake_ctx, psa_role);
1975 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001976 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 }
Valerio Setti016f6822022-12-09 14:17:50 +01001978
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1980 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001981 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 }
Valerio Setti016f6822022-12-09 14:17:50 +01001983
1984 ssl->handshake->psa_pake_ctx_is_ok = 1;
1985
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001987}
1988
Gilles Peskine449bd832023-01-11 14:50:10 +01001989int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1990 const unsigned char *pw,
1991 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001992{
1993 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1994 psa_status_t status;
1995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 if (ssl->handshake == NULL || ssl->conf == NULL) {
1997 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001998 }
1999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 /* Empty password is not valid */
2001 if ((pw == NULL) || (pw_len == 0)) {
2002 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2003 }
2004
2005 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2006 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2007 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2008
2009 status = psa_import_key(&attributes, pw, pw_len,
2010 &ssl->handshake->psa_pake_password);
2011 if (status != PSA_SUCCESS) {
2012 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2013 }
2014
2015 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2016 ssl->handshake->psa_pake_password);
2017 if (status != PSA_SUCCESS) {
2018 psa_destroy_key(ssl->handshake->psa_pake_password);
2019 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2020 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2021 }
2022
2023 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002024}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002025
Gilles Peskine449bd832023-01-11 14:50:10 +01002026int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2027 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002028{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002029 psa_status_t status;
2030
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 if (ssl->handshake == NULL || ssl->conf == NULL) {
2032 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002033 }
2034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 if (mbedtls_svc_key_id_is_null(pwd)) {
2036 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2037 }
2038
2039 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2040 if (status != PSA_SUCCESS) {
2041 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2042 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2043 }
2044
2045 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002046}
2047#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002048int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2049 const unsigned char *pw,
2050 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002051{
2052 mbedtls_ecjpake_role role;
2053
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 if (ssl->handshake == NULL || ssl->conf == NULL) {
2055 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2056 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002057
Valerio Settic689ed82022-12-07 14:40:38 +01002058 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 if ((pw == NULL) || (pw_len == 0)) {
2060 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2061 }
Valerio Settic689ed82022-12-07 14:40:38 +01002062
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002064 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002066 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002068
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2070 role,
2071 MBEDTLS_MD_SHA256,
2072 MBEDTLS_ECP_DP_SECP256R1,
2073 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002074}
Valerio Setti02c25b52022-11-15 14:08:42 +01002075#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002076#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002077
Ronald Cron73fe8df2022-10-05 14:31:43 +02002078#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002079int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002080{
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 if (conf->psk_identity == NULL ||
2082 conf->psk_identity_len == 0) {
2083 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002084 }
2085
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002086#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2088 return 1;
2089 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002090#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002091
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 if (conf->psk != NULL && conf->psk_len != 0) {
2093 return 1;
2094 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002097}
2098
Gilles Peskine449bd832023-01-11 14:50:10 +01002099static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002100{
2101 /* Remove reference to existing PSK, if any. */
2102#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002104 /* The maintenance of the PSK key slot is the
2105 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002106 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002107 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002108#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 if (conf->psk != NULL) {
2110 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 mbedtls_free(conf->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002113 conf->psk = NULL;
2114 conf->psk_len = 0;
2115 }
2116
2117 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 if (conf->psk_identity != NULL) {
2119 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002120 conf->psk_identity = NULL;
2121 conf->psk_identity_len = 0;
2122 }
2123}
2124
Hanno Becker7390c712018-11-15 13:33:04 +00002125/* This function assumes that PSK identity in the SSL config is unset.
2126 * It checks that the provided identity is well-formed and attempts
2127 * to make a copy of it in the SSL config.
2128 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002129MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002130static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2131 unsigned char const *psk_identity,
2132 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002133{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002134 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002136 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 (psk_identity_len >> 16) != 0 ||
2138 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2139 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002140 }
2141
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2143 if (conf->psk_identity == NULL) {
2144 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2145 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002146
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002147 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002149
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002151}
2152
Gilles Peskine449bd832023-01-11 14:50:10 +01002153int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2154 const unsigned char *psk, size_t psk_len,
2155 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002156{
Janos Follath865b3eb2019-12-16 11:46:15 +00002157 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002158
2159 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002160 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2161 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2162 }
Hanno Becker7390c712018-11-15 13:33:04 +00002163
2164 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 if (psk == NULL) {
2166 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2167 }
2168 if (psk_len == 0) {
2169 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2170 }
2171 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2173 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002174
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2176 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2177 }
Hanno Becker7390c712018-11-15 13:33:04 +00002178 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002180
2181 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2183 if (ret != 0) {
2184 ssl_conf_remove_psk(conf);
2185 }
Hanno Becker7390c712018-11-15 13:33:04 +00002186
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002188}
2189
Gilles Peskine449bd832023-01-11 14:50:10 +01002190static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002191{
2192#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002194 /* The maintenance of the external PSK key slot is the
2195 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 if (ssl->handshake->psk_opaque_is_internal) {
2197 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002198 ssl->handshake->psk_opaque_is_internal = 0;
2199 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002200 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002201 }
Neil Armstronge952a302022-05-03 10:22:14 +02002202#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 if (ssl->handshake->psk != NULL) {
2204 mbedtls_platform_zeroize(ssl->handshake->psk,
2205 ssl->handshake->psk_len);
2206 mbedtls_free(ssl->handshake->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002207 ssl->handshake->psk_len = 0;
2208 }
Neil Armstronge952a302022-05-03 10:22:14 +02002209#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002210}
2211
Gilles Peskine449bd832023-01-11 14:50:10 +01002212int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2213 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002214{
Neil Armstrong501c9322022-05-03 09:35:09 +02002215#if defined(MBEDTLS_USE_PSA_CRYPTO)
2216 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002217 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002218 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002219 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002220#endif /* MBEDTLS_USE_PSA_CRYPTO */
2221
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 if (psk == NULL || ssl->handshake == NULL) {
2223 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2224 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002225
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2227 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2228 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002229
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002231
Neil Armstrong501c9322022-05-03 09:35:09 +02002232#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002233#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2235 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2236 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2237 } else {
2238 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2239 }
2240 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002241 }
2242#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002243
Jerry Yu568ec252022-07-22 21:27:34 +08002244#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2246 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2247 psa_set_key_usage_flags(&key_attributes,
2248 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002249 }
2250#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2251
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 psa_set_key_algorithm(&key_attributes, alg);
2253 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002254
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2256 if (status != PSA_SUCCESS) {
2257 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2258 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002259
2260 /* Allow calling psa_destroy_key() on psk remove */
2261 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002263#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2265 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2266 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002267
2268 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002272#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002273}
2274
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002275#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002276int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2277 mbedtls_svc_key_id_t psk,
2278 const unsigned char *psk_identity,
2279 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002280{
Janos Follath865b3eb2019-12-16 11:46:15 +00002281 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002282
2283 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2285 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2286 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002287
Hanno Becker7390c712018-11-15 13:33:04 +00002288 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 if (mbedtls_svc_key_id_is_null(psk)) {
2290 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2291 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002292 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002293
2294 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2296 psk_identity_len);
2297 if (ret != 0) {
2298 ssl_conf_remove_psk(conf);
2299 }
Hanno Becker7390c712018-11-15 13:33:04 +00002300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002302}
2303
Gilles Peskine449bd832023-01-11 14:50:10 +01002304int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2305 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002306{
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 if ((mbedtls_svc_key_id_is_null(psk)) ||
2308 (ssl->handshake == NULL)) {
2309 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2310 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002311
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002313 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002315}
2316#endif /* MBEDTLS_USE_PSA_CRYPTO */
2317
Jerry Yu8897c072022-08-12 13:56:53 +08002318#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002319void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2320 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2321 size_t),
2322 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002323{
2324 conf->f_psk = f_psk;
2325 conf->p_psk = p_psk;
2326}
Jerry Yu8897c072022-08-12 13:56:53 +08002327#endif /* MBEDTLS_SSL_SRV_C */
2328
Ronald Cron73fe8df2022-10-05 14:31:43 +02002329#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002330
2331#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002332static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002334{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002335#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002336 if (alg == PSA_ALG_CBC_NO_PADDING) {
2337 return MBEDTLS_SSL_MODE_CBC;
2338 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002339#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 if (PSA_ALG_IS_AEAD(alg)) {
2341 return MBEDTLS_SSL_MODE_AEAD;
2342 }
2343 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002344}
2345
2346#else /* MBEDTLS_USE_PSA_CRYPTO */
2347
2348static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002350{
2351#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 if (mode == MBEDTLS_MODE_CBC) {
2353 return MBEDTLS_SSL_MODE_CBC;
2354 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002355#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2356
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002357#if defined(MBEDTLS_GCM_C) || \
2358 defined(MBEDTLS_CCM_C) || \
2359 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002361 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 mode == MBEDTLS_MODE_CHACHAPOLY) {
2363 return MBEDTLS_SSL_MODE_AEAD;
2364 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002365#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002366
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002368}
Gilles Peskine301711e2022-04-26 16:57:05 +02002369#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002370
Gilles Peskinee108d982022-04-26 16:50:40 +02002371static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2372 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002374{
2375#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2377 base_mode == MBEDTLS_SSL_MODE_CBC) {
2378 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002379 }
2380#else
2381 (void) encrypt_then_mac;
2382#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002384}
2385
Neil Armstrongab555e02022-04-04 11:07:59 +02002386mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002388{
Gilles Peskinee108d982022-04-26 16:50:40 +02002389 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002390#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002392#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002394#endif
2395 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002396
Gilles Peskinee108d982022-04-26 16:50:40 +02002397 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002398#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002399 encrypt_then_mac = transform->encrypt_then_mac;
2400#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002402}
2403
Neil Armstrongab555e02022-04-04 11:07:59 +02002404mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002405#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002407#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002409{
Gilles Peskinee108d982022-04-26 16:50:40 +02002410 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2411
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002412#if defined(MBEDTLS_USE_PSA_CRYPTO)
2413 psa_status_t status;
2414 psa_algorithm_t alg;
2415 psa_key_type_t type;
2416 size_t size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 status = mbedtls_ssl_cipher_to_psa(suite->cipher, 0, &alg, &type, &size);
2418 if (status == PSA_SUCCESS) {
2419 base_mode = mbedtls_ssl_get_base_mode(alg);
2420 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002421#else
2422 const mbedtls_cipher_info_t *cipher =
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 mbedtls_cipher_info_from_type(suite->cipher);
2424 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002425 base_mode =
2426 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002428 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002429#endif /* MBEDTLS_USE_PSA_CRYPTO */
2430
Gilles Peskinee108d982022-04-26 16:50:40 +02002431#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2432 int encrypt_then_mac = 0;
2433#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002435}
2436
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002437#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002438
2439#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002440/* Serialization of TLS 1.3 sessions:
2441 *
2442 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002443 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002444 * uint64 ticket_received;
2445 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002446 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002447 * } ClientOnlyData;
2448 *
2449 * struct {
2450 * uint8 endpoint;
2451 * uint8 ciphersuite[2];
2452 * uint32 ticket_age_add;
2453 * uint8 ticket_flags;
2454 * opaque resumption_key<0..255>;
2455 * select ( endpoint ) {
2456 * case client: ClientOnlyData;
2457 * case server: uint64 start_time;
2458 * };
2459 * } serialized_session_tls13;
2460 *
2461 */
2462#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002463MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002464static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2465 unsigned char *buf,
2466 size_t buf_len,
2467 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002468{
2469 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002470#if defined(MBEDTLS_SSL_CLI_C) && \
2471 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 size_t hostname_len = (session->hostname == NULL) ?
2473 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002474#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002475 size_t needed = 1 /* endpoint */
2476 + 2 /* ciphersuite */
2477 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002478 + 1 /* ticket_flags */
2479 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002480 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2483 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2484 }
Jerry Yu34191072022-08-18 10:32:09 +08002485 needed += session->resumption_key_len; /* resumption_key */
2486
Jerry Yu438ddd82022-07-07 06:55:50 +00002487#if defined(MBEDTLS_HAVE_TIME)
2488 needed += 8; /* start_time or ticket_received */
2489#endif
2490
2491#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002493#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002494 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002495 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002496#endif
2497
Jerry Yu438ddd82022-07-07 06:55:50 +00002498 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002499 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002500
2501 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 if (session->ticket_len > SIZE_MAX - needed) {
2503 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2504 }
Jerry Yu34191072022-08-18 10:32:09 +08002505
Jerry Yue28d9742022-08-18 15:44:03 +08002506 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002507 }
2508#endif /* MBEDTLS_SSL_CLI_C */
2509
Jerry Yue36fdd62022-08-17 21:31:36 +08002510 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 if (needed > buf_len) {
2512 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2513 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002514
2515 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2517 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002518 p[7] = session->ticket_flags;
2519
2520 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002521 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002522 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002524 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002525
2526#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2528 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002529 p += 8;
2530 }
2531#endif /* MBEDTLS_HAVE_TIME */
2532
2533#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002535#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002537 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002539 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002541 p += hostname_len;
2542 }
2543#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2544
Jerry Yu438ddd82022-07-07 06:55:50 +00002545#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002547 p += 8;
2548#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002550 p += 4;
2551
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002553 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002554
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 if (session->ticket != NULL && session->ticket_len > 0) {
2556 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002557 p += session->ticket_len;
2558 }
2559 }
2560#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002562}
2563
2564MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002565static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2566 const unsigned char *buf,
2567 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002568{
2569 const unsigned char *p = buf;
2570 const unsigned char *end = buf + len;
2571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 if (end - p < 9) {
2573 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2574 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002575 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2577 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002578 session->ticket_flags = p[7];
2579
2580 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002581 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002582 p += 9;
2583
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (end - p < session->resumption_key_len) {
2585 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2586 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2589 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2590 }
2591 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002592 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002593
2594#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2596 if (end - p < 8) {
2597 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2598 }
2599 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002600 p += 8;
2601 }
2602#endif /* MBEDTLS_HAVE_TIME */
2603
2604#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002606#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002608 size_t hostname_len;
2609 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 if (end - p < 2) {
2611 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2612 }
2613 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002614 p += 2;
2615
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if (end - p < (long int) hostname_len) {
2617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2618 }
2619 if (hostname_len > 0) {
2620 session->hostname = mbedtls_calloc(1, hostname_len);
2621 if (session->hostname == NULL) {
2622 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2623 }
2624 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002625 p += hostname_len;
2626 }
2627#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2628 MBEDTLS_SSL_SESSION_TICKETS */
2629
Jerry Yu438ddd82022-07-07 06:55:50 +00002630#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 if (end - p < 8) {
2632 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2633 }
2634 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002635 p += 8;
2636#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 if (end - p < 4) {
2638 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2639 }
2640 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002641 p += 4;
2642
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 if (end - p < 2) {
2644 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2645 }
2646 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002647 p += 2;
2648
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 if (end - p < (long int) session->ticket_len) {
2650 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2651 }
2652 if (session->ticket_len > 0) {
2653 session->ticket = mbedtls_calloc(1, session->ticket_len);
2654 if (session->ticket == NULL) {
2655 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2656 }
2657 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002658 p += session->ticket_len;
2659 }
2660 }
2661#endif /* MBEDTLS_SSL_CLI_C */
2662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002664
2665}
2666#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002667MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002668static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2669 unsigned char *buf,
2670 size_t buf_len,
2671 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002672{
2673 ((void) session);
2674 ((void) buf);
2675 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002676 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002678}
Jerry Yu438ddd82022-07-07 06:55:50 +00002679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2681 unsigned char *buf,
2682 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002683{
2684 ((void) session);
2685 ((void) buf);
2686 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002688}
2689#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002690#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2691
Gilles Peskine449bd832023-01-11 14:50:10 +01002692psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2693 size_t taglen,
2694 psa_algorithm_t *alg,
2695 psa_key_type_t *key_type,
2696 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002697{
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002699 case MBEDTLS_CIPHER_AES_128_CBC:
2700 *alg = PSA_ALG_CBC_NO_PADDING;
2701 *key_type = PSA_KEY_TYPE_AES;
2702 *key_size = 128;
2703 break;
2704 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002706 *key_type = PSA_KEY_TYPE_AES;
2707 *key_size = 128;
2708 break;
2709 case MBEDTLS_CIPHER_AES_128_GCM:
2710 *alg = PSA_ALG_GCM;
2711 *key_type = PSA_KEY_TYPE_AES;
2712 *key_size = 128;
2713 break;
2714 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002716 *key_type = PSA_KEY_TYPE_AES;
2717 *key_size = 192;
2718 break;
2719 case MBEDTLS_CIPHER_AES_192_GCM:
2720 *alg = PSA_ALG_GCM;
2721 *key_type = PSA_KEY_TYPE_AES;
2722 *key_size = 192;
2723 break;
2724 case MBEDTLS_CIPHER_AES_256_CBC:
2725 *alg = PSA_ALG_CBC_NO_PADDING;
2726 *key_type = PSA_KEY_TYPE_AES;
2727 *key_size = 256;
2728 break;
2729 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002731 *key_type = PSA_KEY_TYPE_AES;
2732 *key_size = 256;
2733 break;
2734 case MBEDTLS_CIPHER_AES_256_GCM:
2735 *alg = PSA_ALG_GCM;
2736 *key_type = PSA_KEY_TYPE_AES;
2737 *key_size = 256;
2738 break;
2739 case MBEDTLS_CIPHER_ARIA_128_CBC:
2740 *alg = PSA_ALG_CBC_NO_PADDING;
2741 *key_type = PSA_KEY_TYPE_ARIA;
2742 *key_size = 128;
2743 break;
2744 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002746 *key_type = PSA_KEY_TYPE_ARIA;
2747 *key_size = 128;
2748 break;
2749 case MBEDTLS_CIPHER_ARIA_128_GCM:
2750 *alg = PSA_ALG_GCM;
2751 *key_type = PSA_KEY_TYPE_ARIA;
2752 *key_size = 128;
2753 break;
2754 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002756 *key_type = PSA_KEY_TYPE_ARIA;
2757 *key_size = 192;
2758 break;
2759 case MBEDTLS_CIPHER_ARIA_192_GCM:
2760 *alg = PSA_ALG_GCM;
2761 *key_type = PSA_KEY_TYPE_ARIA;
2762 *key_size = 192;
2763 break;
2764 case MBEDTLS_CIPHER_ARIA_256_CBC:
2765 *alg = PSA_ALG_CBC_NO_PADDING;
2766 *key_type = PSA_KEY_TYPE_ARIA;
2767 *key_size = 256;
2768 break;
2769 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002771 *key_type = PSA_KEY_TYPE_ARIA;
2772 *key_size = 256;
2773 break;
2774 case MBEDTLS_CIPHER_ARIA_256_GCM:
2775 *alg = PSA_ALG_GCM;
2776 *key_type = PSA_KEY_TYPE_ARIA;
2777 *key_size = 256;
2778 break;
2779 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2780 *alg = PSA_ALG_CBC_NO_PADDING;
2781 *key_type = PSA_KEY_TYPE_CAMELLIA;
2782 *key_size = 128;
2783 break;
2784 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002786 *key_type = PSA_KEY_TYPE_CAMELLIA;
2787 *key_size = 128;
2788 break;
2789 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2790 *alg = PSA_ALG_GCM;
2791 *key_type = PSA_KEY_TYPE_CAMELLIA;
2792 *key_size = 128;
2793 break;
2794 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002796 *key_type = PSA_KEY_TYPE_CAMELLIA;
2797 *key_size = 192;
2798 break;
2799 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2800 *alg = PSA_ALG_GCM;
2801 *key_type = PSA_KEY_TYPE_CAMELLIA;
2802 *key_size = 192;
2803 break;
2804 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2805 *alg = PSA_ALG_CBC_NO_PADDING;
2806 *key_type = PSA_KEY_TYPE_CAMELLIA;
2807 *key_size = 256;
2808 break;
2809 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002811 *key_type = PSA_KEY_TYPE_CAMELLIA;
2812 *key_size = 256;
2813 break;
2814 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2815 *alg = PSA_ALG_GCM;
2816 *key_type = PSA_KEY_TYPE_CAMELLIA;
2817 *key_size = 256;
2818 break;
2819 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2820 *alg = PSA_ALG_CHACHA20_POLY1305;
2821 *key_type = PSA_KEY_TYPE_CHACHA20;
2822 *key_size = 256;
2823 break;
2824 case MBEDTLS_CIPHER_NULL:
2825 *alg = MBEDTLS_SSL_NULL_CIPHER;
2826 *key_type = 0;
2827 *key_size = 0;
2828 break;
2829 default:
2830 return PSA_ERROR_NOT_SUPPORTED;
2831 }
2832
2833 return PSA_SUCCESS;
2834}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002835#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002836
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002837#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002838int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2839 const unsigned char *dhm_P, size_t P_len,
2840 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002841{
Janos Follath865b3eb2019-12-16 11:46:15 +00002842 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002843
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 mbedtls_mpi_free(&conf->dhm_P);
2845 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2848 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2849 mbedtls_mpi_free(&conf->dhm_P);
2850 mbedtls_mpi_free(&conf->dhm_G);
2851 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002852 }
2853
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002855}
Paul Bakker5121ce52009-01-03 21:22:43 +00002856
Gilles Peskine449bd832023-01-11 14:50:10 +01002857int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002858{
Janos Follath865b3eb2019-12-16 11:46:15 +00002859 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002860
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_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2865 &conf->dhm_P)) != 0 ||
2866 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2867 &conf->dhm_G)) != 0) {
2868 mbedtls_mpi_free(&conf->dhm_P);
2869 mbedtls_mpi_free(&conf->dhm_G);
2870 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002871 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002872
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002874}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002875#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002876
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002877#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2878/*
2879 * Set the minimum length for Diffie-Hellman parameters
2880 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002881void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2882 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002883{
2884 conf->dhm_min_bitlen = bitlen;
2885}
2886#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2887
Ronald Crone68ab4f2022-10-05 12:46:29 +02002888#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002889#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002890/*
2891 * Set allowed/preferred hashes for handshake signatures
2892 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002893void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2894 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002895{
2896 conf->sig_hashes = hashes;
2897}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002898#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002899
Jerry Yuf017ee42022-01-12 15:49:48 +08002900/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002901void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2902 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002903{
Jerry Yuf017ee42022-01-12 15:49:48 +08002904#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2905 conf->sig_hashes = NULL;
2906#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2907 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002908}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002909#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002910
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002911#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002912#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002913/*
2914 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002915 *
2916 * mbedtls_ssl_setup() takes the provided list
2917 * and translates it to a list of IANA TLS group identifiers,
2918 * stored in ssl->handshake->group_list.
2919 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002920 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002921void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2922 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002923{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002924 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002925 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002926}
Brett Warrene0edc842021-08-17 09:53:13 +01002927#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002928#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002929
Brett Warrene0edc842021-08-17 09:53:13 +01002930/*
2931 * Set the allowed groups
2932 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002933void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2934 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002935{
2936#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2937 conf->curve_list = NULL;
2938#endif
2939 conf->group_list = group_list;
2940}
2941
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002942#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002943int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002944{
Hanno Becker947194e2017-04-07 13:25:49 +01002945 /* Initialize to suppress unnecessary compiler warning */
2946 size_t hostname_len = 0;
2947
2948 /* Check if new hostname is valid before
2949 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 if (hostname != NULL) {
2951 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002952
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2954 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2955 }
Hanno Becker947194e2017-04-07 13:25:49 +01002956 }
2957
2958 /* Now it's clear that we will overwrite the old hostname,
2959 * so we can free it safely */
2960
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 if (ssl->hostname != NULL) {
2962 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
2963 mbedtls_free(ssl->hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002964 }
2965
2966 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002967
Gilles Peskine449bd832023-01-11 14:50:10 +01002968 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002969 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 } else {
2971 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2972 if (ssl->hostname == NULL) {
2973 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2974 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002975
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002977
Hanno Becker947194e2017-04-07 13:25:49 +01002978 ssl->hostname[hostname_len] = '\0';
2979 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002980
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002982}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002983#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002984
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002985#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002986void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2987 int (*f_sni)(void *, mbedtls_ssl_context *,
2988 const unsigned char *, size_t),
2989 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002990{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002991 conf->f_sni = f_sni;
2992 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002993}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002994#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002995
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002997int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002998{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002999 size_t cur_len, tot_len;
3000 const char **p;
3001
3002 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003003 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3004 * MUST NOT be truncated."
3005 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003006 */
3007 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 for (p = protos; *p != NULL; p++) {
3009 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003010 tot_len += cur_len;
3011
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 if ((cur_len == 0) ||
3013 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3014 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3015 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3016 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003017 }
3018
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003019 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003020
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003022}
3023
Gilles Peskine449bd832023-01-11 14:50:10 +01003024const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003025{
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003027}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003029
Johan Pascalb62bb512015-12-03 21:56:45 +01003030#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003031void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3032 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003033{
3034 conf->dtls_srtp_mki_support = support_mki_value;
3035}
3036
Gilles Peskine449bd832023-01-11 14:50:10 +01003037int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3038 unsigned char *mki_value,
3039 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003040{
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3042 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003043 }
Ron Eldor591f1622018-01-22 12:30:04 +02003044
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3046 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003047 }
Ron Eldor591f1622018-01-22 12:30:04 +02003048
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003050 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003052}
3053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3055 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003056{
Johan Pascal253d0262020-09-22 13:04:45 +02003057 const mbedtls_ssl_srtp_profile *p;
3058 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003059
Johan Pascal253d0262020-09-22 13:04:45 +02003060 /* check the profiles list: all entry must be valid,
3061 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3063 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3064 p++) {
3065 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003066 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003068 /* unsupported value, stop parsing and set the size to an error value */
3069 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003070 }
3071 }
3072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3074 conf->dtls_srtp_profile_list = NULL;
3075 conf->dtls_srtp_profile_list_len = 0;
3076 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003077 }
3078
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003079 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003080 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003081
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003083}
3084
Gilles Peskine449bd832023-01-11 14:50:10 +01003085void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3086 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003087{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003088 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3089 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003091 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003093 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3095 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003096 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003097}
Johan Pascalb62bb512015-12-03 21:56:45 +01003098#endif /* MBEDTLS_SSL_DTLS_SRTP */
3099
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303100#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003101void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003102{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003103 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00003104}
3105
Gilles Peskine449bd832023-01-11 14:50:10 +01003106void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003107{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003108 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00003109}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303110#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003111
Janos Follath088ce432017-04-10 12:42:31 +01003112#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003113void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3114 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003115{
3116 conf->cert_req_ca_list = cert_req_ca_list;
3117}
3118#endif
3119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003121void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003122{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003123 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003124}
3125#endif
3126
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003128void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003129{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003130 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003131}
3132#endif
3133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003135int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003136{
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3138 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3139 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003140 }
3141
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003142 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003143
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003145}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003146#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003147
Gilles Peskine449bd832023-01-11 14:50:10 +01003148void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003149{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003150 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003151}
3152
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003154void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003155{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003156 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003157}
3158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003160{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003161 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003162}
3163
Gilles Peskine449bd832023-01-11 14:50:10 +01003164void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3165 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003166{
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003168}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003169#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003170
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003171#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003172#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003173void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003174{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003175 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003176}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003177#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003178
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003179#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003180
Jerry Yud0766ec2022-09-22 10:46:57 +08003181#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003182void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3183 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003184{
Jerry Yud0766ec2022-09-22 10:46:57 +08003185 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003186}
3187#endif
3188
Gilles Peskine449bd832023-01-11 14:50:10 +01003189void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3190 mbedtls_ssl_ticket_write_t *f_ticket_write,
3191 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3192 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003193{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003194 conf->f_ticket_write = f_ticket_write;
3195 conf->f_ticket_parse = f_ticket_parse;
3196 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003197}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003198#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003199#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003200
Gilles Peskine449bd832023-01-11 14:50:10 +01003201void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3202 mbedtls_ssl_export_keys_t *f_export_keys,
3203 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003204{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003205 ssl->f_export_keys = f_export_keys;
3206 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003207}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003208
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003209#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003210void mbedtls_ssl_conf_async_private_cb(
3211 mbedtls_ssl_config *conf,
3212 mbedtls_ssl_async_sign_t *f_async_sign,
3213 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3214 mbedtls_ssl_async_resume_t *f_async_resume,
3215 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003217{
3218 conf->f_async_sign_start = f_async_sign;
3219 conf->f_async_decrypt_start = f_async_decrypt;
3220 conf->f_async_resume = f_async_resume;
3221 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003222 conf->p_async_config_data = async_config_data;
3223}
3224
Gilles Peskine449bd832023-01-11 14:50:10 +01003225void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003226{
Gilles Peskine449bd832023-01-11 14:50:10 +01003227 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003228}
3229
Gilles Peskine449bd832023-01-11 14:50:10 +01003230void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003231{
Gilles Peskine449bd832023-01-11 14:50:10 +01003232 if (ssl->handshake == NULL) {
3233 return NULL;
3234 } else {
3235 return ssl->handshake->user_async_ctx;
3236 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003237}
3238
Gilles Peskine449bd832023-01-11 14:50:10 +01003239void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3240 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003241{
Gilles Peskine449bd832023-01-11 14:50:10 +01003242 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003243 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003245}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003246#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003247
Paul Bakker5121ce52009-01-03 21:22:43 +00003248/*
3249 * SSL get accessors
3250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003251uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003252{
Gilles Peskine449bd832023-01-11 14:50:10 +01003253 if (ssl->session != NULL) {
3254 return ssl->session->verify_result;
3255 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003256
Gilles Peskine449bd832023-01-11 14:50:10 +01003257 if (ssl->session_negotiate != NULL) {
3258 return ssl->session_negotiate->verify_result;
3259 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003260
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003262}
3263
Gilles Peskine449bd832023-01-11 14:50:10 +01003264int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003265{
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 if (ssl == NULL || ssl->session == NULL) {
3267 return 0;
3268 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003269
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003271}
3272
Gilles Peskine449bd832023-01-11 14:50:10 +01003273const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003274{
Gilles Peskine449bd832023-01-11 14:50:10 +01003275 if (ssl == NULL || ssl->session == NULL) {
3276 return NULL;
3277 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003278
Gilles Peskine449bd832023-01-11 14:50:10 +01003279 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003280}
3281
Gilles Peskine449bd832023-01-11 14:50:10 +01003282const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003283{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003284#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3286 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003287 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003288 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003289 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003290 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003291 }
3292 }
3293#endif
3294
Gilles Peskine449bd832023-01-11 14:50:10 +01003295 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003296 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003298 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003300 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003302 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003303}
3304
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003305#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003306size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003307{
David Horstmann95d516f2021-05-04 18:36:56 +01003308 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003309 size_t read_mfl;
3310
Jerry Yuddda0502022-12-01 19:43:12 +08003311#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003312 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003313 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3314 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3315 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003316 }
Jerry Yuddda0502022-12-01 19:43:12 +08003317#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003318
3319 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003320 if (ssl->session_out != NULL) {
3321 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3322 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003323 max_len = read_mfl;
3324 }
3325 }
3326
Jerry Yuddda0502022-12-01 19:43:12 +08003327 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003328 if (ssl->session_negotiate != NULL) {
3329 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3330 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003331 max_len = read_mfl;
3332 }
3333 }
3334
Gilles Peskine449bd832023-01-11 14:50:10 +01003335 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003336}
3337
Gilles Peskine449bd832023-01-11 14:50:10 +01003338size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003339{
3340 size_t max_len;
3341
3342 /*
3343 * Assume mfl_code is correct since it was checked when set
3344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003345 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003346
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003347 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 if (ssl->session_out != NULL &&
3349 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3350 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003351 }
3352
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003353 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003354 if (ssl->session_negotiate != NULL &&
3355 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3356 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003357 }
3358
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003360}
3361#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3362
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003363#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003364size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003365{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003366 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003367 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3368 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3369 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3370 return 0;
3371 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003372
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3374 return ssl->mtu;
3375 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003376
Gilles Peskine449bd832023-01-11 14:50:10 +01003377 if (ssl->mtu == 0) {
3378 return ssl->handshake->mtu;
3379 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003380
Gilles Peskine449bd832023-01-11 14:50:10 +01003381 return ssl->mtu < ssl->handshake->mtu ?
3382 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003383}
3384#endif /* MBEDTLS_SSL_PROTO_DTLS */
3385
Gilles Peskine449bd832023-01-11 14:50:10 +01003386int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003387{
3388 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3389
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003390#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3391 !defined(MBEDTLS_SSL_PROTO_DTLS)
3392 (void) ssl;
3393#endif
3394
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003395#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003396 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003397
Gilles Peskine449bd832023-01-11 14:50:10 +01003398 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003399 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003400 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003401#endif
3402
3403#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003404 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3405 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3406 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003407 const size_t overhead = (size_t) ret;
3408
Gilles Peskine449bd832023-01-11 14:50:10 +01003409 if (ret < 0) {
3410 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003411 }
3412
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 if (mtu <= overhead) {
3414 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3415 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3416 }
3417
3418 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003419 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003421 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003422#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003423
Hanno Becker0defedb2018-08-10 12:35:02 +01003424#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3425 !defined(MBEDTLS_SSL_PROTO_DTLS)
3426 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003427#endif
3428
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003430}
3431
Gilles Peskine449bd832023-01-11 14:50:10 +01003432int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003433{
3434 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3435
3436#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3437 (void) ssl;
3438#endif
3439
3440#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003441 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003442
Gilles Peskine449bd832023-01-11 14:50:10 +01003443 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003444 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003445 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003446#endif
3447
Gilles Peskine449bd832023-01-11 14:50:10 +01003448 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003449}
3450
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003451#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003452const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003453{
Gilles Peskine449bd832023-01-11 14:50:10 +01003454 if (ssl == NULL || ssl->session == NULL) {
3455 return NULL;
3456 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003457
Hanno Beckere6824572019-02-07 13:18:46 +00003458#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003459 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003460#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003461 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003462#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003463}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003464#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003465
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003466#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003467int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3468 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003469{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003470 int ret;
3471
Gilles Peskine449bd832023-01-11 14:50:10 +01003472 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003473 dst == NULL ||
3474 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003475 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3476 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003477 }
3478
Hanno Beckere810bbc2021-05-14 16:01:05 +01003479 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3480 * idempotent: Each session can only be exported once.
3481 *
3482 * (This is in preparation for TLS 1.3 support where we will
3483 * need the ability to export multiple sessions (aka tickets),
3484 * which will be achieved by calling mbedtls_ssl_get_session()
3485 * multiple times until it fails.)
3486 *
3487 * Check whether we have already exported the current session,
3488 * and fail if so.
3489 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003490 if (ssl->session->exported == 1) {
3491 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3492 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003493
Gilles Peskine449bd832023-01-11 14:50:10 +01003494 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3495 if (ret != 0) {
3496 return ret;
3497 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003498
3499 /* Remember that we've exported the session. */
3500 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003501 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003502}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003503#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003504
Paul Bakker5121ce52009-01-03 21:22:43 +00003505/*
Hanno Beckera835da52019-05-16 12:39:07 +01003506 * Define ticket header determining Mbed TLS version
3507 * and structure of the ticket.
3508 */
3509
Hanno Becker94ef3b32019-05-16 12:50:45 +01003510/*
Hanno Becker50b59662019-05-28 14:30:45 +01003511 * Define bitflag determining compile-time settings influencing
3512 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003513 */
3514
Hanno Becker50b59662019-05-28 14:30:45 +01003515#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003516#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003517#else
Hanno Becker3e088662019-05-29 11:10:18 +01003518#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003519#endif /* MBEDTLS_HAVE_TIME */
3520
3521#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003522#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003523#else
Hanno Becker3e088662019-05-29 11:10:18 +01003524#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003525#endif /* MBEDTLS_X509_CRT_PARSE_C */
3526
3527#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003528#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003529#else
Hanno Becker3e088662019-05-29 11:10:18 +01003530#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003531#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3532
3533#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003534#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003535#else
Hanno Becker3e088662019-05-29 11:10:18 +01003536#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003537#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3538
Hanno Becker94ef3b32019-05-16 12:50:45 +01003539#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003540#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003541#else
Hanno Becker3e088662019-05-29 11:10:18 +01003542#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003543#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3544
Hanno Becker94ef3b32019-05-16 12:50:45 +01003545#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3546#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3547#else
3548#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3549#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3550
Hanno Becker3e088662019-05-29 11:10:18 +01003551#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3552#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3553#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3554#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003555#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3556#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003557
Hanno Becker50b59662019-05-28 14:30:45 +01003558#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003559 ((uint16_t) ( \
3560 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3561 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3562 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3563 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3564 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3565 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3566 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003567
Hanno Beckerf8787072019-05-16 12:41:07 +01003568static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003569 MBEDTLS_VERSION_MAJOR,
3570 MBEDTLS_VERSION_MINOR,
3571 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003572 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3573 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003574};
Hanno Beckera835da52019-05-16 12:39:07 +01003575
3576/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003577 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003578 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003579 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003580 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003581 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003582 * opaque mbedtls_version[3]; // library version: major, minor, patch
3583 * opaque session_format[2]; // library-version specific 16-bit field
3584 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003585 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003586 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003587 * Note: When updating the format, remember to keep
3588 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003589 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003590 * // In this version, `session_format` determines
3591 * // the setting of those compile-time
3592 * // configuration options which influence
3593 * // the structure of mbedtls_ssl_session.
3594 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003595 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003596 * // - TLS 1.2 (0x0303)
3597 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003598 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003599 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003600 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003601 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003602 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003603 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003604 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003605 *
3606 * };
3607 *
3608 * } serialized_session;
3609 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003610 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003611
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003612MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003613static int ssl_session_save(const mbedtls_ssl_session *session,
3614 unsigned char omit_header,
3615 unsigned char *buf,
3616 size_t buf_len,
3617 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003618{
3619 unsigned char *p = buf;
3620 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003621 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003622#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3623 size_t out_len;
3624 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3625#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003626 if (session == NULL) {
3627 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3628 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003629
Gilles Peskine449bd832023-01-11 14:50:10 +01003630 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003631 /*
3632 * Add Mbed TLS version identifier
3633 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003634 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003635
Gilles Peskine449bd832023-01-11 14:50:10 +01003636 if (used <= buf_len) {
3637 memcpy(p, ssl_serialized_session_header,
3638 sizeof(ssl_serialized_session_header));
3639 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003640 }
3641 }
3642
3643 /*
3644 * TLS version identifier
3645 */
3646 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003647 if (used <= buf_len) {
3648 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003649 }
3650
3651 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003652 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003653 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003654#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003655 case MBEDTLS_SSL_VERSION_TLS1_2:
3656 used += ssl_tls12_session_save(session, p, remaining_len);
3657 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003658#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3659
Jerry Yu251a12e2022-07-13 15:15:48 +08003660#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003661 case MBEDTLS_SSL_VERSION_TLS1_3:
3662 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3663 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3664 return ret;
3665 }
3666 used += out_len;
3667 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003668#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3669
Gilles Peskine449bd832023-01-11 14:50:10 +01003670 default:
3671 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003672 }
3673
3674 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003675 if (used > buf_len) {
3676 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3677 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003678
Gilles Peskine449bd832023-01-11 14:50:10 +01003679 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003680}
3681
3682/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003683 * Public wrapper for ssl_session_save()
3684 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003685int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3686 unsigned char *buf,
3687 size_t buf_len,
3688 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003689{
Gilles Peskine449bd832023-01-11 14:50:10 +01003690 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003691}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003692
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003693/*
3694 * Deserialize session, see mbedtls_ssl_session_save() for format.
3695 *
3696 * This internal version is wrapped by a public function that cleans up in
3697 * case of error, and has an extra option omit_header.
3698 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003699MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003700static int ssl_session_load(mbedtls_ssl_session *session,
3701 unsigned char omit_header,
3702 const unsigned char *buf,
3703 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003704{
3705 const unsigned char *p = buf;
3706 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003707 size_t remaining_len;
3708
3709
Gilles Peskine449bd832023-01-11 14:50:10 +01003710 if (session == NULL) {
3711 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3712 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003713
Gilles Peskine449bd832023-01-11 14:50:10 +01003714 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003715 /*
3716 * Check Mbed TLS version identifier
3717 */
3718
Gilles Peskine449bd832023-01-11 14:50:10 +01003719 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3720 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003721 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003722
3723 if (memcmp(p, ssl_serialized_session_header,
3724 sizeof(ssl_serialized_session_header)) != 0) {
3725 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3726 }
3727 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003728 }
3729
3730 /*
3731 * TLS version identifier
3732 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003733 if (1 > (size_t) (end - p)) {
3734 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3735 }
Glenn Straussda7851c2022-03-14 13:29:48 -04003736 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003737
3738 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003739 remaining_len = (end - p);
3740 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003741#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003742 case MBEDTLS_SSL_VERSION_TLS1_2:
3743 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003744#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3745
Jerry Yu438ddd82022-07-07 06:55:50 +00003746#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003747 case MBEDTLS_SSL_VERSION_TLS1_3:
3748 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003749#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3750
Gilles Peskine449bd832023-01-11 14:50:10 +01003751 default:
3752 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003753 }
3754}
3755
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003756/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003757 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003758 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003759int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3760 const unsigned char *buf,
3761 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003762{
Gilles Peskine449bd832023-01-11 14:50:10 +01003763 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003764
Gilles Peskine449bd832023-01-11 14:50:10 +01003765 if (ret != 0) {
3766 mbedtls_ssl_session_free(session);
3767 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003768
Gilles Peskine449bd832023-01-11 14:50:10 +01003769 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003770}
3771
3772/*
Paul Bakker1961b702013-01-25 14:49:24 +01003773 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003774 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003775MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003776static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003777{
3778 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3779
Ronald Cron66dbf912022-02-02 15:33:46 +01003780 /*
3781 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003782 * that were written into the output buffer by the previous handshake step,
3783 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003784 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3785 * We proceed to the next handshake step only when all data from the
3786 * previous one have been sent to the peer, thus we make sure that this is
3787 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3788 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3789 * we have to wait before to go ahead.
3790 * In the case of TLS 1.3, handshake step handlers do not send data to the
3791 * peer. Data are only sent here and through
3792 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003793 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003794 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003795 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3796 return ret;
3797 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003798
3799#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003800 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3801 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3802 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3803 return ret;
3804 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003805 }
3806#endif /* MBEDTLS_SSL_PROTO_DTLS */
3807
Gilles Peskine449bd832023-01-11 14:50:10 +01003808 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003809}
3810
Gilles Peskine449bd832023-01-11 14:50:10 +01003811int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003812{
Hanno Becker41934dd2021-08-07 19:13:43 +01003813 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003814
Gilles Peskine449bd832023-01-11 14:50:10 +01003815 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003816 ssl->conf == NULL ||
3817 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003818 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3819 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003820 }
3821
Gilles Peskine449bd832023-01-11 14:50:10 +01003822 ret = ssl_prepare_handshake_step(ssl);
3823 if (ret != 0) {
3824 return ret;
3825 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003826
Gilles Peskine449bd832023-01-11 14:50:10 +01003827 ret = mbedtls_ssl_handle_pending_alert(ssl);
3828 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003829 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003830 }
Jerry Yue7047812021-09-13 19:26:39 +08003831
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003832 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3833 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3834 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3835
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003836#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003837 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3838 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
3839 mbedtls_ssl_states_str(ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003840
Gilles Peskine449bd832023-01-11 14:50:10 +01003841 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003842 case MBEDTLS_SSL_HELLO_REQUEST:
3843 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003844 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003845 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003846
Ronald Cron9f0fba32022-02-10 16:45:15 +01003847 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003848 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003849 break;
3850
3851 default:
3852#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003853 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3854 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3855 } else {
3856 ret = mbedtls_ssl_handshake_client_step(ssl);
3857 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003858#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003859 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003860#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003861 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003862#endif
3863 }
Jerry Yub9930e72021-08-06 17:11:51 +08003864 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003865#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003866#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003867 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6f135e12021-12-08 16:57:54 +01003868#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003869 if (mbedtls_ssl_conf_is_tls13_only(ssl->conf)) {
3870 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
3871 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003872#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003873
3874#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003875 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf)) {
3876 ret = mbedtls_ssl_handshake_server_step(ssl);
3877 }
Jerry Yub9930e72021-08-06 17:11:51 +08003878#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3879 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003880#endif
3881
Gilles Peskine449bd832023-01-11 14:50:10 +01003882 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003883 /* handshake_step return error. And it is same
3884 * with alert_reason.
3885 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003886 if (ssl->send_alert) {
3887 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003888 goto cleanup;
3889 }
3890 }
3891
3892cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003893 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003894}
3895
3896/*
3897 * Perform the SSL handshake
3898 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003899int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003900{
3901 int ret = 0;
3902
Hanno Beckera817ea42020-10-20 15:20:23 +01003903 /* Sanity checks */
3904
Gilles Peskine449bd832023-01-11 14:50:10 +01003905 if (ssl == NULL || ssl->conf == NULL) {
3906 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3907 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003908
Hanno Beckera817ea42020-10-20 15:20:23 +01003909#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003910 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3911 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3912 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3913 "mbedtls_ssl_set_timer_cb() for DTLS"));
3914 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003915 }
3916#endif /* MBEDTLS_SSL_PROTO_DTLS */
3917
Gilles Peskine449bd832023-01-11 14:50:10 +01003918 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003919
Hanno Beckera817ea42020-10-20 15:20:23 +01003920 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003921 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3922 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003923
Gilles Peskine449bd832023-01-11 14:50:10 +01003924 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003925 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003926 }
Paul Bakker1961b702013-01-25 14:49:24 +01003927 }
3928
Gilles Peskine449bd832023-01-11 14:50:10 +01003929 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003930
Gilles Peskine449bd832023-01-11 14:50:10 +01003931 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003932}
3933
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003934#if defined(MBEDTLS_SSL_RENEGOTIATION)
3935#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003936/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003937 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003938 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003939MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003940static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003941{
Janos Follath865b3eb2019-12-16 11:46:15 +00003942 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003943
Gilles Peskine449bd832023-01-11 14:50:10 +01003944 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003945
3946 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003947 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3948 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003949
Gilles Peskine449bd832023-01-11 14:50:10 +01003950 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3951 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3952 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003953 }
3954
Gilles Peskine449bd832023-01-11 14:50:10 +01003955 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003956
Gilles Peskine449bd832023-01-11 14:50:10 +01003957 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003958}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003959#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003960
3961/*
3962 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003963 * - any side: calling mbedtls_ssl_renegotiate(),
3964 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3965 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003966 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003967 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003968 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003969 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003970int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003971{
Janos Follath865b3eb2019-12-16 11:46:15 +00003972 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003973
Gilles Peskine449bd832023-01-11 14:50:10 +01003974 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00003975
Gilles Peskine449bd832023-01-11 14:50:10 +01003976 if ((ret = ssl_handshake_init(ssl)) != 0) {
3977 return ret;
3978 }
Paul Bakker48916f92012-09-16 19:57:18 +00003979
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003980 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3981 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003982#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003983 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3984 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
3985 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003986 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003987 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003988 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003989 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003990 }
3991#endif
3992
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003993 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3994 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003995
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
3997 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
3998 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00003999 }
4000
Gilles Peskine449bd832023-01-11 14:50:10 +01004001 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004002
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004004}
4005
4006/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004007 * Renegotiate current connection on client,
4008 * or request renegotiation on server
4009 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004010int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004011{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004012 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004013
Gilles Peskine449bd832023-01-11 14:50:10 +01004014 if (ssl == NULL || ssl->conf == NULL) {
4015 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4016 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004017
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004018#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004019 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004020 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4021 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4022 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4023 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004025 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004026
4027 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 if (ssl->out_left != 0) {
4029 return mbedtls_ssl_flush_output(ssl);
4030 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004031
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004033 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004034#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004036#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004037 /*
4038 * On client, either start the renegotiation process or,
4039 * if already in progress, continue the handshake
4040 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004041 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4042 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4043 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004044 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004045
4046 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4047 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4048 return ret;
4049 }
4050 } else {
4051 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4052 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4053 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004054 }
4055 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004056#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004057
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004059}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004060#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004061
Gilles Peskine449bd832023-01-11 14:50:10 +01004062void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004063{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004064 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4065
Gilles Peskine449bd832023-01-11 14:50:10 +01004066 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004067 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004068 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004069
Brett Warrene0edc842021-08-17 09:53:13 +01004070#if defined(MBEDTLS_ECP_C)
4071#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 if (ssl->handshake->group_list_heap_allocated) {
4073 mbedtls_free((void *) handshake->group_list);
4074 }
Brett Warrene0edc842021-08-17 09:53:13 +01004075 handshake->group_list = NULL;
4076#endif /* MBEDTLS_DEPRECATED_REMOVED */
4077#endif /* MBEDTLS_ECP_C */
4078
Ronald Crone68ab4f2022-10-05 12:46:29 +02004079#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004080#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 if (ssl->handshake->sig_algs_heap_allocated) {
4082 mbedtls_free((void *) handshake->sig_algs);
4083 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004084 handshake->sig_algs = NULL;
4085#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004086#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004087 if (ssl->handshake->certificate_request_context) {
4088 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004089 }
4090#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004091#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004092
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004093#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004094 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4095 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004096 handshake->async_in_progress = 0;
4097 }
4098#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4099
Andrzej Kurek25f27152022-08-17 16:09:31 -04004100#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004101#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004102 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004103#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004104 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004105#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004106#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04004107#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004108#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004110#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004111 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004112#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004113#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004114
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004115#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004116 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004117#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02004118#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004120#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004121
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004122#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004123#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004125 /*
4126 * Opaque keys are not stored in the handshake's data and it's the user
4127 * responsibility to destroy them. Clear ones, instead, are created by
4128 * the TLS library and should be destroyed at the same level
4129 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004130 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4131 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004132 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004133 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4134#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004135 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004136#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004137#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004139 handshake->ecjpake_cache = NULL;
4140 handshake->ecjpake_cache_len = 0;
4141#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004142#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004143
Janos Follath4ae5c292016-02-10 11:27:43 +00004144#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4145 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004146 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004148#endif
4149
Ronald Cron73fe8df2022-10-05 14:31:43 +02004150#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004151#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004153 /* The maintenance of the external PSK key slot is the
4154 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 if (ssl->handshake->psk_opaque_is_internal) {
4156 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004157 ssl->handshake->psk_opaque_is_internal = 0;
4158 }
4159 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4160 }
Neil Armstronge952a302022-05-03 10:22:14 +02004161#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004162 if (handshake->psk != NULL) {
4163 mbedtls_platform_zeroize(handshake->psk, handshake->psk_len);
4164 mbedtls_free(handshake->psk);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004165 }
Neil Armstronge952a302022-05-03 10:22:14 +02004166#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004167#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004169#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4170 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004171 /*
4172 * Free only the linked list wrapper, not the keys themselves
4173 * since the belong to the SNI callback
4174 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004176#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004177
Gilles Peskineeccd8882020-03-10 12:19:08 +01004178#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4180 if (handshake->ecrs_peer_cert != NULL) {
4181 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4182 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004183 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004184#endif
4185
Hanno Becker75173122019-02-06 16:18:31 +00004186#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4187 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004188 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004189#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4190
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004191#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4193 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004194#endif /* MBEDTLS_SSL_CLI_C &&
4195 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004196
4197#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 mbedtls_ssl_flight_free(handshake->flight);
4199 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004200#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004201
Ronald Cronf12b81d2022-03-15 10:42:41 +01004202#if defined(MBEDTLS_ECDH_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 (defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4204 if (handshake->ecdh_psa_privkey_is_external == 0) {
4205 psa_destroy_key(handshake->ecdh_psa_privkey);
4206 }
Hanno Becker4a63ed42019-01-08 11:39:35 +00004207#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
4208
Ronald Cron6f135e12021-12-08 16:57:54 +01004209#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 mbedtls_ssl_transform_free(handshake->transform_handshake);
4211 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004212#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4214 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004215#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004216#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004217
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004218
4219#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4220 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4221 * processes datagrams and the fact that a datagram is allowed to have
4222 * several records in it, it is possible that the I/O buffers are not
4223 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004224 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4225 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004226#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004227
Jerry Yuba9c7272021-10-30 11:54:10 +08004228 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 mbedtls_platform_zeroize(handshake,
4230 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004231}
4232
Gilles Peskine449bd832023-01-11 14:50:10 +01004233void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004234{
Gilles Peskine449bd832023-01-11 14:50:10 +01004235 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004236 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004237 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004238
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004239#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004240 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004241#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004242
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004243#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004244#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4245 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004247#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004249#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004250
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004252}
4253
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004254#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004255
4256#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4257#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4258#else
4259#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4260#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4261
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004262#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004263
4264#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4265#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4266#else
4267#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4268#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4269
4270#if defined(MBEDTLS_SSL_ALPN)
4271#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4272#else
4273#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4274#endif /* MBEDTLS_SSL_ALPN */
4275
4276#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4277#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4278#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4279#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4280
4281#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 ((uint32_t) ( \
4283 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4284 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4285 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4286 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4287 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4288 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4289 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4290 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004291
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004292static unsigned char ssl_serialized_context_header[] = {
4293 MBEDTLS_VERSION_MAJOR,
4294 MBEDTLS_VERSION_MINOR,
4295 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4297 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4298 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4299 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4300 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004301};
4302
Paul Bakker5121ce52009-01-03 21:22:43 +00004303/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004304 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004305 *
4306 * The format of the serialized data is:
4307 * (in the presentation language of TLS, RFC 8446 section 3)
4308 *
4309 * // header
4310 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004311 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004312 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004313 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004314 * Note: When updating the format, remember to keep these
4315 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004316 *
4317 * // session sub-structure
4318 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4319 * // transform sub-structure
4320 * uint8 random[64]; // ServerHello.random+ClientHello.random
4321 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4322 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4323 * // fields from ssl_context
4324 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4325 * uint64 in_window_top; // DTLS: last validated record seq_num
4326 * uint64 in_window; // DTLS: bitmask for replay protection
4327 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4328 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4329 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4330 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4331 *
4332 * Note that many fields of the ssl_context or sub-structures are not
4333 * serialized, as they fall in one of the following categories:
4334 *
4335 * 1. forced value (eg in_left must be 0)
4336 * 2. pointer to dynamically-allocated memory (eg session, transform)
4337 * 3. value can be re-derived from other data (eg session keys from MS)
4338 * 4. value was temporary (eg content of input buffer)
4339 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004340 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004341int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4342 unsigned char *buf,
4343 size_t buf_len,
4344 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004345{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004346 unsigned char *p = buf;
4347 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004348 size_t session_len;
4349 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004350
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004351 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004352 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4353 * this function's documentation.
4354 *
4355 * These are due to assumptions/limitations in the implementation. Some of
4356 * them are likely to stay (no handshake in progress) some might go away
4357 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004358 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004359 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4361 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4362 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004363 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 if (ssl->handshake != NULL) {
4365 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4366 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004367 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004368 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 if (ssl->transform == NULL || ssl->session == NULL) {
4370 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4371 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004372 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004373 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 if (mbedtls_ssl_check_pending(ssl) != 0) {
4375 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4376 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004377 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 if (ssl->out_left != 0) {
4379 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4380 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004381 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004382 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4384 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4385 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004386 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004387 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4389 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4390 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004391 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004392 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4394 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4395 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004396 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004397 /* Renegotiation must not be enabled */
4398#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4400 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4401 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004402 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004403#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004404
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004405 /*
4406 * Version and format identifier
4407 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004409
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 if (used <= buf_len) {
4411 memcpy(p, ssl_serialized_context_header,
4412 sizeof(ssl_serialized_context_header));
4413 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004414 }
4415
4416 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004417 * Session (length + data)
4418 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4420 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4421 return ret;
4422 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004423
4424 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 if (used <= buf_len) {
4426 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004427 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004428
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 ret = ssl_session_save(ssl->session, 1,
4430 p, session_len, &session_len);
4431 if (ret != 0) {
4432 return ret;
4433 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004434
4435 p += session_len;
4436 }
4437
4438 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004439 * Transform
4440 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 used += sizeof(ssl->transform->randbytes);
4442 if (used <= buf_len) {
4443 memcpy(p, ssl->transform->randbytes,
4444 sizeof(ssl->transform->randbytes));
4445 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004446 }
4447
4448#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4449 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004451 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004453 p += ssl->transform->in_cid_len;
4454
4455 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004457 p += ssl->transform->out_cid_len;
4458 }
4459#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4460
4461 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004462 * Saved fields from top-level ssl_context structure
4463 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004464 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 if (used <= buf_len) {
4466 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004467 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004468 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004469
4470#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4471 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 if (used <= buf_len) {
4473 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004474 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004475
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004477 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004478 }
4479#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4480
4481#if defined(MBEDTLS_SSL_PROTO_DTLS)
4482 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004484 *p++ = ssl->disable_datagram_packing;
4485 }
4486#endif /* MBEDTLS_SSL_PROTO_DTLS */
4487
Jerry Yuae0b2e22021-10-08 15:21:19 +08004488 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 if (used <= buf_len) {
4490 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004491 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004492 }
4493
4494#if defined(MBEDTLS_SSL_PROTO_DTLS)
4495 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 if (used <= buf_len) {
4497 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004498 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004499 }
4500#endif /* MBEDTLS_SSL_PROTO_DTLS */
4501
4502#if defined(MBEDTLS_SSL_ALPN)
4503 {
4504 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004506 : 0;
4507
4508 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004510 *p++ = alpn_len;
4511
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 if (ssl->alpn_chosen != NULL) {
4513 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004514 p += alpn_len;
4515 }
4516 }
4517 }
4518#endif /* MBEDTLS_SSL_ALPN */
4519
4520 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004521 * Done
4522 */
4523 *olen = used;
4524
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 if (used > buf_len) {
4526 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4527 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004528
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004532}
4533
4534/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004535 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004536 *
4537 * This internal version is wrapped by a public function that cleans up in
4538 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004539 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004540MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004541static int ssl_context_load(mbedtls_ssl_context *ssl,
4542 const unsigned char *buf,
4543 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004544{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004545 const unsigned char *p = buf;
4546 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004547 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004548 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004549#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004550 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004551#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004552
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004553 /*
4554 * The context should have been freshly setup or reset.
4555 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004556 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004557 * renegotiating, or if the user mistakenly loaded a session first.)
4558 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4560 ssl->session != NULL) {
4561 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004562 }
4563
4564 /*
4565 * We can't check that the config matches the initial one, but we can at
4566 * least check it matches the requirements for serializing.
4567 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004569 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4570 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004571#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004572 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004573#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 0) {
4575 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004576 }
4577
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004579
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004580 /*
4581 * Check version identifier
4582 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4584 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004585 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004586
4587 if (memcmp(p, ssl_serialized_context_header,
4588 sizeof(ssl_serialized_context_header)) != 0) {
4589 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4590 }
4591 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004592
4593 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004594 * Session
4595 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 if ((size_t) (end - p) < 4) {
4597 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4598 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004599
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 session_len = ((size_t) p[0] << 24) |
4601 ((size_t) p[1] << 16) |
4602 ((size_t) p[2] << 8) |
4603 ((size_t) p[3]);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004604 p += 4;
4605
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004606 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004607 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004608 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004609 ssl->session_in = ssl->session;
4610 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004611 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004612
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 if ((size_t) (end - p) < session_len) {
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 ret = ssl_session_load(ssl->session, 1, p, session_len);
4618 if (ret != 0) {
4619 mbedtls_ssl_session_free(ssl->session);
4620 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004621 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004622
4623 p += session_len;
4624
4625 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004626 * Transform
4627 */
4628
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004629 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004630 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004631#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004632 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004633 ssl->transform_in = ssl->transform;
4634 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004635 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004636#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004637
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004638#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4640 if (prf_func == NULL) {
4641 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4642 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004643
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004644 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4646 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4647 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 ret = ssl_tls12_populate_transform(ssl->transform,
4650 ssl->session->ciphersuite,
4651 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004652#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004654#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 prf_func,
4656 p, /* currently pointing to randbytes */
4657 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4658 ssl->conf->endpoint,
4659 ssl);
4660 if (ret != 0) {
4661 return ret;
4662 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004663#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004665
4666#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4667 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 if ((size_t) (end - p) < 1) {
4669 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4670 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004671
4672 ssl->transform->in_cid_len = *p++;
4673
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4675 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4676 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004677
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004679 p += ssl->transform->in_cid_len;
4680
4681 ssl->transform->out_cid_len = *p++;
4682
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4684 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4685 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004688 p += ssl->transform->out_cid_len;
4689#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4690
4691 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004692 * Saved fields from top-level ssl_context structure
4693 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 if ((size_t) (end - p) < 4) {
4695 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4696 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004697
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 ssl->badmac_seen = ((uint32_t) p[0] << 24) |
4699 ((uint32_t) p[1] << 16) |
4700 ((uint32_t) p[2] << 8) |
4701 ((uint32_t) p[3]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004702 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004703
4704#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 if ((size_t) (end - p) < 16) {
4706 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4707 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004708
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 ssl->in_window_top = ((uint64_t) p[0] << 56) |
4710 ((uint64_t) p[1] << 48) |
4711 ((uint64_t) p[2] << 40) |
4712 ((uint64_t) p[3] << 32) |
4713 ((uint64_t) p[4] << 24) |
4714 ((uint64_t) p[5] << 16) |
4715 ((uint64_t) p[6] << 8) |
4716 ((uint64_t) p[7]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004717 p += 8;
4718
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 ssl->in_window = ((uint64_t) p[0] << 56) |
4720 ((uint64_t) p[1] << 48) |
4721 ((uint64_t) p[2] << 40) |
4722 ((uint64_t) p[3] << 32) |
4723 ((uint64_t) p[4] << 24) |
4724 ((uint64_t) p[5] << 16) |
4725 ((uint64_t) p[6] << 8) |
4726 ((uint64_t) p[7]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004727 p += 8;
4728#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4729
4730#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 if ((size_t) (end - p) < 1) {
4732 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4733 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004734
4735 ssl->disable_datagram_packing = *p++;
4736#endif /* MBEDTLS_SSL_PROTO_DTLS */
4737
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4739 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4740 }
4741 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4742 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004743
4744#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 if ((size_t) (end - p) < 2) {
4746 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4747 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004748
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004750 p += 2;
4751#endif /* MBEDTLS_SSL_PROTO_DTLS */
4752
4753#if defined(MBEDTLS_SSL_ALPN)
4754 {
4755 uint8_t alpn_len;
4756 const char **cur;
4757
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 if ((size_t) (end - p) < 1) {
4759 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4760 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004761
4762 alpn_len = *p++;
4763
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004765 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4767 if (strlen(*cur) == alpn_len &&
4768 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004769 ssl->alpn_chosen = *cur;
4770 break;
4771 }
4772 }
4773 }
4774
4775 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4777 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4778 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004779
4780 p += alpn_len;
4781 }
4782#endif /* MBEDTLS_SSL_ALPN */
4783
4784 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004785 * Forced fields from top-level ssl_context structure
4786 *
4787 * Most of them already set to the correct value by mbedtls_ssl_init() and
4788 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4789 */
4790 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004791 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004792
Hanno Becker361b10d2019-08-30 10:42:49 +01004793 /* Adjust pointers for header fields of outgoing records to
4794 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004796
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004797#if defined(MBEDTLS_SSL_PROTO_DTLS)
4798 ssl->in_epoch = 1;
4799#endif
4800
4801 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4802 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004803 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4804 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 if (ssl->handshake != NULL) {
4806 mbedtls_ssl_handshake_free(ssl);
4807 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004808 ssl->handshake = NULL;
4809 }
4810
4811 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004812 * Done - should have consumed entire buffer
4813 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 if (p != end) {
4815 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4816 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004817
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004819}
4820
4821/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004822 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004823 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004824int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4825 const unsigned char *buf,
4826 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004827{
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 if (ret != 0) {
4831 mbedtls_ssl_free(context);
4832 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004833
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004835}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004836#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004837
4838/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004839 * Free an SSL context
4840 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004841void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004842{
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004844 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004846
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004848
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004850#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4851 size_t out_buf_len = ssl->out_buf_len;
4852#else
4853 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4854#endif
4855
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 mbedtls_platform_zeroize(ssl->out_buf, out_buf_len);
4857 mbedtls_free(ssl->out_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004858 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004859 }
4860
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004862#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4863 size_t in_buf_len = ssl->in_buf_len;
4864#else
4865 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4866#endif
4867
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 mbedtls_platform_zeroize(ssl->in_buf, in_buf_len);
4869 mbedtls_free(ssl->in_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004870 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004871 }
4872
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 if (ssl->transform) {
4874 mbedtls_ssl_transform_free(ssl->transform);
4875 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004876 }
4877
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 if (ssl->handshake) {
4879 mbedtls_ssl_handshake_free(ssl);
4880 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004881
4882#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4884 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004885#endif
4886
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 mbedtls_ssl_session_free(ssl->session_negotiate);
4888 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004889 }
4890
Ronald Cron6f135e12021-12-08 16:57:54 +01004891#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 mbedtls_ssl_transform_free(ssl->transform_application);
4893 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004894#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 if (ssl->session) {
4897 mbedtls_ssl_session_free(ssl->session);
4898 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004899 }
4900
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004901#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 if (ssl->hostname != NULL) {
4903 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
4904 mbedtls_free(ssl->hostname);
Paul Bakker5121ce52009-01-03 21:22:43 +00004905 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004906#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004907
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004908#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004910#endif
4911
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004913
Paul Bakker86f04f42013-02-14 11:20:09 +01004914 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004916}
4917
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004918/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004919 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004920 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004921void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004922{
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004924}
4925
Gilles Peskineae270bf2021-06-02 00:05:29 +02004926/* The selection should be the same as mbedtls_x509_crt_profile_default in
4927 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004928 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004929 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004930 * about this list.
4931 */
Brett Warrene0edc842021-08-17 09:53:13 +01004932static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004933#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004934 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004935#endif
4936#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004937 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004938#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004939#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004940 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004941#endif
4942#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004943 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004944#endif
4945#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004946 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004947#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004948#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004949 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004950#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004951#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004952 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004953#endif
4954#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004955 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004956#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004957 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004958};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004959
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004960static int ssl_preset_suiteb_ciphersuites[] = {
4961 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4962 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4963 0
4964};
4965
Ronald Crone68ab4f2022-10-05 12:46:29 +02004966#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004967
Jerry Yu909df7b2022-01-22 11:56:27 +08004968/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004969 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004970 * rules SHOULD be upheld.
4971 * - No duplicate entries.
4972 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004973 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004974 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004975 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004976static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004977
Valerio Setti75fba322023-02-23 17:35:09 +01004978#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
4979 defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004980 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4981 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Valerio Setti75fba322023-02-23 17:35:09 +01004982#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 +08004983 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004984
Valerio Setti75fba322023-02-23 17:35:09 +01004985#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
4986 defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08004987 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4988 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Valerio Setti75fba322023-02-23 17:35:09 +01004989#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 +08004990 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4991
Valerio Setti75fba322023-02-23 17:35:09 +01004992#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
4993 defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004994 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4995 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Valerio Setti75fba322023-02-23 17:35:09 +01004996#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 +08004997 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004998
Gilles Peskine449bd832023-01-11 14:50:10 +01004999#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
5000 defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005001 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005002#endif \
5003 /* 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 +08005004
Gilles Peskine449bd832023-01-11 14:50:10 +01005005#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
5006 defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005007 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005008#endif \
5009 /* 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 +08005010
Gilles Peskine449bd832023-01-11 14:50:10 +01005011#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
5012 defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005013 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005014#endif \
5015 /* 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 +08005016
Andrzej Kurek25f27152022-08-17 16:09:31 -04005017#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 +08005018 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
5019#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
5020
Andrzej Kurek25f27152022-08-17 16:09:31 -04005021#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 +08005022 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
5023#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
5024
Andrzej Kurek25f27152022-08-17 16:09:31 -04005025#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 +08005026 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
5027#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
5028
Gabor Mezei15b95a62022-05-09 16:37:58 +02005029 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005030};
5031
5032/* NOTICE: see above */
5033#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5034static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005035#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Valerio Setti75fba322023-02-23 17:35:09 +01005036#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005038#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005039#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5040 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5041#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005042#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005044#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005045#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04005046#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Valerio Setti75fba322023-02-23 17:35:09 +01005047#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005049#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005050#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5051 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5052#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005053#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005055#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005056#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04005057#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Valerio Setti75fba322023-02-23 17:35:09 +01005058#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005060#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005061#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5062 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5063#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005064#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005066#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005067#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005068 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005069};
5070#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5071/* NOTICE: see above */
5072static uint16_t ssl_preset_suiteb_sig_algs[] = {
5073
Andrzej Kurek25f27152022-08-17 16:09:31 -04005074#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 +08005075 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5076 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005077#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08005078 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
5079
Andrzej Kurek25f27152022-08-17 16:09:31 -04005080#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 +08005081 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5082 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005083#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu53037892022-01-25 11:02:06 +08005084 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005085
Gilles Peskine449bd832023-01-11 14:50:10 +01005086#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
5087 defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu909df7b2022-01-22 11:56:27 +08005088 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005089#endif \
5090 /* 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 +08005091
Andrzej Kurek25f27152022-08-17 16:09:31 -04005092#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 +08005093 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005094#endif /* MBEDTLS_RSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu53037892022-01-25 11:02:06 +08005095
Gabor Mezei15b95a62022-05-09 16:37:58 +02005096 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005097};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005098
Jerry Yu909df7b2022-01-22 11:56:27 +08005099/* NOTICE: see above */
5100#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5101static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005102#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005103#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005105#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005106#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005108#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005109#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04005110#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005111#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005113#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005114#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005116#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005117#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005118 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005119};
Jerry Yu909df7b2022-01-22 11:56:27 +08005120#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5121
Ronald Crone68ab4f2022-10-05 12:46:29 +02005122#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005123
Brett Warrene0edc842021-08-17 09:53:13 +01005124static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01005125#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005126 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005127#endif
5128#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005129 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005130#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005131 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005132};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005133
Ronald Crone68ab4f2022-10-05 12:46:29 +02005134#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005135/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005136 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005137MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005138static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005139{
5140 size_t i, j;
5141 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005142
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5144 for (j = 0; j < i; j++) {
5145 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005146 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 }
5148 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5149 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5150 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005151 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005152 }
5153 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005155}
5156
Ronald Crone68ab4f2022-10-05 12:46:29 +02005157#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005158
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005159/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005160 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005161 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005162int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5163 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005164{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005165#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005166 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005167#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005168
Ronald Crone68ab4f2022-10-05 12:46:29 +02005169#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5171 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5172 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005173 }
5174
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5176 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5177 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005178 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005179
5180#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5182 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5183 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005184 }
5185
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5187 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5188 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005189 }
5190#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005191#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005192
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005193 /* Use the functions here so that they are covered in tests,
5194 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 mbedtls_ssl_conf_endpoint(conf, endpoint);
5196 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005197
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005198 /*
5199 * Things that are common to all presets
5200 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005201#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005203 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5204#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5205 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5206#endif
5207 }
5208#endif
5209
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005210#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5211 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5212#endif
5213
5214#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5215 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5216#endif
5217
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005218#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005219 conf->f_cookie_write = ssl_cookie_write_dummy;
5220 conf->f_cookie_check = ssl_cookie_check_dummy;
5221#endif
5222
5223#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5224 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5225#endif
5226
Janos Follath088ce432017-04-10 12:42:31 +01005227#if defined(MBEDTLS_SSL_SRV_C)
5228 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005229 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005230#endif
5231
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005232#if defined(MBEDTLS_SSL_PROTO_DTLS)
5233 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5234 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5235#endif
5236
5237#if defined(MBEDTLS_SSL_RENEGOTIATION)
5238 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 memset(conf->renego_period, 0x00, 2);
5240 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005241#endif
5242
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005243#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005245 const unsigned char dhm_p[] =
5246 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5247 const unsigned char dhm_g[] =
5248 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005249
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5251 dhm_p, sizeof(dhm_p),
5252 dhm_g, sizeof(dhm_g))) != 0) {
5253 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005254 }
5255 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005256#endif
5257
Ronald Cron6f135e12021-12-08 16:57:54 +01005258#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005259
5260#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 mbedtls_ssl_tls13_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005262#if defined(MBEDTLS_SSL_SRV_C)
5263 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005265#endif
5266#endif /* MBEDTLS_SSL_EARLY_DATA */
5267
Jerry Yud0766ec2022-09-22 10:46:57 +08005268#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005269 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005271#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005272 /*
5273 * Allow all TLS 1.3 key exchange modes by default.
5274 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005275 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005276#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005277
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005279#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005280 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005281 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005282#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005284#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005286#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005288 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5289 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Gilles Peskine449bd832023-01-11 14:50:10 +01005290 } else {
5291 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
XiaokangQian4d3a6042022-04-21 13:46:17 +00005292 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5293 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5294 }
5295#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5296 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5297 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5298#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5299 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5300 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5301#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005303#endif
5304 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005305
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005306 /*
5307 * Preset-specific defaults
5308 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005310 /*
5311 * NSA Suite B
5312 */
5313 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005314
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005315 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005316
5317#if defined(MBEDTLS_X509_CRT_PARSE_C)
5318 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005319#endif
5320
Ronald Crone68ab4f2022-10-05 12:46:29 +02005321#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005322#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005324 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005326#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005328#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005329
Brett Warrene0edc842021-08-17 09:53:13 +01005330#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5331 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005332#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005333 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005334 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005335
5336 /*
5337 * Default
5338 */
5339 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005340
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005341 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005342
5343#if defined(MBEDTLS_X509_CRT_PARSE_C)
5344 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5345#endif
5346
Ronald Crone68ab4f2022-10-05 12:46:29 +02005347#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005348#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005350 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005352#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005354#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005355
Brett Warrene0edc842021-08-17 09:53:13 +01005356#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5357 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005358#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005359 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005360
5361#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5362 conf->dhm_min_bitlen = 1024;
5363#endif
5364 }
5365
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005367}
5368
5369/*
5370 * Free mbedtls_ssl_config
5371 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005372void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005373{
5374#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 mbedtls_mpi_free(&conf->dhm_P);
5376 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005377#endif
5378
Ronald Cron73fe8df2022-10-05 14:31:43 +02005379#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005380#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005382 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5383 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005384#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 if (conf->psk != NULL) {
5386 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
5387 mbedtls_free(conf->psk);
Azim Khan27e8a122018-03-21 14:24:11 +00005388 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005389 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005390 }
5391
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 if (conf->psk_identity != NULL) {
5393 mbedtls_platform_zeroize(conf->psk_identity, conf->psk_identity_len);
5394 mbedtls_free(conf->psk_identity);
Azim Khan27e8a122018-03-21 14:24:11 +00005395 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005396 conf->psk_identity_len = 0;
5397 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005398#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005399
5400#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005402#endif
5403
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005405}
5406
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005407#if defined(MBEDTLS_PK_C) && \
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005408 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_CAN_ECDSA_SOME))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005409/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005410 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005411 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005412unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005413{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005414#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5416 return MBEDTLS_SSL_SIG_RSA;
5417 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005418#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005419#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5421 return MBEDTLS_SSL_SIG_ECDSA;
5422 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005423#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005425}
5426
Gilles Peskine449bd832023-01-11 14:50:10 +01005427unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005428{
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005430 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005432 case MBEDTLS_PK_ECDSA:
5433 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005435 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005437 }
5438}
5439
Gilles Peskine449bd832023-01-11 14:50:10 +01005440mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005441{
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005443#if defined(MBEDTLS_RSA_C)
5444 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005446#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005447#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005448 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005450#endif
5451 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005453 }
5454}
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005455#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_PK_CAN_ECDSA_SOME ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005456
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005457/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005458 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005459 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005460mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005461{
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 switch (hash) {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005463#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005464 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005466#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005467#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005468 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005470#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005471#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005472 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005474#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005475#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005476 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005478#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005479#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005480 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005482#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005483#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005484 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005486#endif
5487 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005489 }
5490}
5491
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005492/*
5493 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5494 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005495unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005496{
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 switch (md) {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005498#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005499 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005501#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005502#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005503 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005505#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005506#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005507 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005509#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005510#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005511 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005513#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005514#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005515 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005517#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005518#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005519 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005521#endif
5522 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005524 }
5525}
5526
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005527/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005528 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005529 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005530 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005531int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005532{
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005534
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 if (group_list == NULL) {
5536 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005537 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005538
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 for (; *group_list != 0; group_list++) {
5540 if (*group_list == tls_id) {
5541 return 0;
5542 }
5543 }
5544
5545 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005546}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005547
5548#if defined(MBEDTLS_ECP_C)
5549/*
5550 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5551 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005552int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005553{
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005555
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005557 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005559
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005561}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02005562#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005563
Gilles Peskine449bd832023-01-11 14:50:10 +01005564#if defined(MBEDTLS_DEBUG_C)
Valerio Setti67419f02023-01-04 16:12:42 +01005565#define EC_NAME(_name_) _name_
5566#else
5567#define EC_NAME(_name_) NULL
5568#endif
5569
Valerio Setti18c9fed2022-12-30 17:44:24 +01005570static const struct {
5571 uint16_t tls_id;
5572 mbedtls_ecp_group_id ecp_group_id;
5573 psa_ecc_family_t psa_family;
5574 uint16_t bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 const char *name;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005576} tls_id_match_table[] =
5577{
5578#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine449bd832023-01-11 14:50:10 +01005579 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521, EC_NAME("secp521r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005580#endif
5581#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512, EC_NAME("brainpoolP512r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005583#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005584#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384, EC_NAME("secp384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005586#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005587#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384, EC_NAME("brainpoolP384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005589#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005590#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256, EC_NAME("secp256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005592#endif
5593#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256, EC_NAME("secp256k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005595#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005596#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256, EC_NAME("brainpoolP256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005598#endif
5599#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224, EC_NAME("secp224r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005601#endif
5602#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224, EC_NAME("secp224k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005604#endif
5605#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192, EC_NAME("secp192r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005607#endif
5608#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192, EC_NAME("secp192k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005610#endif
5611#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255, EC_NAME("x25519") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005613#endif
5614#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448, EC_NAME("x448") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005616#endif
5617 { 0, MBEDTLS_ECP_DP_NONE, 0, 0, NULL },
5618};
5619
Gilles Peskine449bd832023-01-11 14:50:10 +01005620int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
5621 psa_ecc_family_t *family,
5622 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005623{
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5625 if (tls_id_match_table[i].tls_id == tls_id) {
5626 if (family != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005627 *family = tls_id_match_table[i].psa_family;
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 }
5629 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005630 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005632 return PSA_SUCCESS;
5633 }
5634 }
5635
5636 return PSA_ERROR_NOT_SUPPORTED;
5637}
5638
Gilles Peskine449bd832023-01-11 14:50:10 +01005639mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
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) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005643 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005645 }
5646
5647 return MBEDTLS_ECP_DP_NONE;
5648}
5649
Gilles Peskine449bd832023-01-11 14:50:10 +01005650uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005651{
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5653 i++) {
5654 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005655 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005657 }
5658
5659 return 0;
5660}
5661
Valerio Setti67419f02023-01-04 16:12:42 +01005662#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005663const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005664{
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5666 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005667 return tls_id_match_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005669 }
5670
5671 return NULL;
5672}
Valerio Setti67419f02023-01-04 16:12:42 +01005673#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005675#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005676int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5677 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5678 int cert_endpoint,
5679 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005680{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005681 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005682 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005683 const char *ext_oid;
5684 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005685
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005687 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005688 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005689 case MBEDTLS_KEY_EXCHANGE_RSA:
5690 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005691 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005692 break;
5693
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005694 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5695 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5696 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5697 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005698 break;
5699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005700 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5701 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005702 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005703 break;
5704
5705 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005706 case MBEDTLS_KEY_EXCHANGE_NONE:
5707 case MBEDTLS_KEY_EXCHANGE_PSK:
5708 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5709 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005710 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005711 usage = 0;
5712 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005713 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005714 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5715 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005716 }
5717
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005719 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005720 ret = -1;
5721 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005722
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005724 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5726 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005727 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005729 }
5730
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005732 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005733 ret = -1;
5734 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005735
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005737}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005738#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005739
Jerry Yu148165c2021-09-24 23:20:59 +08005740#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005741int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5742 const mbedtls_md_type_t md,
5743 unsigned char *dst,
5744 size_t dst_len,
5745 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005746{
Ronald Cronf6893e12022-01-07 22:09:01 +01005747 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5748 psa_hash_operation_t *hash_operation_to_clone;
5749 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5750
Jerry Yu148165c2021-09-24 23:20:59 +08005751 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005752
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 switch (md) {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005754#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 case MBEDTLS_MD_SHA384:
5756 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5757 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005758#endif
5759
Andrzej Kurek25f27152022-08-17 16:09:31 -04005760#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 case MBEDTLS_MD_SHA256:
5762 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5763 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005764#endif
5765
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 default:
5767 goto exit;
5768 }
5769
5770 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5771 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005772 goto exit;
5773 }
5774
Gilles Peskine449bd832023-01-11 14:50:10 +01005775 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5776 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005777 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005778 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005779
5780exit:
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005781#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
5782 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
5783 (void) ssl;
5784#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005785 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005786}
5787#else /* MBEDTLS_USE_PSA_CRYPTO */
5788
Andrzej Kurek25f27152022-08-17 16:09:31 -04005789#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005790MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005791static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5792 unsigned char *dst,
5793 size_t dst_len,
5794 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005795{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005796 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005797 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005798
Gilles Peskine449bd832023-01-11 14:50:10 +01005799 if (dst_len < 48) {
5800 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5801 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005802
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005803 mbedtls_md_init(&sha384);
5804 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005805 if (ret != 0) {
5806 goto exit;
5807 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005808 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005809 if (ret != 0) {
5810 goto exit;
5811 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005812
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005813 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005814 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005815 goto exit;
5816 }
5817
5818 *olen = 48;
5819
5820exit:
5821
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005822 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005824}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005825#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005826
Andrzej Kurek25f27152022-08-17 16:09:31 -04005827#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005828MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005829static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5830 unsigned char *dst,
5831 size_t dst_len,
5832 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005833{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005834 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005835 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005836
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 if (dst_len < 32) {
5838 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5839 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005840
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005841 mbedtls_md_init(&sha256);
5842 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5843 if (ret != 0) {
5844 goto exit;
5845 }
5846 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5847 if (ret != 0) {
5848 goto exit;
5849 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005850
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005851 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5852 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005853 goto exit;
5854 }
5855
5856 *olen = 32;
5857
5858exit:
5859
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005860 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005861 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005862}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005863#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005864
Gilles Peskine449bd832023-01-11 14:50:10 +01005865int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5866 const mbedtls_md_type_t md,
5867 unsigned char *dst,
5868 size_t dst_len,
5869 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005870{
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005872
Andrzej Kurek25f27152022-08-17 16:09:31 -04005873#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 case MBEDTLS_MD_SHA384:
5875 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005876#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005877
Andrzej Kurek25f27152022-08-17 16:09:31 -04005878#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 case MBEDTLS_MD_SHA256:
5880 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005881#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005882
Gilles Peskine449bd832023-01-11 14:50:10 +01005883 default:
Andrzej Kurek409248a2022-10-24 10:33:21 -04005884#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
5886 (void) ssl;
5887 (void) dst;
5888 (void) dst_len;
5889 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005890#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005892 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005894}
XiaokangQian647719a2021-12-07 09:16:29 +00005895
Jerry Yu148165c2021-09-24 23:20:59 +08005896#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005897
Ronald Crone68ab4f2022-10-05 12:46:29 +02005898#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005899/* mbedtls_ssl_parse_sig_alg_ext()
5900 *
5901 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5902 * value (TLS 1.3 RFC8446):
5903 * enum {
5904 * ....
5905 * ecdsa_secp256r1_sha256( 0x0403 ),
5906 * ecdsa_secp384r1_sha384( 0x0503 ),
5907 * ecdsa_secp521r1_sha512( 0x0603 ),
5908 * ....
5909 * } SignatureScheme;
5910 *
5911 * struct {
5912 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5913 * } SignatureSchemeList;
5914 *
5915 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5916 * value (TLS 1.2 RFC5246):
5917 * enum {
5918 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5919 * sha512(6), (255)
5920 * } HashAlgorithm;
5921 *
5922 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5923 * SignatureAlgorithm;
5924 *
5925 * struct {
5926 * HashAlgorithm hash;
5927 * SignatureAlgorithm signature;
5928 * } SignatureAndHashAlgorithm;
5929 *
5930 * SignatureAndHashAlgorithm
5931 * supported_signature_algorithms<2..2^16-2>;
5932 *
5933 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5934 * generalization of the TLS 1.2 signature algorithm extension.
5935 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5936 * `SignatureScheme` field of TLS 1.3
5937 *
5938 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005939int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5940 const unsigned char *buf,
5941 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005942{
5943 const unsigned char *p = buf;
5944 size_t supported_sig_algs_len = 0;
5945 const unsigned char *supported_sig_algs_end;
5946 uint16_t sig_alg;
5947 uint32_t common_idx = 0;
5948
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5950 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005951 p += 2;
5952
Gilles Peskine449bd832023-01-11 14:50:10 +01005953 memset(ssl->handshake->received_sig_algs, 0,
5954 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005955
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005957 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 while (p < supported_sig_algs_end) {
5959 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5960 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005961 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5963 sig_alg,
5964 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005965#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5967 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5968 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005969 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005970 }
5971#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005972
Gilles Peskine449bd832023-01-11 14:50:10 +01005973 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5974 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005975
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005977 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5978 common_idx += 1;
5979 }
5980 }
5981 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 if (p != end) {
5983 MBEDTLS_SSL_DEBUG_MSG(1,
5984 ("Signature algorithms extension length misaligned"));
5985 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5986 MBEDTLS_ERR_SSL_DECODE_ERROR);
5987 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02005988 }
5989
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 if (common_idx == 0) {
5991 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
5992 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5993 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
5994 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005995 }
5996
Gabor Mezei15b95a62022-05-09 16:37:58 +02005997 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02005999}
6000
Ronald Crone68ab4f2022-10-05 12:46:29 +02006001#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006002
Jerry Yudc7bd172022-02-17 13:44:15 +08006003#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6004
6005#if defined(MBEDTLS_USE_PSA_CRYPTO)
6006
Gilles Peskine449bd832023-01-11 14:50:10 +01006007static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6008 mbedtls_svc_key_id_t key,
6009 psa_algorithm_t alg,
6010 const unsigned char *raw_psk, size_t raw_psk_length,
6011 const unsigned char *seed, size_t seed_length,
6012 const unsigned char *label, size_t label_length,
6013 const unsigned char *other_secret,
6014 size_t other_secret_length,
6015 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006016{
6017 psa_status_t status;
6018
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 status = psa_key_derivation_setup(derivation, alg);
6020 if (status != PSA_SUCCESS) {
6021 return status;
6022 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006023
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6025 status = psa_key_derivation_input_bytes(derivation,
6026 PSA_KEY_DERIVATION_INPUT_SEED,
6027 seed, seed_length);
6028 if (status != PSA_SUCCESS) {
6029 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006030 }
6031
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 if (other_secret != NULL) {
6033 status = psa_key_derivation_input_bytes(derivation,
6034 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6035 other_secret, other_secret_length);
6036 if (status != PSA_SUCCESS) {
6037 return status;
6038 }
6039 }
6040
6041 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006042 status = psa_key_derivation_input_bytes(
6043 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 raw_psk, raw_psk_length);
6045 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006046 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006048 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 if (status != PSA_SUCCESS) {
6050 return status;
6051 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006052
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 status = psa_key_derivation_input_bytes(derivation,
6054 PSA_KEY_DERIVATION_INPUT_LABEL,
6055 label, label_length);
6056 if (status != PSA_SUCCESS) {
6057 return status;
6058 }
6059 } else {
6060 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006061 }
6062
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 status = psa_key_derivation_set_capacity(derivation, capacity);
6064 if (status != PSA_SUCCESS) {
6065 return status;
6066 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006067
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006069}
6070
Andrzej Kurek57d10632022-10-24 10:32:01 -04006071#if defined(PSA_WANT_ALG_SHA_384) || \
6072 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006073MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006074static int tls_prf_generic(mbedtls_md_type_t md_type,
6075 const unsigned char *secret, size_t slen,
6076 const char *label,
6077 const unsigned char *random, size_t rlen,
6078 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006079{
6080 psa_status_t status;
6081 psa_algorithm_t alg;
6082 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6083 psa_key_derivation_operation_t derivation =
6084 PSA_KEY_DERIVATION_OPERATION_INIT;
6085
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006087 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006089 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006091
6092 /* Normally a "secret" should be long enough to be impossible to
6093 * find by brute force, and in particular should not be empty. But
6094 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6095 * and for this use case it makes sense to have a 0-length "secret".
6096 * Since the key API doesn't allow importing a key of length 0,
6097 * keep master_key=0, which setup_psa_key_derivation() understands
6098 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006100 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6102 psa_set_key_algorithm(&key_attributes, alg);
6103 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006104
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6106 if (status != PSA_SUCCESS) {
6107 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6108 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006109 }
6110
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 status = setup_psa_key_derivation(&derivation,
6112 master_key, alg,
6113 NULL, 0,
6114 random, rlen,
6115 (unsigned char const *) label,
6116 (size_t) strlen(label),
6117 NULL, 0,
6118 dlen);
6119 if (status != PSA_SUCCESS) {
6120 psa_key_derivation_abort(&derivation);
6121 psa_destroy_key(master_key);
6122 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006123 }
6124
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6126 if (status != PSA_SUCCESS) {
6127 psa_key_derivation_abort(&derivation);
6128 psa_destroy_key(master_key);
6129 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006130 }
6131
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 status = psa_key_derivation_abort(&derivation);
6133 if (status != PSA_SUCCESS) {
6134 psa_destroy_key(master_key);
6135 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006136 }
6137
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 if (!mbedtls_svc_key_id_is_null(master_key)) {
6139 status = psa_destroy_key(master_key);
6140 }
6141 if (status != PSA_SUCCESS) {
6142 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6143 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006144
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006146}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006147#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006148#else /* MBEDTLS_USE_PSA_CRYPTO */
6149
Andrzej Kurek57d10632022-10-24 10:32:01 -04006150#if defined(MBEDTLS_MD_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 (defined(MBEDTLS_SHA256_C) || \
6152 defined(MBEDTLS_SHA384_C))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006153MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006154static int tls_prf_generic(mbedtls_md_type_t md_type,
6155 const unsigned char *secret, size_t slen,
6156 const char *label,
6157 const unsigned char *random, size_t rlen,
6158 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006159{
6160 size_t nb;
6161 size_t i, j, k, md_len;
6162 unsigned char *tmp;
6163 size_t tmp_len = 0;
6164 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6165 const mbedtls_md_info_t *md_info;
6166 mbedtls_md_context_t md_ctx;
6167 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6168
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006170
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6172 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6173 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006174
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006176
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 tmp_len = md_len + strlen(label) + rlen;
6178 tmp = mbedtls_calloc(1, tmp_len);
6179 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006180 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6181 goto exit;
6182 }
6183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 nb = strlen(label);
6185 memcpy(tmp + md_len, label, nb);
6186 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006187 nb += rlen;
6188
6189 /*
6190 * Compute P_<hash>(secret, label + random)[0..dlen]
6191 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006193 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006195
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6197 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006198 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 }
6200 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6201 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006202 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 }
6204 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6205 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006206 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006208
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 for (i = 0; i < dlen; i += md_len) {
6210 ret = mbedtls_md_hmac_reset(&md_ctx);
6211 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006212 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 }
6214 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6215 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006216 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 }
6218 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6219 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006220 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006221 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006222
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 ret = mbedtls_md_hmac_reset(&md_ctx);
6224 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006225 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 }
6227 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
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_finish(&md_ctx, tmp);
6232 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006233 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006235
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006237
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006239 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006241 }
6242
6243exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006245
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 if (tmp != NULL) {
6247 mbedtls_platform_zeroize(tmp, tmp_len);
6248 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006249
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006251
Gilles Peskine449bd832023-01-11 14:50:10 +01006252 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006253
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006255}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006256#endif /* MBEDTLS_MD_C && ( MBEDTLS_SHA256_C || MBEDTLS_SHA384_C ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006257#endif /* MBEDTLS_USE_PSA_CRYPTO */
6258
Andrzej Kurek25f27152022-08-17 16:09:31 -04006259#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006260MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006261static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6262 const char *label,
6263 const unsigned char *random, size_t rlen,
6264 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006265{
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6267 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006268}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04006269#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006270
Andrzej Kurek25f27152022-08-17 16:09:31 -04006271#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006272MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006273static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6274 const char *label,
6275 const unsigned char *random, size_t rlen,
6276 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006277{
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6279 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006280}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04006281#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006282
Jerry Yuf009d862022-02-17 14:01:37 +08006283/*
6284 * Set appropriate PRF function and other SSL / TLS1.2 functions
6285 *
6286 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006287 * - hash associated with the ciphersuite (only used by TLS 1.2)
6288 *
6289 * Outputs:
6290 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6291 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006292MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006293static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6294 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006295{
Andrzej Kurek25f27152022-08-17 16:09:31 -04006296#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006298 handshake->tls_prf = tls_prf_sha384;
6299 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6300 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006302#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04006303#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuf009d862022-02-17 14:01:37 +08006304 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006305 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006306 handshake->tls_prf = tls_prf_sha256;
6307 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6308 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6309 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006310#else
Jerry Yuf009d862022-02-17 14:01:37 +08006311 {
Jerry Yuf009d862022-02-17 14:01:37 +08006312 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006313 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006314 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006315 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006316#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006317
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006319}
Jerry Yud6ab2352022-02-17 14:03:43 +08006320
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006321/*
6322 * Compute master secret if needed
6323 *
6324 * Parameters:
6325 * [in/out] handshake
6326 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6327 * (PSA-PSK) ciphersuite_info, psk_opaque
6328 * [out] premaster (cleared)
6329 * [out] master
6330 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6331 * debug: conf->f_dbg, conf->p_dbg
6332 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006333 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006334 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006335MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006336static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6337 unsigned char *master,
6338 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006339{
6340 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6341
6342 /* cf. RFC 5246, Section 8.1:
6343 * "The master secret is always exactly 48 bytes in length." */
6344 size_t const master_secret_len = 48;
6345
6346#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6347 unsigned char session_hash[48];
6348#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6349
6350 /* The label for the KDF used for key expansion.
6351 * This is either "master secret" or "extended master secret"
6352 * depending on whether the Extended Master Secret extension
6353 * is used. */
6354 char const *lbl = "master secret";
6355
Przemek Stekielae4ed302022-04-05 17:15:55 +02006356 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006357 * - If the Extended Master Secret extension is not used,
6358 * this is ClientHello.Random + ServerHello.Random
6359 * (see Sect. 8.1 in RFC 5246).
6360 * - If the Extended Master Secret extension is used,
6361 * this is the transcript of the handshake so far.
6362 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006363 unsigned char const *seed = handshake->randbytes;
6364 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006365
6366#if !defined(MBEDTLS_DEBUG_C) && \
6367 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6368 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006369 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006370 ssl = NULL; /* make sure we don't use it except for those cases */
6371 (void) ssl;
6372#endif
6373
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 if (handshake->resume != 0) {
6375 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6376 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006377 }
6378
6379#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006381 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006382 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006383 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6384 if (ret != 0) {
6385 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6386 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006387
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6389 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006390 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006391#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006392
Przemek Stekiel99114f32022-04-22 11:20:09 +02006393#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006394 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006395 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006396 /* Perform PSK-to-MS expansion in a single step. */
6397 psa_status_t status;
6398 psa_algorithm_t alg;
6399 mbedtls_svc_key_id_t psk;
6400 psa_key_derivation_operation_t derivation =
6401 PSA_KEY_DERIVATION_OPERATION_INIT;
6402 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6403
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006405
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006407
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006409 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006411 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006413
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006414 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006416
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006418 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006419 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006420 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006421 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006422 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006423 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006424 other_secret_len = 48;
6425 other_secret = handshake->premaster + 2;
6426 break;
6427 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006428 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006429 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6430 other_secret = handshake->premaster + 2;
6431 break;
6432 default:
6433 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006434 }
6435
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 status = setup_psa_key_derivation(&derivation, psk, alg,
6437 ssl->conf->psk, ssl->conf->psk_len,
6438 seed, seed_len,
6439 (unsigned char const *) lbl,
6440 (size_t) strlen(lbl),
6441 other_secret, other_secret_len,
6442 master_secret_len);
6443 if (status != PSA_SUCCESS) {
6444 psa_key_derivation_abort(&derivation);
6445 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006446 }
6447
Gilles Peskine449bd832023-01-11 14:50:10 +01006448 status = psa_key_derivation_output_bytes(&derivation,
6449 master,
6450 master_secret_len);
6451 if (status != PSA_SUCCESS) {
6452 psa_key_derivation_abort(&derivation);
6453 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006454 }
6455
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 status = psa_key_derivation_abort(&derivation);
6457 if (status != PSA_SUCCESS) {
6458 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6459 }
6460 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006461#endif
6462 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006463#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006464 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6465 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006466 psa_status_t status;
6467 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6468 psa_key_derivation_operation_t derivation =
6469 PSA_KEY_DERIVATION_OPERATION_INIT;
6470
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006472
6473 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6474
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 status = psa_key_derivation_setup(&derivation, alg);
6476 if (status != PSA_SUCCESS) {
6477 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006478 }
6479
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 status = psa_key_derivation_set_capacity(&derivation,
6481 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6482 if (status != PSA_SUCCESS) {
6483 psa_key_derivation_abort(&derivation);
6484 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006485 }
6486
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6488 &derivation);
6489 if (status != PSA_SUCCESS) {
6490 psa_key_derivation_abort(&derivation);
6491 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006492 }
6493
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 status = psa_key_derivation_output_bytes(&derivation,
6495 handshake->premaster,
6496 handshake->pmslen);
6497 if (status != PSA_SUCCESS) {
6498 psa_key_derivation_abort(&derivation);
6499 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6500 }
6501
6502 status = psa_key_derivation_abort(&derivation);
6503 if (status != PSA_SUCCESS) {
6504 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006505 }
6506 }
6507#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6509 lbl, seed, seed_len,
6510 master,
6511 master_secret_len);
6512 if (ret != 0) {
6513 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6514 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006515 }
6516
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6518 handshake->premaster,
6519 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006520
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 mbedtls_platform_zeroize(handshake->premaster,
6522 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006523 }
6524
Gilles Peskine449bd832023-01-11 14:50:10 +01006525 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006526}
6527
Gilles Peskine449bd832023-01-11 14:50:10 +01006528int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006529{
6530 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6531 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6532 ssl->handshake->ciphersuite_info;
6533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006535
6536 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 ret = ssl_set_handshake_prfs(ssl->handshake,
6538 ciphersuite_info->mac);
6539 if (ret != 0) {
6540 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6541 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006542 }
6543
6544 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 ret = ssl_compute_master(ssl->handshake,
6546 ssl->session_negotiate->master,
6547 ssl);
6548 if (ret != 0) {
6549 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6550 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006551 }
6552
6553 /* Swap the client and server random values:
6554 * - MS derivation wanted client+server (RFC 5246 8.1)
6555 * - key derivation wants server+client (RFC 5246 6.3) */
6556 {
6557 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 memcpy(tmp, ssl->handshake->randbytes, 64);
6559 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6560 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6561 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006562 }
6563
6564 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6566 ssl->session_negotiate->ciphersuite,
6567 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006568#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006569 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006570#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 ssl->handshake->tls_prf,
6572 ssl->handshake->randbytes,
6573 ssl->tls_version,
6574 ssl->conf->endpoint,
6575 ssl);
6576 if (ret != 0) {
6577 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6578 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006579 }
6580
6581 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6583 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006584
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006586
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006588}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006589
Gilles Peskine449bd832023-01-11 14:50:10 +01006590int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006591{
Gilles Peskine449bd832023-01-11 14:50:10 +01006592 switch (md) {
Andrzej Kurek25f27152022-08-17 16:09:31 -04006593#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006594 case MBEDTLS_SSL_HASH_SHA384:
6595 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6596 break;
6597#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04006598#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006599 case MBEDTLS_SSL_HASH_SHA256:
6600 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6601 break;
6602#endif
6603 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006605 }
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006606#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
6607 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
6608 (void) ssl;
6609#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006611}
6612
Andrzej Kurek25f27152022-08-17 16:09:31 -04006613#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006614int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6615 unsigned char *hash,
6616 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006617{
6618#if defined(MBEDTLS_USE_PSA_CRYPTO)
6619 size_t hash_size;
6620 psa_status_t status;
6621 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
6622
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify sha256"));
6624 status = psa_hash_clone(&ssl->handshake->fin_sha256_psa, &sha256_psa);
6625 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006626 goto exit;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006627 }
6628
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 status = psa_hash_finish(&sha256_psa, hash, 32, &hash_size);
6630 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006631 goto exit;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006632 }
6633
6634 *hlen = 32;
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6636 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006637
6638exit:
6639 psa_hash_abort(&sha256_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05006640 return PSA_TO_MD_ERR(status);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006641#else
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006642 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006643 mbedtls_md_context_t sha256;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006644
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006645 mbedtls_md_init(&sha256);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006646
Gilles Peskine449bd832023-01-11 14:50:10 +01006647 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify sha256"));
Jerry Yu8392e0d2022-02-17 14:10:24 +08006648
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006649 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6650 if (ret != 0) {
6651 goto exit;
6652 }
6653 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6654 if (ret != 0) {
6655 goto exit;
6656 }
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006657
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006658 ret = mbedtls_md_finish(&sha256, hash);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006659 if (ret != 0) {
6660 goto exit;
6661 }
Jerry Yu8392e0d2022-02-17 14:10:24 +08006662
6663 *hlen = 32;
6664
Gilles Peskine449bd832023-01-11 14:50:10 +01006665 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6666 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
Jerry Yu8392e0d2022-02-17 14:10:24 +08006667
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006668exit:
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006669 mbedtls_md_free(&sha256);
Manuel Pégourié-Gonnard8e176f72023-02-09 10:33:54 +01006670 return ret;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006671#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006672}
Andrzej Kurek25f27152022-08-17 16:09:31 -04006673#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006674
Andrzej Kurek25f27152022-08-17 16:09:31 -04006675#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006676int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6677 unsigned char *hash,
6678 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006679{
6680#if defined(MBEDTLS_USE_PSA_CRYPTO)
6681 size_t hash_size;
6682 psa_status_t status;
6683 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
6684
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify sha384"));
6686 status = psa_hash_clone(&ssl->handshake->fin_sha384_psa, &sha384_psa);
6687 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006688 goto exit;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006689 }
6690
Gilles Peskine449bd832023-01-11 14:50:10 +01006691 status = psa_hash_finish(&sha384_psa, hash, 48, &hash_size);
6692 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006693 goto exit;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006694 }
6695
6696 *hlen = 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006697 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6698 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006699
6700exit:
6701 psa_hash_abort(&sha384_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05006702 return PSA_TO_MD_ERR(status);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006703#else
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006704 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006705 mbedtls_md_context_t sha384;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006706
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006707 mbedtls_md_init(&sha384);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006708
Gilles Peskine449bd832023-01-11 14:50:10 +01006709 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify sha384"));
Jerry Yuc1cb3842022-02-17 14:13:48 +08006710
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006711 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006712 if (ret != 0) {
6713 goto exit;
6714 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006715 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006716 if (ret != 0) {
6717 goto exit;
6718 }
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006719
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006720 ret = mbedtls_md_finish(&sha384, hash);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006721 if (ret != 0) {
6722 goto exit;
6723 }
Jerry Yuc1cb3842022-02-17 14:13:48 +08006724
6725 *hlen = 48;
6726
Gilles Peskine449bd832023-01-11 14:50:10 +01006727 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6728 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
Jerry Yuc1cb3842022-02-17 14:13:48 +08006729
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006730exit:
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006731 mbedtls_md_free(&sha384);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006732 return ret;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006733#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006734}
Andrzej Kurek25f27152022-08-17 16:09:31 -04006735#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006736
Neil Armstrong80f6f322022-05-03 17:56:38 +02006737#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6738 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006739int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006740{
6741 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006742 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006743 const unsigned char *psk = NULL;
6744 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006745 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006746
Gilles Peskine449bd832023-01-11 14:50:10 +01006747 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006748 /*
6749 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006750 * checked before calling this function.
6751 *
6752 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006753 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006754 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006755 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6756 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6757 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006758 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006759 }
6760
6761 /*
6762 * PMS = struct {
6763 * opaque other_secret<0..2^16-1>;
6764 * opaque psk<0..2^16-1>;
6765 * };
6766 * with "other_secret" depending on the particular key exchange
6767 */
6768#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6770 if (end - p < 2) {
6771 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6772 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006773
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006775 p += 2;
6776
Gilles Peskine449bd832023-01-11 14:50:10 +01006777 if (end < p || (size_t) (end - p) < psk_len) {
6778 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6779 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006780
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006782 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006784#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6785#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006786 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006787 /*
6788 * other_secret already set by the ClientKeyExchange message,
6789 * and is 48 bytes long
6790 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 if (end - p < 2) {
6792 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6793 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006794
6795 *p++ = 0;
6796 *p++ = 48;
6797 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006798 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006799#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6800#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006802 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6803 size_t len;
6804
6805 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6807 p + 2, end - (p + 2), &len,
6808 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6809 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6810 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006811 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006812 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006813 p += 2 + len;
6814
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6816 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006817#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006818#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006820 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6821 size_t zlen;
6822
Gilles Peskine449bd832023-01-11 14:50:10 +01006823 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6824 p + 2, end - (p + 2),
6825 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6826 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6827 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006828 }
6829
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006831 p += 2 + zlen;
6832
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6834 MBEDTLS_DEBUG_ECDH_Z);
6835 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006836#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006837 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6839 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006840 }
6841
6842 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 if (end - p < 2) {
6844 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6845 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006846
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006848 p += 2;
6849
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 if (end < p || (size_t) (end - p) < psk_len) {
6851 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6852 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006853
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006855 p += psk_len;
6856
6857 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6858
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006860}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006861#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006862
6863#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006864MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006865static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006866
6867#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006868int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006869{
6870 /* If renegotiation is not enforced, retransmit until we would reach max
6871 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006873 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6874 unsigned char doublings = 1;
6875
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006877 ++doublings;
6878 ratio >>= 1;
6879 }
6880
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 if (++ssl->renego_records_seen > doublings) {
6882 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6883 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006884 }
6885 }
6886
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006888}
6889#endif
6890#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006891
Jerry Yud9526692022-02-17 14:23:47 +08006892/*
6893 * Handshake functions
6894 */
6895#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6896/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006897int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006898{
6899 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6900 ssl->handshake->ciphersuite_info;
6901
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006903
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6905 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006906 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006908 }
6909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6911 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006912}
6913
Gilles Peskine449bd832023-01-11 14:50:10 +01006914int mbedtls_ssl_parse_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, ("=> parse 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 parse 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
6931#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6932/* Some certificate support -> implement write and parse */
6933
Gilles Peskine449bd832023-01-11 14:50:10 +01006934int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006935{
6936 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6937 size_t i, n;
6938 const mbedtls_x509_crt *crt;
6939 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6940 ssl->handshake->ciphersuite_info;
6941
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006943
Gilles Peskine449bd832023-01-11 14:50:10 +01006944 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6945 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006946 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006947 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006948 }
6949
6950#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6952 if (ssl->handshake->client_auth == 0) {
6953 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006954 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006956 }
6957 }
6958#endif /* MBEDTLS_SSL_CLI_C */
6959#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6961 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006962 /* Should never happen because we shouldn't have picked the
6963 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006965 }
6966 }
6967#endif
6968
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006970
6971 /*
6972 * 0 . 0 handshake type
6973 * 1 . 3 handshake length
6974 * 4 . 6 length of all certs
6975 * 7 . 9 length of cert. 1
6976 * 10 . n-1 peer certificate
6977 * n . n+2 length of cert. 2
6978 * n+3 . ... upper level cert, etc.
6979 */
6980 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006981 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006982
Gilles Peskine449bd832023-01-11 14:50:10 +01006983 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006984 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006985 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6986 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6987 " > %" MBEDTLS_PRINTF_SIZET,
6988 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6989 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006990 }
6991
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6993 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6994 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006995
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006997 i += n; crt = crt->next;
6998 }
6999
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7001 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7002 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007003
7004 ssl->out_msglen = i;
7005 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7006 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7007
7008 ssl->state++;
7009
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7011 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7012 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007013 }
7014
Gilles Peskine449bd832023-01-11 14:50:10 +01007015 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007016
Gilles Peskine449bd832023-01-11 14:50:10 +01007017 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007018}
7019
7020#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7021
7022#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007023MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007024static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7025 unsigned char *crt_buf,
7026 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007027{
7028 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7029
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 if (peer_crt == NULL) {
7031 return -1;
7032 }
Jerry Yud9526692022-02-17 14:23:47 +08007033
Gilles Peskine449bd832023-01-11 14:50:10 +01007034 if (peer_crt->raw.len != crt_buf_len) {
7035 return -1;
7036 }
Jerry Yud9526692022-02-17 14:23:47 +08007037
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007039}
7040#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007041MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007042static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7043 unsigned char *crt_buf,
7044 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007045{
7046 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7047 unsigned char const * const peer_cert_digest =
7048 ssl->session->peer_cert_digest;
7049 mbedtls_md_type_t const peer_cert_digest_type =
7050 ssl->session->peer_cert_digest_type;
7051 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007053 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7054 size_t digest_len;
7055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 if (peer_cert_digest == NULL || digest_info == NULL) {
7057 return -1;
7058 }
Jerry Yud9526692022-02-17 14:23:47 +08007059
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 digest_len = mbedtls_md_get_size(digest_info);
7061 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7062 return -1;
7063 }
Jerry Yud9526692022-02-17 14:23:47 +08007064
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7066 if (ret != 0) {
7067 return -1;
7068 }
Jerry Yud9526692022-02-17 14:23:47 +08007069
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007071}
7072#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7073#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7074
7075/*
7076 * Once the certificate message is read, parse it into a cert chain and
7077 * perform basic checks, but leave actual verification to the caller
7078 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007079MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007080static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7081 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007082{
7083 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7084#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007086#endif
7087 size_t i, n;
7088 uint8_t alert;
7089
Gilles Peskine449bd832023-01-11 14:50:10 +01007090 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7091 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7092 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7093 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7094 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007095 }
7096
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7098 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7099 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7100 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007101 }
7102
Gilles Peskine449bd832023-01-11 14:50:10 +01007103 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7104 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7105 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7106 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7107 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007108 }
7109
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007111
7112 /*
7113 * Same message structure as in mbedtls_ssl_write_certificate()
7114 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007116
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 if (ssl->in_msg[i] != 0 ||
7118 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7119 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7120 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7121 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7122 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007123 }
7124
7125 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7126 i += 3;
7127
7128 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007130 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 if (i + 3 > ssl->in_hslen) {
7132 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7133 mbedtls_ssl_send_alert_message(ssl,
7134 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7135 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7136 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007137 }
7138 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7139 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 if (ssl->in_msg[i] != 0) {
7141 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7142 mbedtls_ssl_send_alert_message(ssl,
7143 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7144 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7145 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007146 }
7147
7148 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007150 | (unsigned int) ssl->in_msg[i + 2];
7151 i += 3;
7152
Gilles Peskine449bd832023-01-11 14:50:10 +01007153 if (n < 128 || i + n > ssl->in_hslen) {
7154 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7155 mbedtls_ssl_send_alert_message(ssl,
7156 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7157 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7158 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007159 }
7160
7161 /* Check if we're handling the first CRT in the chain. */
7162#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007164 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007165 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007166 /* During client-side renegotiation, check that the server's
7167 * end-CRTs hasn't changed compared to the initial handshake,
7168 * mitigating the triple handshake attack. On success, reuse
7169 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007170 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7171 if (ssl_check_peer_crt_unchanged(ssl,
7172 &ssl->in_msg[i],
7173 n) != 0) {
7174 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7175 mbedtls_ssl_send_alert_message(ssl,
7176 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7177 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7178 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007179 }
7180
7181 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007183 }
7184#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7185
7186 /* Parse the next certificate in the chain. */
7187#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007189#else
7190 /* If we don't need to store the CRT chain permanently, parse
7191 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007193#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007194 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007195 case 0: /*ok*/
7196 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7197 /* Ignore certificate with an unknown algorithm: maybe a
7198 prior certificate was already trusted. */
7199 break;
7200
7201 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7202 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7203 goto crt_parse_der_failed;
7204
7205 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7206 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7207 goto crt_parse_der_failed;
7208
7209 default:
7210 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007211crt_parse_der_failed:
7212 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7213 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7214 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007215 }
7216
7217 i += n;
7218 }
7219
Gilles Peskine449bd832023-01-11 14:50:10 +01007220 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7221 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007222}
7223
7224#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007225MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007226static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007227{
Gilles Peskine449bd832023-01-11 14:50:10 +01007228 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7229 return -1;
7230 }
Jerry Yud9526692022-02-17 14:23:47 +08007231
Gilles Peskine449bd832023-01-11 14:50:10 +01007232 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007233 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7234 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007235 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7236 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7237 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007238 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007240}
7241#endif /* MBEDTLS_SSL_SRV_C */
7242
7243/* Check if a certificate message is expected.
7244 * Return either
7245 * - SSL_CERTIFICATE_EXPECTED, or
7246 * - SSL_CERTIFICATE_SKIP
7247 * indicating whether a Certificate message is expected or not.
7248 */
7249#define SSL_CERTIFICATE_EXPECTED 0
7250#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007251MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007252static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7253 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007254{
7255 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7256 ssl->handshake->ciphersuite_info;
7257
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7259 return SSL_CERTIFICATE_SKIP;
7260 }
Jerry Yud9526692022-02-17 14:23:47 +08007261
7262#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7264 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7265 return SSL_CERTIFICATE_SKIP;
7266 }
Jerry Yud9526692022-02-17 14:23:47 +08007267
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007269 ssl->session_negotiate->verify_result =
7270 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007272 }
7273 }
7274#else
7275 ((void) authmode);
7276#endif /* MBEDTLS_SSL_SRV_C */
7277
Gilles Peskine449bd832023-01-11 14:50:10 +01007278 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007279}
7280
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007281MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007282static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7283 int authmode,
7284 mbedtls_x509_crt *chain,
7285 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007286{
7287 int ret = 0;
7288 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7289 ssl->handshake->ciphersuite_info;
7290 int have_ca_chain = 0;
7291
7292 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7293 void *p_vrfy;
7294
Gilles Peskine449bd832023-01-11 14:50:10 +01007295 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7296 return 0;
7297 }
Jerry Yud9526692022-02-17 14:23:47 +08007298
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 if (ssl->f_vrfy != NULL) {
7300 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007301 f_vrfy = ssl->f_vrfy;
7302 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007303 } else {
7304 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007305 f_vrfy = ssl->conf->f_vrfy;
7306 p_vrfy = ssl->conf->p_vrfy;
7307 }
7308
7309 /*
7310 * Main check: verify certificate
7311 */
7312#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007313 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007314 ((void) rs_ctx);
7315 have_ca_chain = 1;
7316
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007318 ret = mbedtls_x509_crt_verify_with_ca_cb(
7319 chain,
7320 ssl->conf->f_ca_cb,
7321 ssl->conf->p_ca_cb,
7322 ssl->conf->cert_profile,
7323 ssl->hostname,
7324 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 f_vrfy, p_vrfy);
7326 } else
Jerry Yud9526692022-02-17 14:23:47 +08007327#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7328 {
7329 mbedtls_x509_crt *ca_chain;
7330 mbedtls_x509_crl *ca_crl;
7331
7332#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007333 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007334 ca_chain = ssl->handshake->sni_ca_chain;
7335 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 } else
Jerry Yud9526692022-02-17 14:23:47 +08007337#endif
7338 {
7339 ca_chain = ssl->conf->ca_chain;
7340 ca_crl = ssl->conf->ca_crl;
7341 }
7342
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007344 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007345 }
Jerry Yud9526692022-02-17 14:23:47 +08007346
7347 ret = mbedtls_x509_crt_verify_restartable(
7348 chain,
7349 ca_chain, ca_crl,
7350 ssl->conf->cert_profile,
7351 ssl->hostname,
7352 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007354 }
7355
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 if (ret != 0) {
7357 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007358 }
7359
7360#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7362 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7363 }
Jerry Yud9526692022-02-17 14:23:47 +08007364#endif
7365
7366 /*
7367 * Secondary checks: always done, but change 'ret' only if it was 0
7368 */
7369
7370#if defined(MBEDTLS_ECP_C)
7371 {
7372 const mbedtls_pk_context *pk = &chain->pk;
7373
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007374 /* If certificate uses an EC key, make sure the curve is OK.
7375 * This is a public key, so it can't be opaque, so can_do() is a good
7376 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007377 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007378 /* and in the unlikely case the above assumption no longer holds
7379 * we are making sure that pk_ec() here does not return a NULL
7380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 const mbedtls_ecp_keypair *ec = mbedtls_pk_ec(*pk);
7382 if (ec == NULL) {
7383 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_pk_ec() returned NULL"));
7384 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007385 }
Jerry Yud9526692022-02-17 14:23:47 +08007386
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 if (mbedtls_ssl_check_curve(ssl, ec->grp.id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007388 ssl->session_negotiate->verify_result |=
7389 MBEDTLS_X509_BADCERT_BAD_KEY;
7390
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7392 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007393 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007394 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007395 }
Jerry Yud9526692022-02-17 14:23:47 +08007396 }
7397 }
7398#endif /* MBEDTLS_ECP_C */
7399
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 if (mbedtls_ssl_check_cert_usage(chain,
7401 ciphersuite_info,
7402 !ssl->conf->endpoint,
7403 &ssl->session_negotiate->verify_result) != 0) {
7404 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7405 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007406 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007407 }
Jerry Yud9526692022-02-17 14:23:47 +08007408 }
7409
7410 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7411 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7412 * with details encoded in the verification flags. All other kinds
7413 * of error codes, including those from the user provided f_vrfy
7414 * functions, are treated as fatal and lead to a failure of
7415 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7417 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7418 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007419 ret = 0;
7420 }
7421
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7423 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007424 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7425 }
7426
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007428 uint8_t alert;
7429
7430 /* The certificate may have been rejected for several reasons.
7431 Pick one and send the corresponding alert. Which alert to send
7432 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007434 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007436 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007438 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007440 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007442 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007444 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007446 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007448 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007450 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007452 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007454 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 }
7456 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7457 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007458 }
7459
7460#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 if (ssl->session_negotiate->verify_result != 0) {
7462 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7463 (unsigned int) ssl->session_negotiate->verify_result));
7464 } else {
7465 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007466 }
7467#endif /* MBEDTLS_DEBUG_C */
7468
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007470}
7471
7472#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007473MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007474static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7475 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007476{
7477 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7478 /* Remember digest of the peer's end-CRT. */
7479 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7481 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7482 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7483 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7484 mbedtls_ssl_send_alert_message(ssl,
7485 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7486 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007487
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007489 }
7490
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 ret = mbedtls_md(mbedtls_md_info_from_type(
7492 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7493 start, len,
7494 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007495
7496 ssl->session_negotiate->peer_cert_digest_type =
7497 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7498 ssl->session_negotiate->peer_cert_digest_len =
7499 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7500
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007502}
7503
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007504MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007505static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7506 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007507{
7508 unsigned char *end = start + len;
7509 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7510
7511 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7513 ret = mbedtls_pk_parse_subpubkey(&start, end,
7514 &ssl->handshake->peer_pubkey);
7515 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007516 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007518 }
7519
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007521}
7522#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7523
Gilles Peskine449bd832023-01-11 14:50:10 +01007524int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007525{
7526 int ret = 0;
7527 int crt_expected;
7528#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7529 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7530 ? ssl->handshake->sni_authmode
7531 : ssl->conf->authmode;
7532#else
7533 const int authmode = ssl->conf->authmode;
7534#endif
7535 void *rs_ctx = NULL;
7536 mbedtls_x509_crt *chain = NULL;
7537
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007539
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7541 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7542 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007543 goto exit;
7544 }
7545
7546#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 if (ssl->handshake->ecrs_enabled &&
7548 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007549 chain = ssl->handshake->ecrs_peer_cert;
7550 ssl->handshake->ecrs_peer_cert = NULL;
7551 goto crt_verify;
7552 }
7553#endif
7554
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007556 /* mbedtls_ssl_read_record may have sent an alert already. We
7557 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007559 goto exit;
7560 }
7561
7562#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007564 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7565
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007567 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 }
Jerry Yud9526692022-02-17 14:23:47 +08007569
7570 goto exit;
7571 }
7572#endif /* MBEDTLS_SSL_SRV_C */
7573
7574 /* Clear existing peer CRT structure in case we tried to
7575 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007577
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7579 if (chain == NULL) {
7580 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7581 sizeof(mbedtls_x509_crt)));
7582 mbedtls_ssl_send_alert_message(ssl,
7583 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7584 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007585
7586 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7587 goto exit;
7588 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007590
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 ret = ssl_parse_certificate_chain(ssl, chain);
7592 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007593 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 }
Jerry Yud9526692022-02-17 14:23:47 +08007595
7596#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007598 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 }
Jerry Yud9526692022-02-17 14:23:47 +08007600
7601crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007603 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 }
Jerry Yud9526692022-02-17 14:23:47 +08007605#endif
7606
Gilles Peskine449bd832023-01-11 14:50:10 +01007607 ret = ssl_parse_certificate_verify(ssl, authmode,
7608 chain, rs_ctx);
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_KEEP_PEER_CERTIFICATE)
7614 {
7615 unsigned char *crt_start, *pk_start;
7616 size_t crt_len, pk_len;
7617
7618 /* We parse the CRT chain without copying, so
7619 * these pointers point into the input buffer,
7620 * and are hence still valid after freeing the
7621 * CRT chain. */
7622
7623 crt_start = chain->raw.p;
7624 crt_len = chain->raw.len;
7625
7626 pk_start = chain->pk_raw.p;
7627 pk_len = chain->pk_raw.len;
7628
7629 /* Free the CRT structures before computing
7630 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 mbedtls_x509_crt_free(chain);
7632 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007633 chain = NULL;
7634
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7636 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007637 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 }
Jerry Yud9526692022-02-17 14:23:47 +08007639
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7641 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007642 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 }
Jerry Yud9526692022-02-17 14:23:47 +08007644 }
7645#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7646 /* Pass ownership to session structure. */
7647 ssl->session_negotiate->peer_cert = chain;
7648 chain = NULL;
7649#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7650
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007652
7653exit:
7654
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007656 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 }
Jerry Yud9526692022-02-17 14:23:47 +08007658
7659#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007661 ssl->handshake->ecrs_peer_cert = chain;
7662 chain = NULL;
7663 }
7664#endif
7665
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 if (chain != NULL) {
7667 mbedtls_x509_crt_free(chain);
7668 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007669 }
7670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007672}
7673#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7674
Andrzej Kurek25f27152022-08-17 16:09:31 -04007675#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007676static int ssl_calc_finished_tls_sha256(
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007678{
7679 int len = 12;
7680 const char *sender;
7681 unsigned char padbuf[32];
7682#if defined(MBEDTLS_USE_PSA_CRYPTO)
7683 size_t hash_size;
7684 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
7685 psa_status_t status;
7686#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007687 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007688 mbedtls_md_context_t sha256;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007689#endif
7690
7691 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007693 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007695
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007697 ? "client finished"
7698 : "server finished";
7699
7700#if defined(MBEDTLS_USE_PSA_CRYPTO)
7701 sha256_psa = psa_hash_operation_init();
7702
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls sha256"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007704
Gilles Peskine449bd832023-01-11 14:50:10 +01007705 status = psa_hash_clone(&ssl->handshake->fin_sha256_psa, &sha256_psa);
7706 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007707 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007708 }
7709
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 status = psa_hash_finish(&sha256_psa, padbuf, sizeof(padbuf), &hash_size);
7711 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007712 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007713 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, 32);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007715#else
7716
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007717 mbedtls_md_init(&sha256);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007718
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls sha256"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007720
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007721 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
7722 if (ret != 0) {
7723 goto exit;
7724 }
7725 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
7726 if (ret != 0) {
7727 goto exit;
7728 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007729
7730 /*
7731 * TLSv1.2:
7732 * hash = PRF( master, finished_label,
7733 * Hash( handshake ) )[0.11]
7734 */
7735
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007736 ret = mbedtls_md_finish(&sha256, padbuf);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007737 if (ret != 0) {
7738 goto exit;
7739 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007740#endif /* MBEDTLS_USE_PSA_CRYPTO */
7741
Manuel Pégourié-Gonnard0ac71c02023-02-24 12:13:55 +01007742 MBEDTLS_SSL_DEBUG_BUF(4, "finished sha256 output", padbuf, 32);
7743
Gilles Peskine449bd832023-01-11 14:50:10 +01007744 ssl->handshake->tls_prf(session->master, 48, sender,
7745 padbuf, 32, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007746
Gilles Peskine449bd832023-01-11 14:50:10 +01007747 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007748
Gilles Peskine449bd832023-01-11 14:50:10 +01007749 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007750
Gilles Peskine449bd832023-01-11 14:50:10 +01007751 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007752
7753exit:
7754#if defined(MBEDTLS_USE_PSA_CRYPTO)
7755 psa_hash_abort(&sha256_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05007756 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007757#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007758 mbedtls_md_free(&sha256);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007759 return ret;
7760#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007761}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04007762#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007763
Jerry Yub7ba49e2022-02-17 14:25:53 +08007764
Andrzej Kurek25f27152022-08-17 16:09:31 -04007765#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007766static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007767 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007768{
7769 int len = 12;
7770 const char *sender;
7771 unsigned char padbuf[48];
7772#if defined(MBEDTLS_USE_PSA_CRYPTO)
7773 size_t hash_size;
7774 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
7775 psa_status_t status;
7776#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007777 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007778 mbedtls_md_context_t sha384;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007779#endif
7780
7781 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007782 if (!session) {
Jerry Yub7ba49e2022-02-17 14:25:53 +08007783 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007785
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007787 ? "client finished"
7788 : "server finished";
7789
7790#if defined(MBEDTLS_USE_PSA_CRYPTO)
7791 sha384_psa = psa_hash_operation_init();
7792
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls sha384"));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007794
Gilles Peskine449bd832023-01-11 14:50:10 +01007795 status = psa_hash_clone(&ssl->handshake->fin_sha384_psa, &sha384_psa);
7796 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007797 goto exit;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007798 }
7799
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 status = psa_hash_finish(&sha384_psa, padbuf, sizeof(padbuf), &hash_size);
7801 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007802 goto exit;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007803 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, 48);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007805#else
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007806 mbedtls_md_init(&sha384);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007807
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls sha384"));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007809
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007810 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007811 if (ret != 0) {
7812 goto exit;
7813 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007814 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007815 if (ret != 0) {
7816 goto exit;
7817 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007818
7819 /*
7820 * TLSv1.2:
7821 * hash = PRF( master, finished_label,
7822 * Hash( handshake ) )[0.11]
7823 */
7824
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007825 ret = mbedtls_md_finish(&sha384, padbuf);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007826 if (ret != 0) {
7827 goto exit;
7828 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007829#endif
7830
Manuel Pégourié-Gonnard0ac71c02023-02-24 12:13:55 +01007831 MBEDTLS_SSL_DEBUG_BUF(4, "finished sha384 output", padbuf, 48);
7832
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 ssl->handshake->tls_prf(session->master, 48, sender,
7834 padbuf, 48, buf, len);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007835
Gilles Peskine449bd832023-01-11 14:50:10 +01007836 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007837
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007839
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007841
7842exit:
7843#if defined(MBEDTLS_USE_PSA_CRYPTO)
7844 psa_hash_abort(&sha384_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05007845 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007846#else
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007847 mbedtls_md_free(&sha384);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007848 return ret;
7849#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yub7ba49e2022-02-17 14:25:53 +08007850}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04007851#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007852
Gilles Peskine449bd832023-01-11 14:50:10 +01007853void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007854{
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007856
7857 /*
7858 * Free our handshake params
7859 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 mbedtls_ssl_handshake_free(ssl);
7861 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007862 ssl->handshake = NULL;
7863
7864 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007865 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007866 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 if (ssl->transform) {
7868 mbedtls_ssl_transform_free(ssl->transform);
7869 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007870 }
7871 ssl->transform = ssl->transform_negotiate;
7872 ssl->transform_negotiate = NULL;
7873
Gilles Peskine449bd832023-01-11 14:50:10 +01007874 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007875}
7876
Gilles Peskine449bd832023-01-11 14:50:10 +01007877void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007878{
7879 int resume = ssl->handshake->resume;
7880
Gilles Peskine449bd832023-01-11 14:50:10 +01007881 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007882
7883#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007885 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7886 ssl->renego_records_seen = 0;
7887 }
7888#endif
7889
7890 /*
7891 * Free the previous session and switch in the current one
7892 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007894#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7895 /* RFC 7366 3.1: keep the EtM state */
7896 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007898#endif
7899
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 mbedtls_ssl_session_free(ssl->session);
7901 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007902 }
7903 ssl->session = ssl->session_negotiate;
7904 ssl->session_negotiate = NULL;
7905
7906 /*
7907 * Add cache entry
7908 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007910 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007911 resume == 0) {
7912 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7913 ssl->session->id,
7914 ssl->session->id_len,
7915 ssl->session) != 0) {
7916 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7917 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007918 }
7919
7920#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7922 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007923 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007925
7926 /* Keep last flight around in case we need to resend it:
7927 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007928 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7929 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007930#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007932
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007933 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007934
Gilles Peskine449bd832023-01-11 14:50:10 +01007935 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007936}
7937
Gilles Peskine449bd832023-01-11 14:50:10 +01007938int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007939{
7940 int ret, hash_len;
7941
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007943
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007945
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007946 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7947 if (ret != 0) {
7948 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7949 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007950
7951 /*
7952 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7953 * may define some other value. Currently (early 2016), no defined
7954 * ciphersuite does this (and this is unlikely to change as activity has
7955 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7956 */
7957 hash_len = 12;
7958
7959#if defined(MBEDTLS_SSL_RENEGOTIATION)
7960 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007962#endif
7963
7964 ssl->out_msglen = 4 + hash_len;
7965 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7966 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7967
7968 /*
7969 * In case of session resuming, invert the client and server
7970 * ChangeCipherSpec messages order.
7971 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007972 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007973#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007974 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007975 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007977#endif
7978#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007979 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007980 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007982#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007984 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007985 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007986
7987 /*
7988 * Switch to our negotiated transform and session parameters for outbound
7989 * data.
7990 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007992
7993#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007995 unsigned char i;
7996
7997 /* Remember current epoch settings for resending */
7998 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8000 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008001
8002 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008004
8005
8006 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 for (i = 2; i > 0; i--) {
8008 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008009 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008010 }
8011 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008012
8013 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 if (i == 0) {
8015 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8016 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008017 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008019#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008020 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008021
8022 ssl->transform_out = ssl->transform_negotiate;
8023 ssl->session_out = ssl->session_negotiate;
8024
8025#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8027 mbedtls_ssl_send_flight_completed(ssl);
8028 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008029#endif
8030
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8032 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8033 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008034 }
8035
8036#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8038 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8039 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8040 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008041 }
8042#endif
8043
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008045
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008047}
8048
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008049#define SSL_MAX_HASH_LEN 12
8050
Gilles Peskine449bd832023-01-11 14:50:10 +01008051int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008052{
8053 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8054 unsigned int hash_len = 12;
8055 unsigned char buf[SSL_MAX_HASH_LEN];
8056
Gilles Peskine449bd832023-01-11 14:50:10 +01008057 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008058
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008059 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8060 if (ret != 0) {
8061 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8062 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008063
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8065 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008066 goto exit;
8067 }
8068
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8070 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8071 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8072 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008073 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8074 goto exit;
8075 }
8076
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8078 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8079 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008080 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8081 goto exit;
8082 }
8083
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8085 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8086 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8087 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008088 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8089 goto exit;
8090 }
8091
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8093 buf, hash_len) != 0) {
8094 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8095 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8096 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008097 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8098 goto exit;
8099 }
8100
8101#if defined(MBEDTLS_SSL_RENEGOTIATION)
8102 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008104#endif
8105
Gilles Peskine449bd832023-01-11 14:50:10 +01008106 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008107#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008108 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008109 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008110 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008111#endif
8112#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008113 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008114 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008115 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008116#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008118 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008119 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008120
8121#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008122 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8123 mbedtls_ssl_recv_flight_completed(ssl);
8124 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008125#endif
8126
Gilles Peskine449bd832023-01-11 14:50:10 +01008127 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008128
8129exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008130 mbedtls_platform_zeroize(buf, hash_len);
8131 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008132}
8133
Jerry Yu392112c2022-02-17 14:34:10 +08008134#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8135/*
8136 * Helper to get TLS 1.2 PRF from ciphersuite
8137 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8138 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008139static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008140{
Jerry Yu392112c2022-02-17 14:34:10 +08008141 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Andrzej Kurek68327742022-10-03 06:18:18 -04008143#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01008144 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8145 return tls_prf_sha384;
8146 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008147#endif
Andrzej Kurek894edde2022-09-29 06:31:14 -04008148#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
8149 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008150 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8151 return tls_prf_sha256;
8152 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008153 }
8154#endif
8155#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
8156 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
8157 (void) ciphersuite_info;
8158#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008159
Gilles Peskine449bd832023-01-11 14:50:10 +01008160 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008161}
8162#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008163
Gilles Peskine449bd832023-01-11 14:50:10 +01008164static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008165{
8166 ((void) tls_prf);
Andrzej Kurek25f27152022-08-17 16:09:31 -04008167#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01008168 if (tls_prf == tls_prf_sha384) {
8169 return MBEDTLS_SSL_TLS_PRF_SHA384;
8170 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008171#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04008172#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gilles Peskine449bd832023-01-11 14:50:10 +01008173 if (tls_prf == tls_prf_sha256) {
8174 return MBEDTLS_SSL_TLS_PRF_SHA256;
8175 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008176#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008177 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008178}
8179
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008180/*
8181 * Populate a transform structure with session keys and all the other
8182 * necessary information.
8183 *
8184 * Parameters:
8185 * - [in/out]: transform: structure to populate
8186 * [in] must be just initialised with mbedtls_ssl_transform_init()
8187 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8188 * - [in] ciphersuite
8189 * - [in] master
8190 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008191 * - [in] tls_prf: pointer to PRF to use for key derivation
8192 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008193 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008194 * - [in] endpoint: client or server
8195 * - [in] ssl: used for:
8196 * - ssl->conf->{f,p}_export_keys
8197 * [in] optionally used for:
8198 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8199 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008200MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008201static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8202 int ciphersuite,
8203 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008204#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008205 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008206#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 ssl_tls_prf_t tls_prf,
8208 const unsigned char randbytes[64],
8209 mbedtls_ssl_protocol_version tls_version,
8210 unsigned endpoint,
8211 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008212{
8213 int ret = 0;
8214 unsigned char keyblk[256];
8215 unsigned char *key1;
8216 unsigned char *key2;
8217 unsigned char *mac_enc;
8218 unsigned char *mac_dec;
8219 size_t mac_key_len = 0;
8220 size_t iv_copy_len;
8221 size_t keylen;
8222 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008223 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008224#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008225 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008226 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008227#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008228
8229#if defined(MBEDTLS_USE_PSA_CRYPTO)
8230 psa_key_type_t key_type;
8231 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8232 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008233 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008234 size_t key_bits;
8235 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8236#endif
8237
8238#if !defined(MBEDTLS_DEBUG_C) && \
8239 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008240 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008241 ssl = NULL; /* make sure we don't use it except for these cases */
8242 (void) ssl;
8243 }
8244#endif
8245
8246 /*
8247 * Some data just needs copying into the structure
8248 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008249#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008250 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008251#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008252 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008253
8254#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008255 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008256#endif
8257
8258#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008259 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008260 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8261 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008262 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008263 }
8264#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8265
8266 /*
8267 * Get various info structures
8268 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008269 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8270 if (ciphersuite_info == NULL) {
8271 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8272 ciphersuite));
8273 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008274 }
8275
Neil Armstrongab555e02022-04-04 11:07:59 +02008276 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008277#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008278 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008279#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008280 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008281
Gilles Peskine449bd832023-01-11 14:50:10 +01008282 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008283 transform->taglen =
8284 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008285 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008286
8287#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008288 if ((status = mbedtls_ssl_cipher_to_psa(ciphersuite_info->cipher,
8289 transform->taglen,
8290 &alg,
8291 &key_type,
8292 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008293 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008294 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008295 goto end;
8296 }
8297#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008298 cipher_info = mbedtls_cipher_info_from_type(ciphersuite_info->cipher);
8299 if (cipher_info == NULL) {
8300 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8301 ciphersuite_info->cipher));
8302 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008303 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008304#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008305
Neil Armstronge4512952022-03-08 09:08:22 +01008306#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 mac_alg = mbedtls_hash_info_psa_from_md(ciphersuite_info->mac);
8308 if (mac_alg == 0) {
8309 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_hash_info_psa_from_md for %u not found",
8310 (unsigned) ciphersuite_info->mac));
8311 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008312 }
8313#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008314 md_info = mbedtls_md_info_from_type(ciphersuite_info->mac);
8315 if (md_info == NULL) {
8316 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8317 (unsigned) ciphersuite_info->mac));
8318 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008319 }
Neil Armstronge4512952022-03-08 09:08:22 +01008320#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008321
8322#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8323 /* Copy own and peer's CID if the use of the CID
8324 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008325 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8326 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008327
8328 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008329 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8330 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8331 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008332
8333 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008334 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8335 ssl->handshake->peer_cid_len);
8336 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8337 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008338 }
8339#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8340
8341 /*
8342 * Compute key block using the PRF
8343 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008344 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8345 if (ret != 0) {
8346 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8347 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008348 }
8349
Gilles Peskine449bd832023-01-11 14:50:10 +01008350 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8351 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8352 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8353 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8354 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008355
8356 /*
8357 * Determine the appropriate key, IV and MAC length.
8358 */
8359
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008360#if defined(MBEDTLS_USE_PSA_CRYPTO)
8361 keylen = PSA_BITS_TO_BYTES(key_bits);
8362#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008363 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008364#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008365
8366#if defined(MBEDTLS_GCM_C) || \
8367 defined(MBEDTLS_CCM_C) || \
8368 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008370 size_t explicit_ivlen;
8371
8372 transform->maclen = 0;
8373 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008374
8375 /* All modes haves 96-bit IVs, but the length of the static parts vary
8376 * with mode and version:
8377 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8378 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8379 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8380 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8381 * sequence number).
8382 */
8383 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008384
8385 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008386#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008387 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008388#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008389 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8390 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008391#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008392
Gilles Peskine449bd832023-01-11 14:50:10 +01008393 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008394 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008395 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008396 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008397 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008398
8399 /* Minimum length of encrypted record */
8400 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8401 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008402 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008403#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8404#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008405 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008406 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008407 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008408#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008409 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008410#else
8411 size_t block_size = cipher_info->block_size;
8412#endif /* MBEDTLS_USE_PSA_CRYPTO */
8413
8414#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008415 /* Get MAC length */
8416 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8417#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008418 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008419 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8420 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8421 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008422 goto end;
8423 }
8424
8425 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008426 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008427#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008428 transform->maclen = mac_key_len;
8429
8430 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008431#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008432 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008433#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008434 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008435#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008436
8437 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008438 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008439 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008441 /*
8442 * GenericBlockCipher:
8443 * 1. if EtM is in use: one block plus MAC
8444 * otherwise: * first multiple of blocklen greater than maclen
8445 * 2. IV
8446 */
8447#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008448 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008449 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 + block_size;
8451 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008452#endif
8453 {
8454 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008455 + block_size
8456 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008457 }
8458
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008460 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 } else {
8462 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008463 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8464 goto end;
8465 }
8466 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008467 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008468#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8469 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008470 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8471 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008472 }
8473
Gilles Peskine449bd832023-01-11 14:50:10 +01008474 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8475 (unsigned) keylen,
8476 (unsigned) transform->minlen,
8477 (unsigned) transform->ivlen,
8478 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008479
8480 /*
8481 * Finally setup the cipher contexts, IVs and MAC secrets.
8482 */
8483#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008484 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008485 key1 = keyblk + mac_key_len * 2;
8486 key2 = keyblk + mac_key_len * 2 + keylen;
8487
8488 mac_enc = keyblk;
8489 mac_dec = keyblk + mac_key_len;
8490
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 iv_copy_len = (transform->fixed_ivlen) ?
8492 transform->fixed_ivlen : transform->ivlen;
8493 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8494 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8495 iv_copy_len);
8496 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008497#endif /* MBEDTLS_SSL_CLI_C */
8498#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008499 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008500 key1 = keyblk + mac_key_len * 2 + keylen;
8501 key2 = keyblk + mac_key_len * 2;
8502
8503 mac_enc = keyblk + mac_key_len;
8504 mac_dec = keyblk;
8505
Gilles Peskine449bd832023-01-11 14:50:10 +01008506 iv_copy_len = (transform->fixed_ivlen) ?
8507 transform->fixed_ivlen : transform->ivlen;
8508 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8509 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8510 iv_copy_len);
8511 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008512#endif /* MBEDTLS_SSL_SRV_C */
8513 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008515 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8516 goto end;
8517 }
8518
Gilles Peskine449bd832023-01-11 14:50:10 +01008519 if (ssl != NULL && ssl->f_export_keys != NULL) {
8520 ssl->f_export_keys(ssl->p_export_keys,
8521 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8522 master, 48,
8523 randbytes + 32,
8524 randbytes,
8525 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008526 }
8527
8528#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008529 transform->psa_alg = alg;
8530
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8532 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8533 psa_set_key_algorithm(&attributes, alg);
8534 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008535
Gilles Peskine449bd832023-01-11 14:50:10 +01008536 if ((status = psa_import_key(&attributes,
8537 key1,
8538 PSA_BITS_TO_BYTES(key_bits),
8539 &transform->psa_key_enc)) != PSA_SUCCESS) {
8540 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008541 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008542 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008543 goto end;
8544 }
8545
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008547
Gilles Peskine449bd832023-01-11 14:50:10 +01008548 if ((status = psa_import_key(&attributes,
8549 key2,
8550 PSA_BITS_TO_BYTES(key_bits),
8551 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008552 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008553 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008554 goto end;
8555 }
8556 }
8557#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008558 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8559 cipher_info)) != 0) {
8560 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008561 goto end;
8562 }
8563
Gilles Peskine449bd832023-01-11 14:50:10 +01008564 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8565 cipher_info)) != 0) {
8566 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008567 goto end;
8568 }
8569
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8571 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8572 MBEDTLS_ENCRYPT)) != 0) {
8573 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008574 goto end;
8575 }
8576
Gilles Peskine449bd832023-01-11 14:50:10 +01008577 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8578 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8579 MBEDTLS_DECRYPT)) != 0) {
8580 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008581 goto end;
8582 }
8583
8584#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008585 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8586 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8587 MBEDTLS_PADDING_NONE)) != 0) {
8588 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008589 goto end;
8590 }
8591
Gilles Peskine449bd832023-01-11 14:50:10 +01008592 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8593 MBEDTLS_PADDING_NONE)) != 0) {
8594 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008595 goto end;
8596 }
8597 }
8598#endif /* MBEDTLS_CIPHER_MODE_CBC */
8599#endif /* MBEDTLS_USE_PSA_CRYPTO */
8600
Neil Armstrong29c0c042022-03-17 17:47:28 +01008601#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8602 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8603 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008605#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008607
Gilles Peskine449bd832023-01-11 14:50:10 +01008608 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8609 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8610 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008611
Gilles Peskine449bd832023-01-11 14:50:10 +01008612 if ((status = psa_import_key(&attributes,
8613 mac_enc, mac_key_len,
8614 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008615 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008617 goto end;
8618 }
8619
Gilles Peskine449bd832023-01-11 14:50:10 +01008620 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8621 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008622#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008623 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008624#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008626 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8628 PSA_KEY_USAGE_VERIFY_HASH);
8629 } else {
8630 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8631 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008632
Gilles Peskine449bd832023-01-11 14:50:10 +01008633 if ((status = psa_import_key(&attributes,
8634 mac_dec, mac_key_len,
8635 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008636 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008637 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008638 goto end;
8639 }
8640#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008641 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8642 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008643 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008644 }
8645 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8646 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008647 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008648 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008649#endif /* MBEDTLS_USE_PSA_CRYPTO */
8650 }
8651#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8652
8653 ((void) mac_dec);
8654 ((void) mac_enc);
8655
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008656end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008657 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8658 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008659}
8660
Valerio Settia08b1a42022-11-17 15:10:02 +01008661#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8662 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008663int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008664 psa_pake_operation_t *pake_ctx,
8665 const unsigned char *buf,
8666 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008667{
8668 psa_status_t status;
8669 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008670 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008671 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8672 * At round two perform a single cycle
8673 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008674 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008675
Gilles Peskine449bd832023-01-11 14:50:10 +01008676 for (; remaining_steps > 0; remaining_steps--) {
8677 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008678 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008679 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008680 /* Length is stored at the first byte */
8681 size_t length = buf[input_offset];
8682 input_offset += 1;
8683
Gilles Peskine449bd832023-01-11 14:50:10 +01008684 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008685 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8686 }
8687
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 status = psa_pake_input(pake_ctx, step,
8689 buf + input_offset, length);
8690 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008691 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008692 }
8693
8694 input_offset += length;
8695 }
8696 }
8697
Gilles Peskine449bd832023-01-11 14:50:10 +01008698 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008699 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008700 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008701
Gilles Peskine449bd832023-01-11 14:50:10 +01008702 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008703}
8704
Valerio Setti6b3dab02022-11-17 17:14:54 +01008705int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008706 psa_pake_operation_t *pake_ctx,
8707 unsigned char *buf,
8708 size_t len, size_t *olen,
8709 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008710{
8711 psa_status_t status;
8712 size_t output_offset = 0;
8713 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008714 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008715 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8716 * At round two perform a single cycle
8717 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008718 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008719
Gilles Peskine449bd832023-01-11 14:50:10 +01008720 for (; remaining_steps > 0; remaining_steps--) {
8721 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8722 step <= PSA_PAKE_STEP_ZK_PROOF;
8723 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008724 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008725 * For each step, prepend 1 byte with the length of the data as
8726 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008727 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008728 status = psa_pake_output(pake_ctx, step,
8729 buf + output_offset + 1,
8730 len - output_offset - 1,
8731 &output_len);
8732 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008733 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008734 }
8735
Valerio Setti99d88c12022-11-22 16:03:43 +01008736 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008737
8738 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008739 }
8740 }
8741
8742 *olen = output_offset;
8743
Gilles Peskine449bd832023-01-11 14:50:10 +01008744 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008745}
Valerio Settia08b1a42022-11-17 15:10:02 +01008746#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8747
Jerry Yuee40f9d2022-02-17 14:55:16 +08008748#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008749int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8750 unsigned char *hash, size_t *hashlen,
8751 unsigned char *data, size_t data_len,
8752 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008753{
8754 psa_status_t status;
8755 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008756 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008757
Gilles Peskine449bd832023-01-11 14:50:10 +01008758 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008759
Gilles Peskine449bd832023-01-11 14:50:10 +01008760 if ((status = psa_hash_setup(&hash_operation,
8761 hash_alg)) != PSA_SUCCESS) {
8762 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008763 goto exit;
8764 }
8765
Gilles Peskine449bd832023-01-11 14:50:10 +01008766 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8767 64)) != PSA_SUCCESS) {
8768 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008769 goto exit;
8770 }
8771
Gilles Peskine449bd832023-01-11 14:50:10 +01008772 if ((status = psa_hash_update(&hash_operation,
8773 data, data_len)) != PSA_SUCCESS) {
8774 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008775 goto exit;
8776 }
8777
Gilles Peskine449bd832023-01-11 14:50:10 +01008778 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8779 hashlen)) != PSA_SUCCESS) {
8780 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8781 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008782 }
8783
8784exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008785 if (status != PSA_SUCCESS) {
8786 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8787 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8788 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008789 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008790 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008791 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8792 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008793 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008794 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008795 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008796 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008797 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008798 }
8799 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008800 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008801}
8802
8803#else
8804
Gilles Peskine449bd832023-01-11 14:50:10 +01008805int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8806 unsigned char *hash, size_t *hashlen,
8807 unsigned char *data, size_t data_len,
8808 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008809{
8810 int ret = 0;
8811 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008812 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8813 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008814
Gilles Peskine449bd832023-01-11 14:50:10 +01008815 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008816
Gilles Peskine449bd832023-01-11 14:50:10 +01008817 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008818
8819 /*
8820 * digitally-signed struct {
8821 * opaque client_random[32];
8822 * opaque server_random[32];
8823 * ServerDHParams params;
8824 * };
8825 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008826 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8827 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008828 goto exit;
8829 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008830 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8831 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008832 goto exit;
8833 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008834 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8835 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008836 goto exit;
8837 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008838 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8839 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008840 goto exit;
8841 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008842 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8843 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008844 goto exit;
8845 }
8846
8847exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008848 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008849
Gilles Peskine449bd832023-01-11 14:50:10 +01008850 if (ret != 0) {
8851 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8852 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8853 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008854
Gilles Peskine449bd832023-01-11 14:50:10 +01008855 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008856}
8857#endif /* MBEDTLS_USE_PSA_CRYPTO */
8858
Jerry Yud9d91da2022-02-17 14:57:06 +08008859#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8860
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008861/* Find the preferred hash for a given signature algorithm. */
8862unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008863 mbedtls_ssl_context *ssl,
8864 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008865{
Gabor Mezei078e8032022-04-27 21:17:56 +02008866 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008867 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008868
Gilles Peskine449bd832023-01-11 14:50:10 +01008869 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8870 return MBEDTLS_SSL_HASH_NONE;
8871 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008872
Gilles Peskine449bd832023-01-11 14:50:10 +01008873 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008874 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008875 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8876 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008877 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008878 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8879 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008880
Gilles Peskine449bd832023-01-11 14:50:10 +01008881 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008882#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008883 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008884 psa_algorithm_t psa_hash_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +01008885 mbedtls_hash_info_psa_from_md(hash_alg_received);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008886
Gilles Peskine449bd832023-01-11 14:50:10 +01008887 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8888 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8889 PSA_ALG_ECDSA(psa_hash_alg),
8890 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008891 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008892 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008893
Gilles Peskine449bd832023-01-11 14:50:10 +01008894 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8895 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8896 PSA_ALG_RSA_PKCS1V15_SIGN(
8897 psa_hash_alg),
8898 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008899 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008900 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008901 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008902#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008903
Gilles Peskine449bd832023-01-11 14:50:10 +01008904 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008905 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008906 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008907
Gilles Peskine449bd832023-01-11 14:50:10 +01008908 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008909}
8910
8911#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8912
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008913/* Serialization of TLS 1.2 sessions:
8914 *
8915 * struct {
8916 * uint64 start_time;
8917 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008918 * uint8 session_id_len; // at most 32
8919 * opaque session_id[32];
8920 * opaque master[48]; // fixed length in the standard
8921 * uint32 verify_result;
8922 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8923 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8924 * uint32 ticket_lifetime;
8925 * uint8 mfl_code; // up to 255 according to standard
8926 * uint8 encrypt_then_mac; // 0 or 1
8927 * } serialized_session_tls12;
8928 *
8929 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008930static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8931 unsigned char *buf,
8932 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008933{
8934 unsigned char *p = buf;
8935 size_t used = 0;
8936
8937#if defined(MBEDTLS_HAVE_TIME)
8938 uint64_t start;
8939#endif
8940#if defined(MBEDTLS_X509_CRT_PARSE_C)
8941#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8942 size_t cert_len;
8943#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8944#endif /* MBEDTLS_X509_CRT_PARSE_C */
8945
8946 /*
8947 * Time
8948 */
8949#if defined(MBEDTLS_HAVE_TIME)
8950 used += 8;
8951
Gilles Peskine449bd832023-01-11 14:50:10 +01008952 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008953 start = (uint64_t) session->start;
8954
Gilles Peskine449bd832023-01-11 14:50:10 +01008955 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008956 p += 8;
8957 }
8958#endif /* MBEDTLS_HAVE_TIME */
8959
8960 /*
8961 * Basic mandatory fields
8962 */
8963 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008964 + 1 /* id_len */
8965 + sizeof(session->id)
8966 + sizeof(session->master)
8967 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008968
Gilles Peskine449bd832023-01-11 14:50:10 +01008969 if (used <= buf_len) {
8970 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008971 p += 2;
8972
Gilles Peskine449bd832023-01-11 14:50:10 +01008973 *p++ = MBEDTLS_BYTE_0(session->id_len);
8974 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008975 p += 32;
8976
Gilles Peskine449bd832023-01-11 14:50:10 +01008977 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008978 p += 48;
8979
Gilles Peskine449bd832023-01-11 14:50:10 +01008980 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008981 p += 4;
8982 }
8983
8984 /*
8985 * Peer's end-entity certificate
8986 */
8987#if defined(MBEDTLS_X509_CRT_PARSE_C)
8988#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008989 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008990 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008991 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008992 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008993 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008994
8995 used += 3 + cert_len;
8996
Gilles Peskine449bd832023-01-11 14:50:10 +01008997 if (used <= buf_len) {
8998 *p++ = MBEDTLS_BYTE_2(cert_len);
8999 *p++ = MBEDTLS_BYTE_1(cert_len);
9000 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009001
Gilles Peskine449bd832023-01-11 14:50:10 +01009002 if (session->peer_cert != NULL) {
9003 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009004 p += cert_len;
9005 }
9006 }
9007#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01009008 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009009 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009010 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009011 *p++ = (unsigned char) session->peer_cert_digest_type;
9012 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009013 memcpy(p, session->peer_cert_digest,
9014 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009015 p += session->peer_cert_digest_len;
9016 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009018 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009020 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9021 *p++ = 0;
9022 }
9023 }
9024#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9025#endif /* MBEDTLS_X509_CRT_PARSE_C */
9026
9027 /*
9028 * Session ticket if any, plus associated data
9029 */
9030#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9031 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9032
Gilles Peskine449bd832023-01-11 14:50:10 +01009033 if (used <= buf_len) {
9034 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9035 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9036 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009037
Gilles Peskine449bd832023-01-11 14:50:10 +01009038 if (session->ticket != NULL) {
9039 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009040 p += session->ticket_len;
9041 }
9042
Gilles Peskine449bd832023-01-11 14:50:10 +01009043 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009044 p += 4;
9045 }
9046#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9047
9048 /*
9049 * Misc extension-related info
9050 */
9051#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9052 used += 1;
9053
Gilles Peskine449bd832023-01-11 14:50:10 +01009054 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009055 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009056 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009057#endif
9058
9059#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9060 used += 1;
9061
Gilles Peskine449bd832023-01-11 14:50:10 +01009062 if (used <= buf_len) {
9063 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9064 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009065#endif
9066
Gilles Peskine449bd832023-01-11 14:50:10 +01009067 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009068}
9069
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009070MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009071static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9072 const unsigned char *buf,
9073 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009074{
9075#if defined(MBEDTLS_HAVE_TIME)
9076 uint64_t start;
9077#endif
9078#if defined(MBEDTLS_X509_CRT_PARSE_C)
9079#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9080 size_t cert_len;
9081#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9082#endif /* MBEDTLS_X509_CRT_PARSE_C */
9083
9084 const unsigned char *p = buf;
9085 const unsigned char * const end = buf + len;
9086
9087 /*
9088 * Time
9089 */
9090#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009091 if (8 > (size_t) (end - p)) {
9092 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9093 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009094
Gilles Peskine449bd832023-01-11 14:50:10 +01009095 start = ((uint64_t) p[0] << 56) |
9096 ((uint64_t) p[1] << 48) |
9097 ((uint64_t) p[2] << 40) |
9098 ((uint64_t) p[3] << 32) |
9099 ((uint64_t) p[4] << 24) |
9100 ((uint64_t) p[5] << 16) |
9101 ((uint64_t) p[6] << 8) |
9102 ((uint64_t) p[7]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009103 p += 8;
9104
9105 session->start = (time_t) start;
9106#endif /* MBEDTLS_HAVE_TIME */
9107
9108 /*
9109 * Basic mandatory fields
9110 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009111 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9112 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9113 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009114
Gilles Peskine449bd832023-01-11 14:50:10 +01009115 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009116 p += 2;
9117
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009118 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009119 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009120 p += 32;
9121
Gilles Peskine449bd832023-01-11 14:50:10 +01009122 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009123 p += 48;
9124
Gilles Peskine449bd832023-01-11 14:50:10 +01009125 session->verify_result = ((uint32_t) p[0] << 24) |
9126 ((uint32_t) p[1] << 16) |
9127 ((uint32_t) p[2] << 8) |
9128 ((uint32_t) p[3]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009129 p += 4;
9130
9131 /* Immediately clear invalid pointer values that have been read, in case
9132 * we exit early before we replaced them with valid ones. */
9133#if defined(MBEDTLS_X509_CRT_PARSE_C)
9134#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9135 session->peer_cert = NULL;
9136#else
9137 session->peer_cert_digest = NULL;
9138#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9139#endif /* MBEDTLS_X509_CRT_PARSE_C */
9140#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9141 session->ticket = NULL;
9142#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9143
9144 /*
9145 * Peer certificate
9146 */
9147#if defined(MBEDTLS_X509_CRT_PARSE_C)
9148#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9149 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009150 if (3 > (size_t) (end - p)) {
9151 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9152 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009153
Gilles Peskine449bd832023-01-11 14:50:10 +01009154 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009155 p += 3;
9156
Gilles Peskine449bd832023-01-11 14:50:10 +01009157 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009158 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9159
Gilles Peskine449bd832023-01-11 14:50:10 +01009160 if (cert_len > (size_t) (end - p)) {
9161 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9162 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009163
Gilles Peskine449bd832023-01-11 14:50:10 +01009164 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009165
Gilles Peskine449bd832023-01-11 14:50:10 +01009166 if (session->peer_cert == NULL) {
9167 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9168 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009169
Gilles Peskine449bd832023-01-11 14:50:10 +01009170 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009171
Gilles Peskine449bd832023-01-11 14:50:10 +01009172 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9173 p, cert_len)) != 0) {
9174 mbedtls_x509_crt_free(session->peer_cert);
9175 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009176 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009178 }
9179
9180 p += cert_len;
9181 }
9182#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9183 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009184 if (2 > (size_t) (end - p)) {
9185 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9186 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009187
9188 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9189 session->peer_cert_digest_len = (size_t) *p++;
9190
Gilles Peskine449bd832023-01-11 14:50:10 +01009191 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009192 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009193 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9194 if (md_info == NULL) {
9195 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9196 }
9197 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9198 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9199 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009200
Gilles Peskine449bd832023-01-11 14:50:10 +01009201 if (session->peer_cert_digest_len > (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 =
Gilles Peskine449bd832023-01-11 14:50:10 +01009206 mbedtls_calloc(1, session->peer_cert_digest_len);
9207 if (session->peer_cert_digest == NULL) {
9208 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9209 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009210
Gilles Peskine449bd832023-01-11 14:50:10 +01009211 memcpy(session->peer_cert_digest, p,
9212 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009213 p += session->peer_cert_digest_len;
9214 }
9215#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9216#endif /* MBEDTLS_X509_CRT_PARSE_C */
9217
9218 /*
9219 * Session ticket and associated data
9220 */
9221#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009222 if (3 > (size_t) (end - p)) {
9223 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9224 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009225
Gilles Peskine449bd832023-01-11 14:50:10 +01009226 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009227 p += 3;
9228
Gilles Peskine449bd832023-01-11 14:50:10 +01009229 if (session->ticket_len != 0) {
9230 if (session->ticket_len > (size_t) (end - p)) {
9231 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9232 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009233
Gilles Peskine449bd832023-01-11 14:50:10 +01009234 session->ticket = mbedtls_calloc(1, session->ticket_len);
9235 if (session->ticket == NULL) {
9236 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9237 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009238
Gilles Peskine449bd832023-01-11 14:50:10 +01009239 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009240 p += session->ticket_len;
9241 }
9242
Gilles Peskine449bd832023-01-11 14:50:10 +01009243 if (4 > (size_t) (end - p)) {
9244 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9245 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009246
Gilles Peskine449bd832023-01-11 14:50:10 +01009247 session->ticket_lifetime = ((uint32_t) p[0] << 24) |
9248 ((uint32_t) p[1] << 16) |
9249 ((uint32_t) p[2] << 8) |
9250 ((uint32_t) p[3]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009251 p += 4;
9252#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9253
9254 /*
9255 * Misc extension-related info
9256 */
9257#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009258 if (1 > (size_t) (end - p)) {
9259 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9260 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009261
9262 session->mfl_code = *p++;
9263#endif
9264
9265#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009266 if (1 > (size_t) (end - p)) {
9267 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9268 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009269
9270 session->encrypt_then_mac = *p++;
9271#endif
9272
9273 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009274 if (p != end) {
9275 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9276 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009277
Gilles Peskine449bd832023-01-11 14:50:10 +01009278 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009279}
Jerry Yudc7bd172022-02-17 13:44:15 +08009280#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9281
XiaokangQian75d40ef2022-04-20 11:05:24 +00009282int mbedtls_ssl_validate_ciphersuite(
9283 const mbedtls_ssl_context *ssl,
9284 const mbedtls_ssl_ciphersuite_t *suite_info,
9285 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009286 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009287{
9288 (void) ssl;
9289
Gilles Peskine449bd832023-01-11 14:50:10 +01009290 if (suite_info == NULL) {
9291 return -1;
9292 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009293
Gilles Peskine449bd832023-01-11 14:50:10 +01009294 if ((suite_info->min_tls_version > max_tls_version) ||
9295 (suite_info->max_tls_version < min_tls_version)) {
9296 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009297 }
9298
XiaokangQian060d8672022-04-21 09:24:56 +00009299#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009300#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009301#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009302 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9303 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009304#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009305 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9306 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009307#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009308 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009309 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009310 }
9311#endif
9312
9313 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9314#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009315 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9316 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9317 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009318 }
9319#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9320#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9321
Gilles Peskine449bd832023-01-11 14:50:10 +01009322 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009323}
9324
Ronald Crone68ab4f2022-10-05 12:46:29 +02009325#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009326/*
9327 * Function for writing a signature algorithm extension.
9328 *
9329 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9330 * value (TLS 1.3 RFC8446):
9331 * enum {
9332 * ....
9333 * ecdsa_secp256r1_sha256( 0x0403 ),
9334 * ecdsa_secp384r1_sha384( 0x0503 ),
9335 * ecdsa_secp521r1_sha512( 0x0603 ),
9336 * ....
9337 * } SignatureScheme;
9338 *
9339 * struct {
9340 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9341 * } SignatureSchemeList;
9342 *
9343 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9344 * value (TLS 1.2 RFC5246):
9345 * enum {
9346 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9347 * sha512(6), (255)
9348 * } HashAlgorithm;
9349 *
9350 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9351 * SignatureAlgorithm;
9352 *
9353 * struct {
9354 * HashAlgorithm hash;
9355 * SignatureAlgorithm signature;
9356 * } SignatureAndHashAlgorithm;
9357 *
9358 * SignatureAndHashAlgorithm
9359 * supported_signature_algorithms<2..2^16-2>;
9360 *
9361 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9362 * generalization of the TLS 1.2 signature algorithm extension.
9363 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9364 * `SignatureScheme` field of TLS 1.3
9365 *
9366 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009367int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9368 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009369{
9370 unsigned char *p = buf;
9371 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9372 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9373
9374 *out_len = 0;
9375
Gilles Peskine449bd832023-01-11 14:50:10 +01009376 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009377
9378 /* Check if we have space for header and length field:
9379 * - extension_type (2 bytes)
9380 * - extension_data_length (2 bytes)
9381 * - supported_signature_algorithms_length (2 bytes)
9382 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009383 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009384 p += 6;
9385
9386 /*
9387 * Write supported_signature_algorithms
9388 */
9389 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009390 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9391 if (sig_alg == NULL) {
9392 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9393 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009394
Gilles Peskine449bd832023-01-11 14:50:10 +01009395 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9396 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9397 *sig_alg,
9398 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9399 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009400 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009401 }
9402 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9403 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009404 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009405 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9406 *sig_alg,
9407 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009408 }
9409
9410 /* Length of supported_signature_algorithms */
9411 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009412 if (supported_sig_alg_len == 0) {
9413 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9414 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009415 }
9416
Gilles Peskine449bd832023-01-11 14:50:10 +01009417 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9418 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9419 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009420
XiaokangQianeaf36512022-04-24 09:07:44 +00009421 *out_len = p - buf;
9422
9423#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009424 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009425#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009426
Gilles Peskine449bd832023-01-11 14:50:10 +01009427 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009428}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009429#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009430
XiaokangQian40a35232022-05-07 09:02:40 +00009431#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009432/*
9433 * mbedtls_ssl_parse_server_name_ext
9434 *
9435 * Structure of server_name extension:
9436 *
9437 * enum {
9438 * host_name(0), (255)
9439 * } NameType;
9440 * opaque HostName<1..2^16-1>;
9441 *
9442 * struct {
9443 * NameType name_type;
9444 * select (name_type) {
9445 * case host_name: HostName;
9446 * } name;
9447 * } ServerName;
9448 * struct {
9449 * ServerName server_name_list<1..2^16-1>
9450 * } ServerNameList;
9451 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009452MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009453int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9454 const unsigned char *buf,
9455 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009456{
9457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9458 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009459 size_t server_name_list_len, hostname_len;
9460 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009461
Gilles Peskine449bd832023-01-11 14:50:10 +01009462 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009463
Gilles Peskine449bd832023-01-11 14:50:10 +01009464 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9465 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009466 p += 2;
9467
Gilles Peskine449bd832023-01-11 14:50:10 +01009468 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009469 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009470 while (p < server_name_list_end) {
9471 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9472 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9473 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9474 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009475
Gilles Peskine449bd832023-01-11 14:50:10 +01009476 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009477 /* sni_name is intended to be used only during the parsing of the
9478 * ClientHello message (it is reset to NULL before the end of
9479 * the message parsing). Thus it is ok to just point to the
9480 * reception buffer and not make a copy of it.
9481 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009482 ssl->handshake->sni_name = p + 3;
9483 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009484 if (ssl->conf->f_sni == NULL) {
9485 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009486 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009487 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9488 ssl, p + 3, hostname_len);
9489 if (ret != 0) {
9490 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9491 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9492 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9493 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9494 }
9495 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009496 }
9497
9498 p += hostname_len + 3;
9499 }
9500
Gilles Peskine449bd832023-01-11 14:50:10 +01009501 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009502}
9503#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9504
XiaokangQianacb39922022-06-17 10:18:48 +00009505#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009506MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009507int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9508 const unsigned char *buf,
9509 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009510{
9511 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009512 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009513 const unsigned char *protocol_name_list;
9514 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009515 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009516
9517 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 if (ssl->conf->alpn_list == NULL) {
9519 return 0;
9520 }
XiaokangQianacb39922022-06-17 10:18:48 +00009521
9522 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009523 * RFC7301, section 3.1
9524 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009525 *
XiaokangQianc7403452022-06-23 03:24:12 +00009526 * struct {
9527 * ProtocolName protocol_name_list<2..2^16-1>
9528 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009529 */
9530
XiaokangQianc7403452022-06-23 03:24:12 +00009531 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009532 * protocol_name_list_len 2 bytes
9533 * protocol_name_len 1 bytes
9534 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009535 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009536 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009537
Gilles Peskine449bd832023-01-11 14:50:10 +01009538 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009539 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009540 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009541 protocol_name_list = p;
9542 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009543
9544 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009545 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009546 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009547 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9548 protocol_name_len);
9549 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009550 MBEDTLS_SSL_PEND_FATAL_ALERT(
9551 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009552 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9553 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009554 }
9555
9556 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009557 }
9558
9559 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009560 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9561 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009562 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009563 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009564 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009565 if (protocol_name_len == alpn_len &&
9566 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009567 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009568 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009569 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009570
9571 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009572 }
9573 }
9574
XiaokangQian95d5f542022-06-24 02:29:26 +00009575 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009576 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009577 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9578 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9579 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009580}
9581
Gilles Peskine449bd832023-01-11 14:50:10 +01009582int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9583 unsigned char *buf,
9584 unsigned char *end,
9585 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009586{
9587 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009588 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009589 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009590
Gilles Peskine449bd832023-01-11 14:50:10 +01009591 if (ssl->alpn_chosen == NULL) {
9592 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009593 }
9594
Gilles Peskine449bd832023-01-11 14:50:10 +01009595 protocol_name_len = strlen(ssl->alpn_chosen);
9596 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009597
Gilles Peskine449bd832023-01-11 14:50:10 +01009598 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009599 /*
9600 * 0 . 1 ext identifier
9601 * 2 . 3 ext length
9602 * 4 . 5 protocol list length
9603 * 6 . 6 protocol name length
9604 * 7 . 7+n protocol name
9605 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009606 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009607
XiaokangQian95d5f542022-06-24 02:29:26 +00009608 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009609
Gilles Peskine449bd832023-01-11 14:50:10 +01009610 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9611 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009612 /* Note: the length of the chosen protocol has been checked to be less
9613 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9614 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009615 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009616
Gilles Peskine449bd832023-01-11 14:50:10 +01009617 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009618
9619#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009620 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009621#endif
9622
Gilles Peskine449bd832023-01-11 14:50:10 +01009623 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009624}
9625#endif /* MBEDTLS_SSL_ALPN */
9626
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009627#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009628 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009629 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009630 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009631int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9632 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009633{
9634 /* Initialize to suppress unnecessary compiler warning */
9635 size_t hostname_len = 0;
9636
9637 /* Check if new hostname is valid before
9638 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009639 if (hostname != NULL) {
9640 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009641
Gilles Peskine449bd832023-01-11 14:50:10 +01009642 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9643 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9644 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009645 }
9646
9647 /* Now it's clear that we will overwrite the old hostname,
9648 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009649 if (session->hostname != NULL) {
9650 mbedtls_platform_zeroize(session->hostname,
9651 strlen(session->hostname));
9652 mbedtls_free(session->hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009653 }
9654
9655 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009656 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009657 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009658 } else {
9659 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9660 if (session->hostname == NULL) {
9661 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9662 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009663
Gilles Peskine449bd832023-01-11 14:50:10 +01009664 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009665 }
9666
Gilles Peskine449bd832023-01-11 14:50:10 +01009667 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009668}
Xiaokang Qian03409292022-10-12 02:49:52 +00009669#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9670 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009671 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009672 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009673
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009674#endif /* MBEDTLS_SSL_TLS_C */