blob: 876a32e31f3fcef0f9b3419e6d77d3c0a2b67bbd [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
SimonBd5800b72016-04-26 07:43:27 +010028#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010029
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000030#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010031#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010032#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000033#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040034
Janos Follath73c616b2019-12-18 15:07:04 +000035#include "mbedtls/debug.h"
36#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050037#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010038#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020039#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020040
Rich Evans00ab4702015-02-06 13:43:58 +000041#include <string.h>
42
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050043#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020044#include "md_psa.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050045#include "mbedtls/psa_util.h"
46#include "psa/crypto.h"
47#endif
48
Janos Follath23bdca02016-10-07 14:47:14 +010049#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000050#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020051#endif
52
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050053#if defined(MBEDTLS_USE_PSA_CRYPTO)
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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100422#if defined(MBEDTLS_MD_CAN_SHA256)
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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100431#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100432
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100433#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100434MBEDTLS_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);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100442#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100443
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
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100456#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100457static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100458#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100459
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100460#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100461static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100462#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100463
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)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100474#if defined(MBEDTLS_MD_CAN_SHA384)
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;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100478#endif /* MBEDTLS_MD_CAN_SHA384*/
479#if defined(MBEDTLS_MD_CAN_SHA256)
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;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100483#endif /* MBEDTLS_MD_CAN_SHA256*/
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
Jan Bruckner151f6422023-02-10 12:45:19 +0100594 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
595 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
596
Jerry Yu7a485c12022-10-31 13:08:18 +0800597 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800599
600 }
601
Gilles Peskine449bd832023-01-11 14:50:10 +0100602 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800603}
604
Gilles Peskine449bd832023-01-11 14:50:10 +0100605uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800606{
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800608}
609
Jerry Yud25cab02022-10-31 12:48:30 +0800610#if defined(MBEDTLS_DEBUG_C)
611static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800612 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800613 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
614 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
615 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
616 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
617 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
618 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
619 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
620 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
621 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
622 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
623 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
624 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
625 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
626 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
627 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
628 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
629 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
630 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
631 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
632 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
633 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
634 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
635 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
636 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
637 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
638 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100639 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
640 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800641};
642
Gilles Peskine449bd832023-01-11 14:50:10 +0100643static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800644 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
645 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
646 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
647 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
648 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
649 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
650 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
651 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
652 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
653 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
654 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
655 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
656 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
657 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
658 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
659 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
660 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
661 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
662 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
663 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
664 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
665 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
666 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
667 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
668 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
669 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
670 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100671 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
672 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800673};
674
Gilles Peskine449bd832023-01-11 14:50:10 +0100675const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800676{
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 return extension_name_table[
678 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800679}
680
Gilles Peskine449bd832023-01-11 14:50:10 +0100681static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800682{
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800684 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800690 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800692 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800694 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800696 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800698 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800700}
701
Gilles Peskine449bd832023-01-11 14:50:10 +0100702void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
703 int level, const char *file, int line,
704 int hs_msg_type, unsigned int extension_type,
705 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800706{
707 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100708 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800709 mbedtls_debug_print_msg(
710 ssl, level, file, line,
711 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100712 ssl_tls13_get_hs_msg_name(hs_msg_type),
713 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800714 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100715 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800716 return;
717 }
718
719 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800721 mbedtls_debug_print_msg(
722 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100723 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
724 mbedtls_ssl_get_extension_name(extension_type), extension_type,
725 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800726 return;
727 }
728
729 mbedtls_debug_print_msg(
730 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
732 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800733}
734
Gilles Peskine449bd832023-01-11 14:50:10 +0100735void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
736 int level, const char *file, int line,
737 int hs_msg_type, uint32_t extensions_mask,
738 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800739{
740
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 for (unsigned i = 0;
742 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
743 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800744 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800745 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100746 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800747 }
748}
749
Pengyu Lvee455c02023-01-12 14:37:24 +0800750#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
751#define ARRAY_LENGTH(a) (sizeof(a) / sizeof(*(a)))
752
753static const char *ticket_flag_name_table[] =
754{
755 [0] = "ALLOW_PSK_RESUMPTION",
756 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
757 [3] = "ALLOW_EARLY_DATA",
758};
759
Pengyu Lv4938a562023-01-16 11:28:49 +0800760void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
761 int level, const char *file, int line,
762 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800763{
764 size_t i;
765
766 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 "print ticket_flags (0x%02x)", flags);
768
769 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800770
771 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800772 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800773 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
774 ticket_flag_name_table[i]);
775 }
776 }
777}
778#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
779
Jerry Yud25cab02022-10-31 12:48:30 +0800780#endif /* MBEDTLS_DEBUG_C */
781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
783 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800784{
785 ((void) ciphersuite_info);
786
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100787#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800789 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100792#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800796#endif
797 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800799 return;
800 }
801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100806{
807 unsigned char hs_hdr[4];
808
809 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
811 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
812 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
813 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100815 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100816}
817
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100819 unsigned hs_type,
820 unsigned char const *msg,
821 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100822{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 int ret;
824 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100825 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100826 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100827 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100828 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100829}
830
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100831int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100833#if defined(MBEDTLS_MD_CAN_SHA256) || \
834 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835#if defined(MBEDTLS_USE_PSA_CRYPTO)
836 psa_status_t status;
837#else
838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
839#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100840#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800841 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100842#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100843#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800844#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100845 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
846 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200847 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 }
849 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
850 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200851 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100852 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800853#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100854 mbedtls_md_free(&ssl->handshake->fin_sha256);
855 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100856 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
857 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
858 0);
859 if (ret != 0) {
860 return ret;
861 }
862 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100863 if (ret != 0) {
864 return ret;
865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#endif
867#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100868#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800869#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100870 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
871 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200872 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100873 }
874 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
875 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200876 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100879 mbedtls_md_free(&ssl->handshake->fin_sha384);
880 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100881 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
882 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
883 if (ret != 0) {
884 return ret;
885 }
886 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100887 if (ret != 0) {
888 return ret;
889 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800890#endif
891#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100892 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800893}
894
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100895static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100896 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800897{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256) || \
899 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900#if defined(MBEDTLS_USE_PSA_CRYPTO)
901 psa_status_t status;
902#else
903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
904#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100905#else /* SHA-256 or SHA-384 */
906 ((void) ssl);
907 (void) buf;
908 (void) len;
909#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100910#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800911#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100912 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
913 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200914 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100915 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800916#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100917 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100918 if (ret != 0) {
919 return ret;
920 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800921#endif
922#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100923#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800924#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100925 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
926 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200927 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100928 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800929#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100930 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100931 if (ret != 0) {
932 return ret;
933 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#endif
935#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100936 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800937}
938
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100939#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100940static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100941 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800942{
943#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200944 return mbedtls_md_error_from_psa(psa_hash_update(
945 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800946#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100947 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800948#endif
949}
950#endif
951
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100952#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100953static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100954 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800955{
956#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200957 return mbedtls_md_error_from_psa(psa_hash_update(
958 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800959#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100960 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800961#endif
962}
963#endif
964
Gilles Peskine449bd832023-01-11 14:50:10 +0100965static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200966{
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200968
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100969#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#if defined(MBEDTLS_USE_PSA_CRYPTO)
971 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500972#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100973 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200974#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500975#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100976#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500977#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500978 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500979#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100980 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200981#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500982#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200983
984 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200988#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200989#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200991#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200992#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200993#if defined(MBEDTLS_USE_PSA_CRYPTO)
994 handshake->psa_pake_ctx = psa_pake_operation_init();
995 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
996#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200998#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200999#if defined(MBEDTLS_SSL_CLI_C)
1000 handshake->ecjpake_cache = NULL;
1001 handshake->ecjpake_cache_len = 0;
1002#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001003#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001004
Gilles Peskineeccd8882020-03-10 12:19:08 +01001005#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001007#endif
1008
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001009#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1010 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1011#endif
Hanno Becker75173122019-02-06 16:18:31 +00001012
1013#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1014 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001016#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001017}
1018
Gilles Peskine449bd832023-01-11 14:50:10 +01001019void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001020{
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001022
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001023#if defined(MBEDTLS_USE_PSA_CRYPTO)
1024 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1025 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001026#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001027 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1028 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001029#endif
1030
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001031#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001032#if defined(MBEDTLS_USE_PSA_CRYPTO)
1033 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1034 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001035#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 mbedtls_md_init(&transform->md_ctx_enc);
1037 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001038#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001039#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001040}
1041
Gilles Peskine449bd832023-01-11 14:50:10 +01001042void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001043{
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001045}
1046
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001047MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001048static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001049{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001050 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1051
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001052 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001053#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001054 if (ssl->transform_negotiate) {
1055 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1056 }
Jerry Yu2e199812022-12-01 18:57:19 +08001057#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 if (ssl->session_negotiate) {
1059 mbedtls_ssl_session_free(ssl->session_negotiate);
1060 }
1061 if (ssl->handshake) {
1062 mbedtls_ssl_handshake_free(ssl);
1063 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001064
Jerry Yu2e199812022-12-01 18:57:19 +08001065#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001066 /*
1067 * Either the pointers are now NULL or cleared properly and can be freed.
1068 * Now allocate missing structures.
1069 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 if (ssl->transform_negotiate == NULL) {
1071 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001072 }
Jerry Yu2e199812022-12-01 18:57:19 +08001073#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001074
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 if (ssl->session_negotiate == NULL) {
1076 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001077 }
Paul Bakker48916f92012-09-16 19:57:18 +00001078
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 if (ssl->handshake == NULL) {
1080 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001081 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001082#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1083 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001084
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1086 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001087#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001088
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001089 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001091#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001092 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001093#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 ssl->session_negotiate == NULL) {
1095 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001098 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001099
1100#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001102 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001103#endif
1104
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001106 ssl->session_negotiate = NULL;
1107
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001109 }
1110
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001111 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 mbedtls_ssl_session_init(ssl->session_negotiate);
1113 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001114
Jerry Yu2e199812022-12-01 18:57:19 +08001115#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001117#endif
1118
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001119 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001120 ret = mbedtls_ssl_reset_checksum(ssl);
1121 if (ret != 0) {
1122 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1123 return ret;
1124 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001125
Jerry Yud0766ec2022-09-22 10:46:57 +08001126#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1127 defined(MBEDTLS_SSL_SRV_C) && \
1128 defined(MBEDTLS_SSL_SESSION_TICKETS)
1129 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001131#endif
1132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001133#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001135 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001136
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001138 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001140 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001142
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001144 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001145#endif
1146
Brett Warrene0edc842021-08-17 09:53:13 +01001147/*
1148 * curve_list is translated to IANA TLS group identifiers here because
1149 * mbedtls_ssl_conf_curves returns void and so can't return
1150 * any error codes.
1151 */
Valerio Setti6c496a12023-04-07 15:53:51 +02001152#if defined(MBEDTLS_ECP_LIGHT)
Brett Warrene0edc842021-08-17 09:53:13 +01001153#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1154 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001156 size_t length;
1157 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1158
Thomas Daubney850a0792023-05-22 12:05:03 +01001159 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 }
Brett Warrene0edc842021-08-17 09:53:13 +01001161
1162 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001163 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1164 if (group_list == NULL) {
1165 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1166 }
Brett Warrene0edc842021-08-17 09:53:13 +01001167
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001169 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 curve_list[i]);
1171 if (tls_id == 0) {
1172 mbedtls_free(group_list);
1173 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001174 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001175 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001176 }
1177
1178 group_list[length] = 0;
1179
1180 ssl->handshake->group_list = group_list;
1181 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001183 ssl->handshake->group_list = ssl->conf->group_list;
1184 ssl->handshake->group_list_heap_allocated = 0;
1185 }
1186#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6c496a12023-04-07 15:53:51 +02001187#endif /* MBEDTLS_ECP_LIGHT */
Brett Warrene0edc842021-08-17 09:53:13 +01001188
Ronald Crone68ab4f2022-10-05 12:46:29 +02001189#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001190#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001191#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001192 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1193 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1195 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001196 const int *md;
1197 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001198 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001199 uint16_t *p;
1200
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001201 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1202 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1203 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001204
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1206 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001207 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 }
Valerio Setti75fba322023-02-23 17:35:09 +01001209#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001211#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001212
Jerry Yub476a442022-01-21 18:14:45 +08001213#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001215#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1217 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1218 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001219 }
1220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1222 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1223 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001224
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1226 sizeof(uint16_t));
1227 if (ssl->handshake->sig_algs == NULL) {
1228 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1229 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001230
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 p = (uint16_t *) ssl->handshake->sig_algs;
1232 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1233 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1234 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001235 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 }
Valerio Setti75fba322023-02-23 17:35:09 +01001237#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001240#endif
1241#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001243 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001244#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001245 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001246 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001247 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001249#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001250 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001251 ssl->handshake->sig_algs_heap_allocated = 0;
1252 }
Jerry Yucc539102022-06-27 16:27:35 +08001253#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001254#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001255 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001256}
1257
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001258#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001259/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001260MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001261static int ssl_cookie_write_dummy(void *ctx,
1262 unsigned char **p, unsigned char *end,
1263 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001264{
1265 ((void) ctx);
1266 ((void) p);
1267 ((void) end);
1268 ((void) cli_id);
1269 ((void) cli_id_len);
1270
Gilles Peskine449bd832023-01-11 14:50:10 +01001271 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001272}
1273
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001274MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001275static int ssl_cookie_check_dummy(void *ctx,
1276 const unsigned char *cookie, size_t cookie_len,
1277 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001278{
1279 ((void) ctx);
1280 ((void) cookie);
1281 ((void) cookie_len);
1282 ((void) cli_id);
1283 ((void) cli_id_len);
1284
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001286}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001287#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001288
Paul Bakker5121ce52009-01-03 21:22:43 +00001289/*
1290 * Initialize an SSL context
1291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001292void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001293{
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001295}
1296
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001297MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001298static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001299{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001300 const mbedtls_ssl_config *conf = ssl->conf;
1301
Ronald Cron6f135e12021-12-08 16:57:54 +01001302#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1304 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1305 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1306 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001307 }
1308
Gilles Peskine449bd832023-01-11 14:50:10 +01001309 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1310 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001311 }
1312#endif
1313
1314#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1316 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1317 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001318 }
1319#endif
1320
Ronald Cron6f135e12021-12-08 16:57:54 +01001321#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1323 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1324 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1325 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001326 }
1327
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1329 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001330 }
1331#endif
1332
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1334 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001335}
1336
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001337MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001338static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1339{
1340 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 ret = ssl_conf_version_check(ssl);
1342 if (ret != 0) {
1343 return ret;
1344 }
Jerry Yu60835a82021-08-04 10:13:52 +08001345
Jerry Yudef7ae42022-10-30 14:13:19 +08001346#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1347 /* RFC 8446 section 4.4.3
1348 *
1349 * If the verification fails, the receiver MUST terminate the handshake with
1350 * a "decrypt_error" alert.
1351 *
1352 * If the client is configured as TLS 1.3 only with optional verify, return
1353 * bad config.
1354 *
1355 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1357 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001358 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1359 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1360 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001362 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 1, ("Optional verify auth mode "
1364 "is not available for TLS 1.3 client"));
1365 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001366 }
1367#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1368
Jerry Yu60835a82021-08-04 10:13:52 +08001369 /* Space for further checks */
1370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001372}
1373
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001374/*
1375 * Setup an SSL context
1376 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001377
Gilles Peskine449bd832023-01-11 14:50:10 +01001378int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1379 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001380{
Janos Follath865b3eb2019-12-16 11:46:15 +00001381 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001382 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1383 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001384
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001385 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001386
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 if ((ret = ssl_conf_check(ssl)) != 0) {
1388 return ret;
1389 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001390 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001391
Paul Bakker62f2dee2012-09-28 07:31:51 +00001392 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001393 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001394 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001395
1396 /* Set to NULL in case of an error condition */
1397 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001398
Darryl Greenb33cc762019-11-28 14:29:44 +00001399#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1400 ssl->in_buf_len = in_buf_len;
1401#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1403 if (ssl->in_buf == NULL) {
1404 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001405 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001406 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001407 }
1408
Darryl Greenb33cc762019-11-28 14:29:44 +00001409#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1410 ssl->out_buf_len = out_buf_len;
1411#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1413 if (ssl->out_buf == NULL) {
1414 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001415 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001416 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001417 }
1418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001420
Johan Pascalb62bb512015-12-03 21:56:45 +01001421#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001423#endif
1424
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001426 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001428
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001430
1431error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 mbedtls_free(ssl->in_buf);
1433 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001434
1435 ssl->conf = NULL;
1436
Darryl Greenb33cc762019-11-28 14:29:44 +00001437#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1438 ssl->in_buf_len = 0;
1439 ssl->out_buf_len = 0;
1440#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001441 ssl->in_buf = NULL;
1442 ssl->out_buf = NULL;
1443
1444 ssl->in_hdr = NULL;
1445 ssl->in_ctr = NULL;
1446 ssl->in_len = NULL;
1447 ssl->in_iv = NULL;
1448 ssl->in_msg = NULL;
1449
1450 ssl->out_hdr = NULL;
1451 ssl->out_ctr = NULL;
1452 ssl->out_len = NULL;
1453 ssl->out_iv = NULL;
1454 ssl->out_msg = NULL;
1455
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001457}
1458
1459/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001460 * Reset an initialized and used SSL context for re-use while retaining
1461 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001462 *
1463 * If partial is non-zero, keep data in the input buffer and client ID.
1464 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001465 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001466void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1467 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001468{
Darryl Greenb33cc762019-11-28 14:29:44 +00001469#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1470 size_t in_buf_len = ssl->in_buf_len;
1471 size_t out_buf_len = ssl->out_buf_len;
1472#else
1473 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1474 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1475#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001476
Hanno Beckerb0302c42021-08-03 09:39:42 +01001477#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1478 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001479#endif
1480
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001481 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001482 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001483
Gilles Peskine449bd832023-01-11 14:50:10 +01001484 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001485
1486 /* Reset incoming message parsing */
1487 ssl->in_offt = NULL;
1488 ssl->nb_zero = 0;
1489 ssl->in_msgtype = 0;
1490 ssl->in_msglen = 0;
1491 ssl->in_hslen = 0;
1492 ssl->keep_current_message = 0;
1493 ssl->transform_in = NULL;
1494
1495#if defined(MBEDTLS_SSL_PROTO_DTLS)
1496 ssl->next_record_offset = 0;
1497 ssl->in_epoch = 0;
1498#endif
1499
1500 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001502 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001504 }
1505
Ronald Cronad8c17b2022-06-10 17:18:09 +02001506 ssl->send_alert = 0;
1507
Hanno Beckerb0302c42021-08-03 09:39:42 +01001508 /* Reset outgoing message writing */
1509 ssl->out_msgtype = 0;
1510 ssl->out_msglen = 0;
1511 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 memset(ssl->out_buf, 0, out_buf_len);
1513 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001514 ssl->transform_out = NULL;
1515
1516#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001518#endif
1519
XiaokangQian2b01dc32022-01-21 02:53:13 +00001520#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 if (ssl->transform) {
1522 mbedtls_ssl_transform_free(ssl->transform);
1523 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001524 ssl->transform = NULL;
1525 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001526#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1527
XiaokangQian2b01dc32022-01-21 02:53:13 +00001528#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 mbedtls_ssl_transform_free(ssl->transform_application);
1530 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531 ssl->transform_application = NULL;
1532
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001534#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1536 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001537 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001538#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001539
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1541 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001542 ssl->handshake->transform_handshake = NULL;
1543 }
1544
XiaokangQian2b01dc32022-01-21 02:53:13 +00001545#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001546}
1547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001549{
1550 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1551
1552 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1553
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001555
1556 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557#if defined(MBEDTLS_SSL_RENEGOTIATION)
1558 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001559 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001560
1561 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001562 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1563 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001564#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001565 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001566
Hanno Beckerb0302c42021-08-03 09:39:42 +01001567 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001568 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 if (ssl->session) {
1570 mbedtls_ssl_session_free(ssl->session);
1571 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001572 ssl->session = NULL;
1573 }
1574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001575#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001576 ssl->alpn_chosen = NULL;
1577#endif
1578
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001579#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001580 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001581#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001583#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 if (free_cli_id) {
1585 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001586 ssl->cli_id = NULL;
1587 ssl->cli_id_len = 0;
1588 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001589#endif
1590
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 if ((ret = ssl_handshake_init(ssl)) != 0) {
1592 return ret;
1593 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001594
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001596}
1597
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001598/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001599 * Reset an initialized and used SSL context for re-use while retaining
1600 * all application-set variables, function pointers and data.
1601 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001602int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001603{
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001605}
1606
1607/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001608 * SSL set accessors
1609 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001610void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001611{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001612 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001613}
1614
Gilles Peskine449bd832023-01-11 14:50:10 +01001615void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001616{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001617 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001618}
1619
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001620#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001621void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001622{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001623 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001624}
1625#endif
1626
Gilles Peskine449bd832023-01-11 14:50:10 +01001627void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001628{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001629 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001630}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001631
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001632#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1635 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001636{
1637 ssl->disable_datagram_packing = !allow_packing;
1638}
1639
Gilles Peskine449bd832023-01-11 14:50:10 +01001640void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1641 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001642{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001643 conf->hs_timeout_min = min;
1644 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001645}
1646#endif
1647
Gilles Peskine449bd832023-01-11 14:50:10 +01001648void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001649{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001650 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001651}
1652
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001653#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001654void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1655 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1656 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001657{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001658 conf->f_vrfy = f_vrfy;
1659 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001660}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001661#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001662
Gilles Peskine449bd832023-01-11 14:50:10 +01001663void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1664 int (*f_rng)(void *, unsigned char *, size_t),
1665 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001666{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001667 conf->f_rng = f_rng;
1668 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001669}
1670
Gilles Peskine449bd832023-01-11 14:50:10 +01001671void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1672 void (*f_dbg)(void *, int, const char *, int, const char *),
1673 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001674{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001675 conf->f_dbg = f_dbg;
1676 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001677}
1678
Gilles Peskine449bd832023-01-11 14:50:10 +01001679void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1680 void *p_bio,
1681 mbedtls_ssl_send_t *f_send,
1682 mbedtls_ssl_recv_t *f_recv,
1683 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001684{
1685 ssl->p_bio = p_bio;
1686 ssl->f_send = f_send;
1687 ssl->f_recv = f_recv;
1688 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001689}
1690
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001691#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001692void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001693{
1694 ssl->mtu = mtu;
1695}
1696#endif
1697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001699{
1700 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001701}
1702
Gilles Peskine449bd832023-01-11 14:50:10 +01001703void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1704 void *p_timer,
1705 mbedtls_ssl_set_timer_t *f_set_timer,
1706 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001707{
1708 ssl->p_timer = p_timer;
1709 ssl->f_set_timer = f_set_timer;
1710 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001711
1712 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001713 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001714}
1715
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001717void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1718 void *p_cache,
1719 mbedtls_ssl_cache_get_t *f_get_cache,
1720 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001721{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001722 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001723 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001724 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001725}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001726#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001729int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001730{
Janos Follath865b3eb2019-12-16 11:46:15 +00001731 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001732
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001734 session == NULL ||
1735 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001738 }
1739
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 if (ssl->handshake->resume == 1) {
1741 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1742 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001743
Jerry Yu21092062022-10-10 21:21:31 +08001744#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001746 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001748
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001750 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1752 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1753 session->ciphersuite));
1754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001755 }
Jerry Yu40afab62022-10-08 10:42:13 +08001756 }
Jerry Yu21092062022-10-10 21:21:31 +08001757#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001758
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1760 session)) != 0) {
1761 return ret;
1762 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001763
Paul Bakker0a597072012-09-25 21:55:46 +00001764 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001765
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001767}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001768#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001769
Gilles Peskine449bd832023-01-11 14:50:10 +01001770void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1771 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001772{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001773 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001774}
1775
Ronald Cron6f135e12021-12-08 16:57:54 +01001776#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001777void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1778 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001779{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001780 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001781}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001782
1783#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001784void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
1785 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001786{
1787 conf->early_data_enabled = early_data_enabled;
1788}
Jerry Yucc4e0072022-11-22 17:22:22 +08001789
1790#if defined(MBEDTLS_SSL_SRV_C)
1791void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001793{
Jerry Yu39da9852022-12-06 16:58:36 +08001794 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001795}
1796#endif /* MBEDTLS_SSL_SRV_C */
1797
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001798#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001799#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001800
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001802void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1803 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001804{
1805 conf->cert_profile = profile;
1806}
1807
Gilles Peskine449bd832023-01-11 14:50:10 +01001808static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001809{
1810 mbedtls_ssl_key_cert *cur = key_cert, *next;
1811
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001813 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001815 cur = next;
1816 }
1817}
1818
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001819/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001820MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001821static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1822 mbedtls_x509_crt *cert,
1823 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001824{
niisato8ee24222018-06-25 19:05:48 +09001825 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001826
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001828 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001830 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001832 }
1833
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1835 if (new_cert == NULL) {
1836 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1837 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001838
niisato8ee24222018-06-25 19:05:48 +09001839 new_cert->cert = cert;
1840 new_cert->key = key;
1841 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001842
Glenn Strauss36872db2022-01-22 05:06:31 -05001843 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001845 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001847 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001849 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 }
niisato8ee24222018-06-25 19:05:48 +09001851 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001852 }
1853
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001855}
1856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001858 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001860{
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001862}
1863
Gilles Peskine449bd832023-01-11 14:50:10 +01001864void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001865 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001867{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001868 conf->ca_chain = ca_chain;
1869 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001870
1871#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1872 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1873 * cannot be used together. */
1874 conf->f_ca_cb = NULL;
1875 conf->p_ca_cb = NULL;
1876#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001877}
Hanno Becker5adaad92019-03-27 16:54:37 +00001878
1879#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001880void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1881 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1882 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001883{
1884 conf->f_ca_cb = f_ca_cb;
1885 conf->p_ca_cb = p_ca_cb;
1886
1887 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1888 * cannot be used together. */
1889 conf->ca_chain = NULL;
1890 conf->ca_crl = NULL;
1891}
1892#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001893#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001894
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001895#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001896const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1897 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001898{
1899 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001901}
1902
Gilles Peskine449bd832023-01-11 14:50:10 +01001903int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1904 mbedtls_x509_crt *own_cert,
1905 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001906{
Gilles Peskine449bd832023-01-11 14:50:10 +01001907 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1908 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001909}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001910
Gilles Peskine449bd832023-01-11 14:50:10 +01001911void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1912 mbedtls_x509_crt *ca_chain,
1913 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001914{
1915 ssl->handshake->sni_ca_chain = ca_chain;
1916 ssl->handshake->sni_ca_crl = ca_crl;
1917}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001918
Glenn Strauss999ef702022-03-11 01:37:23 -05001919#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001920void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1921 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001922{
1923 ssl->handshake->dn_hints = crt;
1924}
1925#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1926
Gilles Peskine449bd832023-01-11 14:50:10 +01001927void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1928 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001929{
1930 ssl->handshake->sni_authmode = authmode;
1931}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001932#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1933
Hanno Becker8927c832019-04-03 12:52:50 +01001934#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001935void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1936 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1937 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001938{
1939 ssl->f_vrfy = f_vrfy;
1940 ssl->p_vrfy = p_vrfy;
1941}
1942#endif
1943
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001944#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001945
Valerio Setti016f6822022-12-09 14:17:50 +01001946#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001947static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1948static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1949
Valerio Setti016f6822022-12-09 14:17:50 +01001950static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 mbedtls_ssl_context *ssl,
1952 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001953{
1954 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001955 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001956 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001957 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001958 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001959 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1961 psa_pake_cs_set_primitive(&cipher_suite,
1962 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1963 PSA_ECC_FAMILY_SECP_R1,
1964 256));
1965 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1968 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001969 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001971
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001973 user = jpake_server_id;
1974 user_len = sizeof(jpake_server_id);
1975 peer = jpake_client_id;
1976 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001978 user = jpake_client_id;
1979 user_len = sizeof(jpake_client_id);
1980 peer = jpake_server_id;
1981 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001983
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001984 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1985 if (status != PSA_SUCCESS) {
1986 return status;
1987 }
1988
1989 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001991 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 }
Valerio Setti016f6822022-12-09 14:17:50 +01001993
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1995 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001996 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 }
Valerio Setti016f6822022-12-09 14:17:50 +01001998
1999 ssl->handshake->psa_pake_ctx_is_ok = 1;
2000
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002002}
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2005 const unsigned char *pw,
2006 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002007{
2008 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2009 psa_status_t status;
2010
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 if (ssl->handshake == NULL || ssl->conf == NULL) {
2012 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002013 }
2014
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 /* Empty password is not valid */
2016 if ((pw == NULL) || (pw_len == 0)) {
2017 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2018 }
2019
2020 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2021 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2022 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2023
2024 status = psa_import_key(&attributes, pw, pw_len,
2025 &ssl->handshake->psa_pake_password);
2026 if (status != PSA_SUCCESS) {
2027 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2028 }
2029
2030 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2031 ssl->handshake->psa_pake_password);
2032 if (status != PSA_SUCCESS) {
2033 psa_destroy_key(ssl->handshake->psa_pake_password);
2034 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2035 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2036 }
2037
2038 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002039}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2042 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002043{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002044 psa_status_t status;
2045
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 if (ssl->handshake == NULL || ssl->conf == NULL) {
2047 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002048 }
2049
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 if (mbedtls_svc_key_id_is_null(pwd)) {
2051 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2052 }
2053
2054 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2055 if (status != PSA_SUCCESS) {
2056 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2057 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2058 }
2059
2060 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002061}
2062#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002063int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2064 const unsigned char *pw,
2065 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002066{
2067 mbedtls_ecjpake_role role;
2068
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if (ssl->handshake == NULL || ssl->conf == NULL) {
2070 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2071 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002072
Valerio Settic689ed82022-12-07 14:40:38 +01002073 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 if ((pw == NULL) || (pw_len == 0)) {
2075 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2076 }
Valerio Settic689ed82022-12-07 14:40:38 +01002077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002079 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002083
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2085 role,
2086 MBEDTLS_MD_SHA256,
2087 MBEDTLS_ECP_DP_SECP256R1,
2088 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002089}
Valerio Setti02c25b52022-11-15 14:08:42 +01002090#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002091#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002092
Ronald Cron73fe8df2022-10-05 14:31:43 +02002093#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002094int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002095{
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 if (conf->psk_identity == NULL ||
2097 conf->psk_identity_len == 0) {
2098 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002099 }
2100
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002101#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2103 return 1;
2104 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002105#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002106
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (conf->psk != NULL && conf->psk_len != 0) {
2108 return 1;
2109 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002110
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002112}
2113
Gilles Peskine449bd832023-01-11 14:50:10 +01002114static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002115{
2116 /* Remove reference to existing PSK, if any. */
2117#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002119 /* The maintenance of the PSK key slot is the
2120 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002121 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002123#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 if (conf->psk != NULL) {
2125 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 mbedtls_free(conf->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002128 conf->psk = NULL;
2129 conf->psk_len = 0;
2130 }
2131
2132 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 if (conf->psk_identity != NULL) {
2134 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002135 conf->psk_identity = NULL;
2136 conf->psk_identity_len = 0;
2137 }
2138}
2139
Hanno Becker7390c712018-11-15 13:33:04 +00002140/* This function assumes that PSK identity in the SSL config is unset.
2141 * It checks that the provided identity is well-formed and attempts
2142 * to make a copy of it in the SSL config.
2143 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002144MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002145static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2146 unsigned char const *psk_identity,
2147 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002148{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002149 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002151 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 (psk_identity_len >> 16) != 0 ||
2153 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2154 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002155 }
2156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2158 if (conf->psk_identity == NULL) {
2159 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2160 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002161
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002162 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002164
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002166}
2167
Gilles Peskine449bd832023-01-11 14:50:10 +01002168int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2169 const unsigned char *psk, size_t psk_len,
2170 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002171{
Janos Follath865b3eb2019-12-16 11:46:15 +00002172 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002173
2174 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2176 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2177 }
Hanno Becker7390c712018-11-15 13:33:04 +00002178
2179 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 if (psk == NULL) {
2181 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2182 }
2183 if (psk_len == 0) {
2184 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2185 }
2186 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2187 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2188 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002189
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2191 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2192 }
Hanno Becker7390c712018-11-15 13:33:04 +00002193 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002195
2196 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2198 if (ret != 0) {
2199 ssl_conf_remove_psk(conf);
2200 }
Hanno Becker7390c712018-11-15 13:33:04 +00002201
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002203}
2204
Gilles Peskine449bd832023-01-11 14:50:10 +01002205static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002206{
2207#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002209 /* The maintenance of the external PSK key slot is the
2210 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 if (ssl->handshake->psk_opaque_is_internal) {
2212 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002213 ssl->handshake->psk_opaque_is_internal = 0;
2214 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002215 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002216 }
Neil Armstronge952a302022-05-03 10:22:14 +02002217#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 if (ssl->handshake->psk != NULL) {
2219 mbedtls_platform_zeroize(ssl->handshake->psk,
2220 ssl->handshake->psk_len);
2221 mbedtls_free(ssl->handshake->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002222 ssl->handshake->psk_len = 0;
2223 }
Neil Armstronge952a302022-05-03 10:22:14 +02002224#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002225}
2226
Gilles Peskine449bd832023-01-11 14:50:10 +01002227int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2228 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002229{
Neil Armstrong501c9322022-05-03 09:35:09 +02002230#if defined(MBEDTLS_USE_PSA_CRYPTO)
2231 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002232 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002233 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002234 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002235#endif /* MBEDTLS_USE_PSA_CRYPTO */
2236
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 if (psk == NULL || ssl->handshake == NULL) {
2238 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2239 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002240
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2242 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2243 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002244
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002246
Neil Armstrong501c9322022-05-03 09:35:09 +02002247#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002248#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2250 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2251 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2252 } else {
2253 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2254 }
2255 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002256 }
2257#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002258
Jerry Yu568ec252022-07-22 21:27:34 +08002259#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2261 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2262 psa_set_key_usage_flags(&key_attributes,
2263 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002264 }
2265#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 psa_set_key_algorithm(&key_attributes, alg);
2268 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002269
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2271 if (status != PSA_SUCCESS) {
2272 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2273 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002274
2275 /* Allow calling psa_destroy_key() on psk remove */
2276 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002278#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2280 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2281 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002282
2283 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002285
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002287#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002288}
2289
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002290#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002291int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2292 mbedtls_svc_key_id_t psk,
2293 const unsigned char *psk_identity,
2294 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002295{
Janos Follath865b3eb2019-12-16 11:46:15 +00002296 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002297
2298 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2300 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2301 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002302
Hanno Becker7390c712018-11-15 13:33:04 +00002303 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 if (mbedtls_svc_key_id_is_null(psk)) {
2305 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2306 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002307 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002308
2309 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2311 psk_identity_len);
2312 if (ret != 0) {
2313 ssl_conf_remove_psk(conf);
2314 }
Hanno Becker7390c712018-11-15 13:33:04 +00002315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002317}
2318
Gilles Peskine449bd832023-01-11 14:50:10 +01002319int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2320 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002321{
Gilles Peskine449bd832023-01-11 14:50:10 +01002322 if ((mbedtls_svc_key_id_is_null(psk)) ||
2323 (ssl->handshake == NULL)) {
2324 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2325 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002326
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002328 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002330}
2331#endif /* MBEDTLS_USE_PSA_CRYPTO */
2332
Jerry Yu8897c072022-08-12 13:56:53 +08002333#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002334void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2335 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2336 size_t),
2337 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002338{
2339 conf->f_psk = f_psk;
2340 conf->p_psk = p_psk;
2341}
Jerry Yu8897c072022-08-12 13:56:53 +08002342#endif /* MBEDTLS_SSL_SRV_C */
2343
Ronald Cron73fe8df2022-10-05 14:31:43 +02002344#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002345
2346#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002347static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002349{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002350#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 if (alg == PSA_ALG_CBC_NO_PADDING) {
2352 return MBEDTLS_SSL_MODE_CBC;
2353 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002354#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 if (PSA_ALG_IS_AEAD(alg)) {
2356 return MBEDTLS_SSL_MODE_AEAD;
2357 }
2358 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002359}
2360
2361#else /* MBEDTLS_USE_PSA_CRYPTO */
2362
2363static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002365{
2366#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 if (mode == MBEDTLS_MODE_CBC) {
2368 return MBEDTLS_SSL_MODE_CBC;
2369 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002370#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2371
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002372#if defined(MBEDTLS_GCM_C) || \
2373 defined(MBEDTLS_CCM_C) || \
2374 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002376 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 mode == MBEDTLS_MODE_CHACHAPOLY) {
2378 return MBEDTLS_SSL_MODE_AEAD;
2379 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002380#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002383}
Gilles Peskine301711e2022-04-26 16:57:05 +02002384#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002385
Gilles Peskinee108d982022-04-26 16:50:40 +02002386static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2387 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002389{
2390#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2392 base_mode == MBEDTLS_SSL_MODE_CBC) {
2393 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002394 }
2395#else
2396 (void) encrypt_then_mac;
2397#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002399}
2400
Neil Armstrongab555e02022-04-04 11:07:59 +02002401mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403{
Gilles Peskinee108d982022-04-26 16:50:40 +02002404 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002405#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002407#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002409#endif
2410 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002411
Gilles Peskinee108d982022-04-26 16:50:40 +02002412 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002413#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002414 encrypt_then_mac = transform->encrypt_then_mac;
2415#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002417}
2418
Neil Armstrongab555e02022-04-04 11:07:59 +02002419mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002420#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002422#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002424{
Gilles Peskinee108d982022-04-26 16:50:40 +02002425 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2426
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002427#if defined(MBEDTLS_USE_PSA_CRYPTO)
2428 psa_status_t status;
2429 psa_algorithm_t alg;
2430 psa_key_type_t type;
2431 size_t size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 status = mbedtls_ssl_cipher_to_psa(suite->cipher, 0, &alg, &type, &size);
2433 if (status == PSA_SUCCESS) {
2434 base_mode = mbedtls_ssl_get_base_mode(alg);
2435 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002436#else
2437 const mbedtls_cipher_info_t *cipher =
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 mbedtls_cipher_info_from_type(suite->cipher);
2439 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002440 base_mode =
2441 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002443 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002444#endif /* MBEDTLS_USE_PSA_CRYPTO */
2445
Gilles Peskinee108d982022-04-26 16:50:40 +02002446#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2447 int encrypt_then_mac = 0;
2448#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002450}
2451
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002452#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002453
2454#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002455/* Serialization of TLS 1.3 sessions:
2456 *
2457 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002458 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002459 * uint64 ticket_received;
2460 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002461 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002462 * } ClientOnlyData;
2463 *
2464 * struct {
2465 * uint8 endpoint;
2466 * uint8 ciphersuite[2];
2467 * uint32 ticket_age_add;
2468 * uint8 ticket_flags;
2469 * opaque resumption_key<0..255>;
2470 * select ( endpoint ) {
2471 * case client: ClientOnlyData;
2472 * case server: uint64 start_time;
2473 * };
2474 * } serialized_session_tls13;
2475 *
2476 */
2477#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002478MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002479static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2480 unsigned char *buf,
2481 size_t buf_len,
2482 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002483{
2484 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002485#if defined(MBEDTLS_SSL_CLI_C) && \
2486 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 size_t hostname_len = (session->hostname == NULL) ?
2488 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002489#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002490 size_t needed = 1 /* endpoint */
2491 + 2 /* ciphersuite */
2492 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002493 + 1 /* ticket_flags */
2494 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002495 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002496
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2498 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2499 }
Jerry Yu34191072022-08-18 10:32:09 +08002500 needed += session->resumption_key_len; /* resumption_key */
2501
Jerry Yu438ddd82022-07-07 06:55:50 +00002502#if defined(MBEDTLS_HAVE_TIME)
2503 needed += 8; /* start_time or ticket_received */
2504#endif
2505
2506#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002508#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002509 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002511#endif
2512
Jerry Yu438ddd82022-07-07 06:55:50 +00002513 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002514 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002515
2516 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 if (session->ticket_len > SIZE_MAX - needed) {
2518 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2519 }
Jerry Yu34191072022-08-18 10:32:09 +08002520
Jerry Yue28d9742022-08-18 15:44:03 +08002521 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002522 }
2523#endif /* MBEDTLS_SSL_CLI_C */
2524
Jerry Yue36fdd62022-08-17 21:31:36 +08002525 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002526 if (needed > buf_len) {
2527 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2528 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002529
2530 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2532 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002533 p[7] = session->ticket_flags;
2534
2535 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002536 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002537 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002539 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002540
2541#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2543 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002544 p += 8;
2545 }
2546#endif /* MBEDTLS_HAVE_TIME */
2547
2548#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002550#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002552 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002554 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002556 p += hostname_len;
2557 }
2558#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2559
Jerry Yu438ddd82022-07-07 06:55:50 +00002560#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002562 p += 8;
2563#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002565 p += 4;
2566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002568 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 if (session->ticket != NULL && session->ticket_len > 0) {
2571 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002572 p += session->ticket_len;
2573 }
2574 }
2575#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002577}
2578
2579MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002580static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2581 const unsigned char *buf,
2582 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002583{
2584 const unsigned char *p = buf;
2585 const unsigned char *end = buf + len;
2586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 if (end - p < 9) {
2588 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2589 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002590 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2592 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002593 session->ticket_flags = p[7];
2594
2595 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002596 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002597 p += 9;
2598
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 if (end - p < session->resumption_key_len) {
2600 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2601 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002602
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2604 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2605 }
2606 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002607 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002608
2609#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2611 if (end - p < 8) {
2612 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2613 }
2614 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002615 p += 8;
2616 }
2617#endif /* MBEDTLS_HAVE_TIME */
2618
2619#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002620 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002621#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002623 size_t hostname_len;
2624 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 if (end - p < 2) {
2626 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2627 }
2628 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002629 p += 2;
2630
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 if (end - p < (long int) hostname_len) {
2632 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2633 }
2634 if (hostname_len > 0) {
2635 session->hostname = mbedtls_calloc(1, hostname_len);
2636 if (session->hostname == NULL) {
2637 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2638 }
2639 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002640 p += hostname_len;
2641 }
2642#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2643 MBEDTLS_SSL_SESSION_TICKETS */
2644
Jerry Yu438ddd82022-07-07 06:55:50 +00002645#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 if (end - p < 8) {
2647 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2648 }
2649 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002650 p += 8;
2651#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 if (end - p < 4) {
2653 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2654 }
2655 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002656 p += 4;
2657
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 if (end - p < 2) {
2659 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2660 }
2661 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002662 p += 2;
2663
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 if (end - p < (long int) session->ticket_len) {
2665 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2666 }
2667 if (session->ticket_len > 0) {
2668 session->ticket = mbedtls_calloc(1, session->ticket_len);
2669 if (session->ticket == NULL) {
2670 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2671 }
2672 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002673 p += session->ticket_len;
2674 }
2675 }
2676#endif /* MBEDTLS_SSL_CLI_C */
2677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002679
2680}
2681#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002682MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002683static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2684 unsigned char *buf,
2685 size_t buf_len,
2686 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002687{
2688 ((void) session);
2689 ((void) buf);
2690 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002691 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002693}
Jerry Yu438ddd82022-07-07 06:55:50 +00002694
Gilles Peskine449bd832023-01-11 14:50:10 +01002695static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2696 unsigned char *buf,
2697 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002698{
2699 ((void) session);
2700 ((void) buf);
2701 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002703}
2704#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002705#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2706
Gilles Peskine449bd832023-01-11 14:50:10 +01002707psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2708 size_t taglen,
2709 psa_algorithm_t *alg,
2710 psa_key_type_t *key_type,
2711 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002712{
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002714 case MBEDTLS_CIPHER_AES_128_CBC:
2715 *alg = PSA_ALG_CBC_NO_PADDING;
2716 *key_type = PSA_KEY_TYPE_AES;
2717 *key_size = 128;
2718 break;
2719 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002721 *key_type = PSA_KEY_TYPE_AES;
2722 *key_size = 128;
2723 break;
2724 case MBEDTLS_CIPHER_AES_128_GCM:
2725 *alg = PSA_ALG_GCM;
2726 *key_type = PSA_KEY_TYPE_AES;
2727 *key_size = 128;
2728 break;
2729 case MBEDTLS_CIPHER_AES_192_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 = 192;
2733 break;
2734 case MBEDTLS_CIPHER_AES_192_GCM:
2735 *alg = PSA_ALG_GCM;
2736 *key_type = PSA_KEY_TYPE_AES;
2737 *key_size = 192;
2738 break;
2739 case MBEDTLS_CIPHER_AES_256_CBC:
2740 *alg = PSA_ALG_CBC_NO_PADDING;
2741 *key_type = PSA_KEY_TYPE_AES;
2742 *key_size = 256;
2743 break;
2744 case MBEDTLS_CIPHER_AES_256_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_AES;
2747 *key_size = 256;
2748 break;
2749 case MBEDTLS_CIPHER_AES_256_GCM:
2750 *alg = PSA_ALG_GCM;
2751 *key_type = PSA_KEY_TYPE_AES;
2752 *key_size = 256;
2753 break;
2754 case MBEDTLS_CIPHER_ARIA_128_CBC:
2755 *alg = PSA_ALG_CBC_NO_PADDING;
2756 *key_type = PSA_KEY_TYPE_ARIA;
2757 *key_size = 128;
2758 break;
2759 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002761 *key_type = PSA_KEY_TYPE_ARIA;
2762 *key_size = 128;
2763 break;
2764 case MBEDTLS_CIPHER_ARIA_128_GCM:
2765 *alg = PSA_ALG_GCM;
2766 *key_type = PSA_KEY_TYPE_ARIA;
2767 *key_size = 128;
2768 break;
2769 case MBEDTLS_CIPHER_ARIA_192_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 = 192;
2773 break;
2774 case MBEDTLS_CIPHER_ARIA_192_GCM:
2775 *alg = PSA_ALG_GCM;
2776 *key_type = PSA_KEY_TYPE_ARIA;
2777 *key_size = 192;
2778 break;
2779 case MBEDTLS_CIPHER_ARIA_256_CBC:
2780 *alg = PSA_ALG_CBC_NO_PADDING;
2781 *key_type = PSA_KEY_TYPE_ARIA;
2782 *key_size = 256;
2783 break;
2784 case MBEDTLS_CIPHER_ARIA_256_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_ARIA;
2787 *key_size = 256;
2788 break;
2789 case MBEDTLS_CIPHER_ARIA_256_GCM:
2790 *alg = PSA_ALG_GCM;
2791 *key_type = PSA_KEY_TYPE_ARIA;
2792 *key_size = 256;
2793 break;
2794 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2795 *alg = PSA_ALG_CBC_NO_PADDING;
2796 *key_type = PSA_KEY_TYPE_CAMELLIA;
2797 *key_size = 128;
2798 break;
2799 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002801 *key_type = PSA_KEY_TYPE_CAMELLIA;
2802 *key_size = 128;
2803 break;
2804 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2805 *alg = PSA_ALG_GCM;
2806 *key_type = PSA_KEY_TYPE_CAMELLIA;
2807 *key_size = 128;
2808 break;
2809 case MBEDTLS_CIPHER_CAMELLIA_192_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 = 192;
2813 break;
2814 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2815 *alg = PSA_ALG_GCM;
2816 *key_type = PSA_KEY_TYPE_CAMELLIA;
2817 *key_size = 192;
2818 break;
2819 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2820 *alg = PSA_ALG_CBC_NO_PADDING;
2821 *key_type = PSA_KEY_TYPE_CAMELLIA;
2822 *key_size = 256;
2823 break;
2824 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002826 *key_type = PSA_KEY_TYPE_CAMELLIA;
2827 *key_size = 256;
2828 break;
2829 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2830 *alg = PSA_ALG_GCM;
2831 *key_type = PSA_KEY_TYPE_CAMELLIA;
2832 *key_size = 256;
2833 break;
2834 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2835 *alg = PSA_ALG_CHACHA20_POLY1305;
2836 *key_type = PSA_KEY_TYPE_CHACHA20;
2837 *key_size = 256;
2838 break;
2839 case MBEDTLS_CIPHER_NULL:
2840 *alg = MBEDTLS_SSL_NULL_CIPHER;
2841 *key_type = 0;
2842 *key_size = 0;
2843 break;
2844 default:
2845 return PSA_ERROR_NOT_SUPPORTED;
2846 }
2847
2848 return PSA_SUCCESS;
2849}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002850#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002851
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002852#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002853int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2854 const unsigned char *dhm_P, size_t P_len,
2855 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002856{
Janos Follath865b3eb2019-12-16 11:46:15 +00002857 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002858
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 mbedtls_mpi_free(&conf->dhm_P);
2860 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002861
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2863 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2864 mbedtls_mpi_free(&conf->dhm_P);
2865 mbedtls_mpi_free(&conf->dhm_G);
2866 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002867 }
2868
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002870}
Paul Bakker5121ce52009-01-03 21:22:43 +00002871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002873{
Janos Follath865b3eb2019-12-16 11:46:15 +00002874 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 mbedtls_mpi_free(&conf->dhm_P);
2877 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002878
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2880 &conf->dhm_P)) != 0 ||
2881 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2882 &conf->dhm_G)) != 0) {
2883 mbedtls_mpi_free(&conf->dhm_P);
2884 mbedtls_mpi_free(&conf->dhm_G);
2885 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002886 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002887
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002889}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002890#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002891
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002892#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2893/*
2894 * Set the minimum length for Diffie-Hellman parameters
2895 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002896void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2897 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002898{
2899 conf->dhm_min_bitlen = bitlen;
2900}
2901#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2902
Ronald Crone68ab4f2022-10-05 12:46:29 +02002903#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002904#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002905/*
2906 * Set allowed/preferred hashes for handshake signatures
2907 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002908void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2909 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002910{
2911 conf->sig_hashes = hashes;
2912}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002913#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002914
Jerry Yuf017ee42022-01-12 15:49:48 +08002915/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002916void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2917 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002918{
Jerry Yuf017ee42022-01-12 15:49:48 +08002919#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2920 conf->sig_hashes = NULL;
2921#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2922 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002923}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002924#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002925
Valerio Setti6c496a12023-04-07 15:53:51 +02002926#if defined(MBEDTLS_ECP_LIGHT)
Brett Warrene0edc842021-08-17 09:53:13 +01002927#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002928/*
2929 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002930 *
2931 * mbedtls_ssl_setup() takes the provided list
2932 * and translates it to a list of IANA TLS group identifiers,
2933 * stored in ssl->handshake->group_list.
2934 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002935 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002936void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2937 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002938{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002939 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002940 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002941}
Brett Warrene0edc842021-08-17 09:53:13 +01002942#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6c496a12023-04-07 15:53:51 +02002943#endif /* MBEDTLS_ECP_LIGHT */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002944
Brett Warrene0edc842021-08-17 09:53:13 +01002945/*
2946 * Set the allowed groups
2947 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002948void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2949 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002950{
2951#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2952 conf->curve_list = NULL;
2953#endif
2954 conf->group_list = group_list;
2955}
2956
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002957#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002958int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002959{
Hanno Becker947194e2017-04-07 13:25:49 +01002960 /* Initialize to suppress unnecessary compiler warning */
2961 size_t hostname_len = 0;
2962
2963 /* Check if new hostname is valid before
2964 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 if (hostname != NULL) {
2966 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002967
Gilles Peskine449bd832023-01-11 14:50:10 +01002968 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2969 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2970 }
Hanno Becker947194e2017-04-07 13:25:49 +01002971 }
2972
2973 /* Now it's clear that we will overwrite the old hostname,
2974 * so we can free it safely */
2975
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (ssl->hostname != NULL) {
2977 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
2978 mbedtls_free(ssl->hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002979 }
2980
2981 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002984 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 } else {
2986 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2987 if (ssl->hostname == NULL) {
2988 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2989 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002990
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002992
Hanno Becker947194e2017-04-07 13:25:49 +01002993 ssl->hostname[hostname_len] = '\0';
2994 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002995
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002997}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002998#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002999
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003000#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003001void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3002 int (*f_sni)(void *, mbedtls_ssl_context *,
3003 const unsigned char *, size_t),
3004 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003005{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003006 conf->f_sni = f_sni;
3007 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003008}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003010
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003011#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003012int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003013{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003014 size_t cur_len, tot_len;
3015 const char **p;
3016
3017 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003018 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3019 * MUST NOT be truncated."
3020 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003021 */
3022 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 for (p = protos; *p != NULL; p++) {
3024 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003025 tot_len += cur_len;
3026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 if ((cur_len == 0) ||
3028 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3029 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3030 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3031 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003032 }
3033
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003034 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003035
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003037}
3038
Gilles Peskine449bd832023-01-11 14:50:10 +01003039const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003040{
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003042}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003044
Johan Pascalb62bb512015-12-03 21:56:45 +01003045#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003046void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3047 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003048{
3049 conf->dtls_srtp_mki_support = support_mki_value;
3050}
3051
Gilles Peskine449bd832023-01-11 14:50:10 +01003052int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3053 unsigned char *mki_value,
3054 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003055{
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3057 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003058 }
Ron Eldor591f1622018-01-22 12:30:04 +02003059
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3061 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003062 }
Ron Eldor591f1622018-01-22 12:30:04 +02003063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003065 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003067}
3068
Gilles Peskine449bd832023-01-11 14:50:10 +01003069int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3070 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003071{
Johan Pascal253d0262020-09-22 13:04:45 +02003072 const mbedtls_ssl_srtp_profile *p;
3073 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003074
Johan Pascal253d0262020-09-22 13:04:45 +02003075 /* check the profiles list: all entry must be valid,
3076 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3078 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3079 p++) {
3080 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003081 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003083 /* unsupported value, stop parsing and set the size to an error value */
3084 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003085 }
3086 }
3087
Gilles Peskine449bd832023-01-11 14:50:10 +01003088 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3089 conf->dtls_srtp_profile_list = NULL;
3090 conf->dtls_srtp_profile_list_len = 0;
3091 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003092 }
3093
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003094 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003095 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003096
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003098}
3099
Gilles Peskine449bd832023-01-11 14:50:10 +01003100void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3101 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003102{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003103 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3104 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003106 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003108 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3110 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003111 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003112}
Johan Pascalb62bb512015-12-03 21:56:45 +01003113#endif /* MBEDTLS_SSL_DTLS_SRTP */
3114
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303115#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003116void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003117{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003118 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00003119}
3120
Gilles Peskine449bd832023-01-11 14:50:10 +01003121void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003122{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003123 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00003124}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303125#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003126
Janos Follath088ce432017-04-10 12:42:31 +01003127#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003128void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3129 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003130{
3131 conf->cert_req_ca_list = cert_req_ca_list;
3132}
3133#endif
3134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003136void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003137{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003138 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003139}
3140#endif
3141
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003143void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003144{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003145 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003146}
3147#endif
3148
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003150int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003151{
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3153 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3154 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003155 }
3156
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003157 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003160}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003162
Gilles Peskine449bd832023-01-11 14:50:10 +01003163void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003164{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003165 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003166}
3167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003168#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003169void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003170{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003171 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003172}
3173
Gilles Peskine449bd832023-01-11 14:50:10 +01003174void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003175{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003176 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003177}
3178
Gilles Peskine449bd832023-01-11 14:50:10 +01003179void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3180 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003181{
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003183}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003184#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003187#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003188void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003189{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003190 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003191}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003192#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003193
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003194#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003195
Jerry Yud0766ec2022-09-22 10:46:57 +08003196#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003197void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3198 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003199{
Jerry Yud0766ec2022-09-22 10:46:57 +08003200 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003201}
3202#endif
3203
Gilles Peskine449bd832023-01-11 14:50:10 +01003204void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3205 mbedtls_ssl_ticket_write_t *f_ticket_write,
3206 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3207 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003208{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003209 conf->f_ticket_write = f_ticket_write;
3210 conf->f_ticket_parse = f_ticket_parse;
3211 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003212}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003213#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003214#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003215
Gilles Peskine449bd832023-01-11 14:50:10 +01003216void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3217 mbedtls_ssl_export_keys_t *f_export_keys,
3218 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003219{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003220 ssl->f_export_keys = f_export_keys;
3221 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003222}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003223
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003224#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003225void mbedtls_ssl_conf_async_private_cb(
3226 mbedtls_ssl_config *conf,
3227 mbedtls_ssl_async_sign_t *f_async_sign,
3228 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3229 mbedtls_ssl_async_resume_t *f_async_resume,
3230 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003232{
3233 conf->f_async_sign_start = f_async_sign;
3234 conf->f_async_decrypt_start = f_async_decrypt;
3235 conf->f_async_resume = f_async_resume;
3236 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003237 conf->p_async_config_data = async_config_data;
3238}
3239
Gilles Peskine449bd832023-01-11 14:50:10 +01003240void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003241{
Gilles Peskine449bd832023-01-11 14:50:10 +01003242 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003243}
3244
Gilles Peskine449bd832023-01-11 14:50:10 +01003245void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003246{
Gilles Peskine449bd832023-01-11 14:50:10 +01003247 if (ssl->handshake == NULL) {
3248 return NULL;
3249 } else {
3250 return ssl->handshake->user_async_ctx;
3251 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003252}
3253
Gilles Peskine449bd832023-01-11 14:50:10 +01003254void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3255 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003256{
Gilles Peskine449bd832023-01-11 14:50:10 +01003257 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003258 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003259 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003260}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003261#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003262
Paul Bakker5121ce52009-01-03 21:22:43 +00003263/*
3264 * SSL get accessors
3265 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003266uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003267{
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 if (ssl->session != NULL) {
3269 return ssl->session->verify_result;
3270 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003271
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 if (ssl->session_negotiate != NULL) {
3273 return ssl->session_negotiate->verify_result;
3274 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003275
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003277}
3278
Gilles Peskine449bd832023-01-11 14:50:10 +01003279int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003280{
Gilles Peskine449bd832023-01-11 14:50:10 +01003281 if (ssl == NULL || ssl->session == NULL) {
3282 return 0;
3283 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003284
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003286}
3287
Gilles Peskine449bd832023-01-11 14:50:10 +01003288const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003289{
Gilles Peskine449bd832023-01-11 14:50:10 +01003290 if (ssl == NULL || ssl->session == NULL) {
3291 return NULL;
3292 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003293
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003295}
3296
Gilles Peskine449bd832023-01-11 14:50:10 +01003297const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003298{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003300 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3301 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003302 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003303 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003304 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003306 }
3307 }
3308#endif
3309
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003311 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003313 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003315 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003317 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003318}
3319
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003320#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003321size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003322{
David Horstmann95d516f2021-05-04 18:36:56 +01003323 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003324 size_t read_mfl;
3325
Jerry Yuddda0502022-12-01 19:43:12 +08003326#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003327 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003328 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3329 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3330 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003331 }
Jerry Yuddda0502022-12-01 19:43:12 +08003332#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003333
3334 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003335 if (ssl->session_out != NULL) {
3336 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3337 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003338 max_len = read_mfl;
3339 }
3340 }
3341
Jerry Yuddda0502022-12-01 19:43:12 +08003342 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003343 if (ssl->session_negotiate != NULL) {
3344 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3345 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003346 max_len = read_mfl;
3347 }
3348 }
3349
Gilles Peskine449bd832023-01-11 14:50:10 +01003350 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003351}
3352
Gilles Peskine449bd832023-01-11 14:50:10 +01003353size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003354{
3355 size_t max_len;
3356
3357 /*
3358 * Assume mfl_code is correct since it was checked when set
3359 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003361
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003362 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003363 if (ssl->session_out != NULL &&
3364 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3365 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003366 }
3367
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003368 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003369 if (ssl->session_negotiate != NULL &&
3370 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3371 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003372 }
3373
Gilles Peskine449bd832023-01-11 14:50:10 +01003374 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003375}
3376#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3377
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003378#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003379size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003380{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003381 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3383 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3384 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3385 return 0;
3386 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003387
Gilles Peskine449bd832023-01-11 14:50:10 +01003388 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3389 return ssl->mtu;
3390 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003391
Gilles Peskine449bd832023-01-11 14:50:10 +01003392 if (ssl->mtu == 0) {
3393 return ssl->handshake->mtu;
3394 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003395
Gilles Peskine449bd832023-01-11 14:50:10 +01003396 return ssl->mtu < ssl->handshake->mtu ?
3397 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003398}
3399#endif /* MBEDTLS_SSL_PROTO_DTLS */
3400
Gilles Peskine449bd832023-01-11 14:50:10 +01003401int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003402{
3403 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3404
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003405#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3406 !defined(MBEDTLS_SSL_PROTO_DTLS)
3407 (void) ssl;
3408#endif
3409
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003410#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003411 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003412
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003414 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003415 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003416#endif
3417
3418#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003419 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3420 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3421 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003422 const size_t overhead = (size_t) ret;
3423
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 if (ret < 0) {
3425 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003426 }
3427
Gilles Peskine449bd832023-01-11 14:50:10 +01003428 if (mtu <= overhead) {
3429 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3430 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3431 }
3432
3433 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003434 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003435 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003436 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003437#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003438
Hanno Becker0defedb2018-08-10 12:35:02 +01003439#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3440 !defined(MBEDTLS_SSL_PROTO_DTLS)
3441 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003442#endif
3443
Gilles Peskine449bd832023-01-11 14:50:10 +01003444 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003445}
3446
Gilles Peskine449bd832023-01-11 14:50:10 +01003447int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003448{
3449 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3450
3451#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3452 (void) ssl;
3453#endif
3454
3455#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003456 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003457
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003459 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003460 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003461#endif
3462
Gilles Peskine449bd832023-01-11 14:50:10 +01003463 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003464}
3465
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003466#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003467const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003468{
Gilles Peskine449bd832023-01-11 14:50:10 +01003469 if (ssl == NULL || ssl->session == NULL) {
3470 return NULL;
3471 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003472
Hanno Beckere6824572019-02-07 13:18:46 +00003473#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003474 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003475#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003476 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003477#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003478}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003479#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003480
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003481#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003482int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3483 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003484{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003485 int ret;
3486
Gilles Peskine449bd832023-01-11 14:50:10 +01003487 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003488 dst == NULL ||
3489 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003490 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3491 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003492 }
3493
Hanno Beckere810bbc2021-05-14 16:01:05 +01003494 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3495 * idempotent: Each session can only be exported once.
3496 *
3497 * (This is in preparation for TLS 1.3 support where we will
3498 * need the ability to export multiple sessions (aka tickets),
3499 * which will be achieved by calling mbedtls_ssl_get_session()
3500 * multiple times until it fails.)
3501 *
3502 * Check whether we have already exported the current session,
3503 * and fail if so.
3504 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003505 if (ssl->session->exported == 1) {
3506 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3507 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003508
Gilles Peskine449bd832023-01-11 14:50:10 +01003509 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3510 if (ret != 0) {
3511 return ret;
3512 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003513
3514 /* Remember that we've exported the session. */
3515 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003516 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003517}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003518#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003519
Paul Bakker5121ce52009-01-03 21:22:43 +00003520/*
Hanno Beckera835da52019-05-16 12:39:07 +01003521 * Define ticket header determining Mbed TLS version
3522 * and structure of the ticket.
3523 */
3524
Hanno Becker94ef3b32019-05-16 12:50:45 +01003525/*
Hanno Becker50b59662019-05-28 14:30:45 +01003526 * Define bitflag determining compile-time settings influencing
3527 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003528 */
3529
Hanno Becker50b59662019-05-28 14:30:45 +01003530#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003531#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003532#else
Hanno Becker3e088662019-05-29 11:10:18 +01003533#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003534#endif /* MBEDTLS_HAVE_TIME */
3535
3536#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003537#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003538#else
Hanno Becker3e088662019-05-29 11:10:18 +01003539#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003540#endif /* MBEDTLS_X509_CRT_PARSE_C */
3541
3542#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003543#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003544#else
Hanno Becker3e088662019-05-29 11:10:18 +01003545#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003546#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3547
3548#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003549#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003550#else
Hanno Becker3e088662019-05-29 11:10:18 +01003551#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003552#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3553
Hanno Becker94ef3b32019-05-16 12:50:45 +01003554#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003555#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003556#else
Hanno Becker3e088662019-05-29 11:10:18 +01003557#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003558#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3559
Hanno Becker94ef3b32019-05-16 12:50:45 +01003560#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3561#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3562#else
3563#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3564#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3565
Hanno Becker3e088662019-05-29 11:10:18 +01003566#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3567#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3568#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3569#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003570#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3571#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003572
Hanno Becker50b59662019-05-28 14:30:45 +01003573#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003574 ((uint16_t) ( \
3575 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3576 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3577 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3578 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3579 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3580 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3581 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003582
Hanno Beckerf8787072019-05-16 12:41:07 +01003583static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003584 MBEDTLS_VERSION_MAJOR,
3585 MBEDTLS_VERSION_MINOR,
3586 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003587 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3588 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003589};
Hanno Beckera835da52019-05-16 12:39:07 +01003590
3591/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003592 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003593 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003594 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003595 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003596 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003597 * opaque mbedtls_version[3]; // library version: major, minor, patch
3598 * opaque session_format[2]; // library-version specific 16-bit field
3599 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003600 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003601 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003602 * Note: When updating the format, remember to keep
3603 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003604 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003605 * // In this version, `session_format` determines
3606 * // the setting of those compile-time
3607 * // configuration options which influence
3608 * // the structure of mbedtls_ssl_session.
3609 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003610 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003611 * // - TLS 1.2 (0x0303)
3612 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003613 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003614 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003615 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003616 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003617 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003618 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003619 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003620 *
3621 * };
3622 *
3623 * } serialized_session;
3624 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003625 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003626
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003627MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003628static int ssl_session_save(const mbedtls_ssl_session *session,
3629 unsigned char omit_header,
3630 unsigned char *buf,
3631 size_t buf_len,
3632 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003633{
3634 unsigned char *p = buf;
3635 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003636 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003637#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3638 size_t out_len;
3639 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3640#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003641 if (session == NULL) {
3642 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3643 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003644
Gilles Peskine449bd832023-01-11 14:50:10 +01003645 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003646 /*
3647 * Add Mbed TLS version identifier
3648 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003649 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003650
Gilles Peskine449bd832023-01-11 14:50:10 +01003651 if (used <= buf_len) {
3652 memcpy(p, ssl_serialized_session_header,
3653 sizeof(ssl_serialized_session_header));
3654 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003655 }
3656 }
3657
3658 /*
3659 * TLS version identifier
3660 */
3661 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003662 if (used <= buf_len) {
3663 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003664 }
3665
3666 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003667 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003668 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003669#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003670 case MBEDTLS_SSL_VERSION_TLS1_2:
3671 used += ssl_tls12_session_save(session, p, remaining_len);
3672 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003673#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3674
Jerry Yu251a12e2022-07-13 15:15:48 +08003675#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003676 case MBEDTLS_SSL_VERSION_TLS1_3:
3677 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3678 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3679 return ret;
3680 }
3681 used += out_len;
3682 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003683#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3684
Gilles Peskine449bd832023-01-11 14:50:10 +01003685 default:
3686 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003687 }
3688
3689 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003690 if (used > buf_len) {
3691 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3692 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003693
Gilles Peskine449bd832023-01-11 14:50:10 +01003694 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003695}
3696
3697/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003698 * Public wrapper for ssl_session_save()
3699 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003700int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3701 unsigned char *buf,
3702 size_t buf_len,
3703 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003704{
Gilles Peskine449bd832023-01-11 14:50:10 +01003705 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003706}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003707
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003708/*
3709 * Deserialize session, see mbedtls_ssl_session_save() for format.
3710 *
3711 * This internal version is wrapped by a public function that cleans up in
3712 * case of error, and has an extra option omit_header.
3713 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003714MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003715static int ssl_session_load(mbedtls_ssl_session *session,
3716 unsigned char omit_header,
3717 const unsigned char *buf,
3718 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003719{
3720 const unsigned char *p = buf;
3721 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003722 size_t remaining_len;
3723
3724
Gilles Peskine449bd832023-01-11 14:50:10 +01003725 if (session == NULL) {
3726 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3727 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003728
Gilles Peskine449bd832023-01-11 14:50:10 +01003729 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003730 /*
3731 * Check Mbed TLS version identifier
3732 */
3733
Gilles Peskine449bd832023-01-11 14:50:10 +01003734 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3735 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003736 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003737
3738 if (memcmp(p, ssl_serialized_session_header,
3739 sizeof(ssl_serialized_session_header)) != 0) {
3740 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3741 }
3742 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003743 }
3744
3745 /*
3746 * TLS version identifier
3747 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003748 if (1 > (size_t) (end - p)) {
3749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3750 }
Glenn Straussda7851c2022-03-14 13:29:48 -04003751 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003752
3753 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003754 remaining_len = (end - p);
3755 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003756#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003757 case MBEDTLS_SSL_VERSION_TLS1_2:
3758 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003759#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3760
Jerry Yu438ddd82022-07-07 06:55:50 +00003761#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003762 case MBEDTLS_SSL_VERSION_TLS1_3:
3763 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003764#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3765
Gilles Peskine449bd832023-01-11 14:50:10 +01003766 default:
3767 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003768 }
3769}
3770
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003771/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003772 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003773 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003774int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3775 const unsigned char *buf,
3776 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003777{
Gilles Peskine449bd832023-01-11 14:50:10 +01003778 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003779
Gilles Peskine449bd832023-01-11 14:50:10 +01003780 if (ret != 0) {
3781 mbedtls_ssl_session_free(session);
3782 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003783
Gilles Peskine449bd832023-01-11 14:50:10 +01003784 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003785}
3786
3787/*
Paul Bakker1961b702013-01-25 14:49:24 +01003788 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003789 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003790MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003791static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003792{
3793 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3794
Ronald Cron66dbf912022-02-02 15:33:46 +01003795 /*
3796 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003797 * that were written into the output buffer by the previous handshake step,
3798 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003799 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3800 * We proceed to the next handshake step only when all data from the
3801 * previous one have been sent to the peer, thus we make sure that this is
3802 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3803 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3804 * we have to wait before to go ahead.
3805 * In the case of TLS 1.3, handshake step handlers do not send data to the
3806 * peer. Data are only sent here and through
3807 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003808 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003809 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003810 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3811 return ret;
3812 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003813
3814#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003815 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3816 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3817 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3818 return ret;
3819 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003820 }
3821#endif /* MBEDTLS_SSL_PROTO_DTLS */
3822
Gilles Peskine449bd832023-01-11 14:50:10 +01003823 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003824}
3825
Gilles Peskine449bd832023-01-11 14:50:10 +01003826int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003827{
Hanno Becker41934dd2021-08-07 19:13:43 +01003828 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003829
Gilles Peskine449bd832023-01-11 14:50:10 +01003830 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003831 ssl->conf == NULL ||
3832 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003833 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3834 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003835 }
3836
Gilles Peskine449bd832023-01-11 14:50:10 +01003837 ret = ssl_prepare_handshake_step(ssl);
3838 if (ret != 0) {
3839 return ret;
3840 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003841
Gilles Peskine449bd832023-01-11 14:50:10 +01003842 ret = mbedtls_ssl_handle_pending_alert(ssl);
3843 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003844 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003845 }
Jerry Yue7047812021-09-13 19:26:39 +08003846
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003847 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3848 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3849 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3850
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003851#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003852 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3853 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
3854 mbedtls_ssl_states_str(ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003855
Gilles Peskine449bd832023-01-11 14:50:10 +01003856 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003857 case MBEDTLS_SSL_HELLO_REQUEST:
3858 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003859 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003860 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003861
Ronald Cron9f0fba32022-02-10 16:45:15 +01003862 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003863 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003864 break;
3865
3866 default:
3867#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003868 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3869 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3870 } else {
3871 ret = mbedtls_ssl_handshake_client_step(ssl);
3872 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003873#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003874 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003875#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003876 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003877#endif
3878 }
Jerry Yub9930e72021-08-06 17:11:51 +08003879 }
Ronald Cron6291b232023-03-08 15:51:25 +01003880#endif /* MBEDTLS_SSL_CLI_C */
3881
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003882#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003883 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003884#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3885 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003886 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003887 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003888 ret = mbedtls_ssl_handshake_server_step(ssl);
3889 }
Ronald Cron6291b232023-03-08 15:51:25 +01003890#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3891 ret = mbedtls_ssl_handshake_server_step(ssl);
3892#else
3893 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003894#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003895 }
3896#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003897
Gilles Peskine449bd832023-01-11 14:50:10 +01003898 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003899 /* handshake_step return error. And it is same
3900 * with alert_reason.
3901 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003902 if (ssl->send_alert) {
3903 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003904 goto cleanup;
3905 }
3906 }
3907
3908cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003909 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003910}
3911
3912/*
3913 * Perform the SSL handshake
3914 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003915int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003916{
3917 int ret = 0;
3918
Hanno Beckera817ea42020-10-20 15:20:23 +01003919 /* Sanity checks */
3920
Gilles Peskine449bd832023-01-11 14:50:10 +01003921 if (ssl == NULL || ssl->conf == NULL) {
3922 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3923 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003924
Hanno Beckera817ea42020-10-20 15:20:23 +01003925#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003926 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3927 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3928 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3929 "mbedtls_ssl_set_timer_cb() for DTLS"));
3930 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003931 }
3932#endif /* MBEDTLS_SSL_PROTO_DTLS */
3933
Gilles Peskine449bd832023-01-11 14:50:10 +01003934 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003935
Hanno Beckera817ea42020-10-20 15:20:23 +01003936 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003937 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3938 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003939
Gilles Peskine449bd832023-01-11 14:50:10 +01003940 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003941 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003942 }
Paul Bakker1961b702013-01-25 14:49:24 +01003943 }
3944
Gilles Peskine449bd832023-01-11 14:50:10 +01003945 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003946
Gilles Peskine449bd832023-01-11 14:50:10 +01003947 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003948}
3949
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003950#if defined(MBEDTLS_SSL_RENEGOTIATION)
3951#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003952/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003953 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003954 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003955MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003956static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003957{
Janos Follath865b3eb2019-12-16 11:46:15 +00003958 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003959
Gilles Peskine449bd832023-01-11 14:50:10 +01003960 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003961
3962 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003963 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3964 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003965
Gilles Peskine449bd832023-01-11 14:50:10 +01003966 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3967 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3968 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003969 }
3970
Gilles Peskine449bd832023-01-11 14:50:10 +01003971 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003972
Gilles Peskine449bd832023-01-11 14:50:10 +01003973 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003974}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003975#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003976
3977/*
3978 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003979 * - any side: calling mbedtls_ssl_renegotiate(),
3980 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3981 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003982 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003983 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003984 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003985 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003986int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003987{
Janos Follath865b3eb2019-12-16 11:46:15 +00003988 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003989
Gilles Peskine449bd832023-01-11 14:50:10 +01003990 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00003991
Gilles Peskine449bd832023-01-11 14:50:10 +01003992 if ((ret = ssl_handshake_init(ssl)) != 0) {
3993 return ret;
3994 }
Paul Bakker48916f92012-09-16 19:57:18 +00003995
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003996 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3997 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003998#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003999 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4000 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4001 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004002 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004004 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004006 }
4007#endif
4008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004009 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4010 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004011
Gilles Peskine449bd832023-01-11 14:50:10 +01004012 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4013 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4014 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004015 }
4016
Gilles Peskine449bd832023-01-11 14:50:10 +01004017 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004018
Gilles Peskine449bd832023-01-11 14:50:10 +01004019 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004020}
4021
4022/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004023 * Renegotiate current connection on client,
4024 * or request renegotiation on server
4025 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004026int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004027{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004028 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004029
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 if (ssl == NULL || ssl->conf == NULL) {
4031 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4032 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004033
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004034#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004035 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004036 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4037 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4038 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4039 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004041 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004042
4043 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004044 if (ssl->out_left != 0) {
4045 return mbedtls_ssl_flush_output(ssl);
4046 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004047
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004049 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004050#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004051
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004052#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004053 /*
4054 * On client, either start the renegotiation process or,
4055 * if already in progress, continue the handshake
4056 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4058 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004060 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004061
4062 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4063 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4064 return ret;
4065 }
4066 } else {
4067 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4068 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4069 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004070 }
4071 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004072#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004073
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004075}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004076#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004077
Gilles Peskine449bd832023-01-11 14:50:10 +01004078void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004079{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004080 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4081
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004083 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004085
Valerio Setti6c496a12023-04-07 15:53:51 +02004086#if defined(MBEDTLS_ECP_LIGHT)
Brett Warrene0edc842021-08-17 09:53:13 +01004087#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004088 if (ssl->handshake->group_list_heap_allocated) {
4089 mbedtls_free((void *) handshake->group_list);
4090 }
Brett Warrene0edc842021-08-17 09:53:13 +01004091 handshake->group_list = NULL;
4092#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6c496a12023-04-07 15:53:51 +02004093#endif /* MBEDTLS_ECP_LIGHT */
Brett Warrene0edc842021-08-17 09:53:13 +01004094
Ronald Crone68ab4f2022-10-05 12:46:29 +02004095#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004096#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 if (ssl->handshake->sig_algs_heap_allocated) {
4098 mbedtls_free((void *) handshake->sig_algs);
4099 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004100 handshake->sig_algs = NULL;
4101#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004102#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 if (ssl->handshake->certificate_request_context) {
4104 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004105 }
4106#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004107#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004108
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004109#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004110 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4111 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004112 handshake->async_in_progress = 0;
4113 }
4114#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4115
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004116#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004117#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004118 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004119#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004120 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004121#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004122#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004123#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004124#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004125 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004126#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004127 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004128#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004129#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004131#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004132 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004133#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02004134#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004135 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004136#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004137
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004138#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004139#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004141 /*
4142 * Opaque keys are not stored in the handshake's data and it's the user
4143 * responsibility to destroy them. Clear ones, instead, are created by
4144 * the TLS library and should be destroyed at the same level
4145 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4147 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004148 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004149 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4150#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004152#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004153#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004154 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004155 handshake->ecjpake_cache = NULL;
4156 handshake->ecjpake_cache_len = 0;
4157#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004158#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004159
Janos Follath4ae5c292016-02-10 11:27:43 +00004160#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4161 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004162 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004164#endif
4165
Ronald Cron73fe8df2022-10-05 14:31:43 +02004166#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004167#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004168 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004169 /* The maintenance of the external PSK key slot is the
4170 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 if (ssl->handshake->psk_opaque_is_internal) {
4172 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004173 ssl->handshake->psk_opaque_is_internal = 0;
4174 }
4175 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4176 }
Neil Armstronge952a302022-05-03 10:22:14 +02004177#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004178 if (handshake->psk != NULL) {
4179 mbedtls_platform_zeroize(handshake->psk, handshake->psk_len);
4180 mbedtls_free(handshake->psk);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004181 }
Neil Armstronge952a302022-05-03 10:22:14 +02004182#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004183#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004185#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4186 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004187 /*
4188 * Free only the linked list wrapper, not the keys themselves
4189 * since the belong to the SNI callback
4190 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004192#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004193
Gilles Peskineeccd8882020-03-10 12:19:08 +01004194#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4196 if (handshake->ecrs_peer_cert != NULL) {
4197 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4198 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004199 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004200#endif
4201
Hanno Becker75173122019-02-06 16:18:31 +00004202#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4203 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004205#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4206
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004207#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4209 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004210#endif /* MBEDTLS_SSL_CLI_C &&
4211 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004212
4213#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 mbedtls_ssl_flight_free(handshake->flight);
4215 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004216#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004217
Valerio Setti080a22b2023-03-20 15:22:47 +01004218#if defined(PSA_WANT_ALG_ECDH) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 (defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4220 if (handshake->ecdh_psa_privkey_is_external == 0) {
4221 psa_destroy_key(handshake->ecdh_psa_privkey);
4222 }
Valerio Setti080a22b2023-03-20 15:22:47 +01004223#endif /* PSA_WANT_ALG_ECDH && (MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3) */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004224
Ronald Cron6f135e12021-12-08 16:57:54 +01004225#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 mbedtls_ssl_transform_free(handshake->transform_handshake);
4227 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004228#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4230 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004231#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004232#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004233
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004234
4235#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4236 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4237 * processes datagrams and the fact that a datagram is allowed to have
4238 * several records in it, it is possible that the I/O buffers are not
4239 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004240 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4241 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004242#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004243
Jerry Yuba9c7272021-10-30 11:54:10 +08004244 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 mbedtls_platform_zeroize(handshake,
4246 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004247}
4248
Gilles Peskine449bd832023-01-11 14:50:10 +01004249void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004250{
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004252 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004254
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004255#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004257#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004258
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004259#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004260#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4261 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004263#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004265#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004266
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004268}
4269
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004270#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004271
4272#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4273#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4274#else
4275#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4276#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4277
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004278#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004279
4280#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4281#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4282#else
4283#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4284#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4285
4286#if defined(MBEDTLS_SSL_ALPN)
4287#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4288#else
4289#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4290#endif /* MBEDTLS_SSL_ALPN */
4291
4292#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4293#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4294#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4295#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4296
4297#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 ((uint32_t) ( \
4299 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4300 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4301 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4302 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4303 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4304 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4305 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4306 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004307
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004308static unsigned char ssl_serialized_context_header[] = {
4309 MBEDTLS_VERSION_MAJOR,
4310 MBEDTLS_VERSION_MINOR,
4311 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4313 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4314 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4315 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4316 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004317};
4318
Paul Bakker5121ce52009-01-03 21:22:43 +00004319/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004320 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004321 *
4322 * The format of the serialized data is:
4323 * (in the presentation language of TLS, RFC 8446 section 3)
4324 *
4325 * // header
4326 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004327 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004328 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004329 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004330 * Note: When updating the format, remember to keep these
4331 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004332 *
4333 * // session sub-structure
4334 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4335 * // transform sub-structure
4336 * uint8 random[64]; // ServerHello.random+ClientHello.random
4337 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4338 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4339 * // fields from ssl_context
4340 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4341 * uint64 in_window_top; // DTLS: last validated record seq_num
4342 * uint64 in_window; // DTLS: bitmask for replay protection
4343 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4344 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4345 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4346 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4347 *
4348 * Note that many fields of the ssl_context or sub-structures are not
4349 * serialized, as they fall in one of the following categories:
4350 *
4351 * 1. forced value (eg in_left must be 0)
4352 * 2. pointer to dynamically-allocated memory (eg session, transform)
4353 * 3. value can be re-derived from other data (eg session keys from MS)
4354 * 4. value was temporary (eg content of input buffer)
4355 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004357int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4358 unsigned char *buf,
4359 size_t buf_len,
4360 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004361{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004362 unsigned char *p = buf;
4363 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004364 size_t session_len;
4365 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004366
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004367 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004368 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4369 * this function's documentation.
4370 *
4371 * These are due to assumptions/limitations in the implementation. Some of
4372 * them are likely to stay (no handshake in progress) some might go away
4373 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004374 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004375 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4377 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4378 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004379 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 if (ssl->handshake != NULL) {
4381 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4382 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004383 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004384 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 if (ssl->transform == NULL || ssl->session == NULL) {
4386 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4387 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004388 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004389 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 if (mbedtls_ssl_check_pending(ssl) != 0) {
4391 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4392 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004393 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 if (ssl->out_left != 0) {
4395 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4396 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004397 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004398 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4400 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
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 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4405 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4406 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004407 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004408 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4410 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4411 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004412 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004413 /* Renegotiation must not be enabled */
4414#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4416 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4417 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004418 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004419#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004420
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004421 /*
4422 * Version and format identifier
4423 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004425
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 if (used <= buf_len) {
4427 memcpy(p, ssl_serialized_context_header,
4428 sizeof(ssl_serialized_context_header));
4429 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004430 }
4431
4432 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004433 * Session (length + data)
4434 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4436 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4437 return ret;
4438 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004439
4440 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 if (used <= buf_len) {
4442 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004443 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004444
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 ret = ssl_session_save(ssl->session, 1,
4446 p, session_len, &session_len);
4447 if (ret != 0) {
4448 return ret;
4449 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004450
4451 p += session_len;
4452 }
4453
4454 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004455 * Transform
4456 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 used += sizeof(ssl->transform->randbytes);
4458 if (used <= buf_len) {
4459 memcpy(p, ssl->transform->randbytes,
4460 sizeof(ssl->transform->randbytes));
4461 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004462 }
4463
4464#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4465 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004467 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004469 p += ssl->transform->in_cid_len;
4470
4471 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004473 p += ssl->transform->out_cid_len;
4474 }
4475#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4476
4477 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004478 * Saved fields from top-level ssl_context structure
4479 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004480 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 if (used <= buf_len) {
4482 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004483 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004484 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004485
4486#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4487 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 if (used <= buf_len) {
4489 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004490 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004491
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004493 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004494 }
4495#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4496
4497#if defined(MBEDTLS_SSL_PROTO_DTLS)
4498 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004500 *p++ = ssl->disable_datagram_packing;
4501 }
4502#endif /* MBEDTLS_SSL_PROTO_DTLS */
4503
Jerry Yuae0b2e22021-10-08 15:21:19 +08004504 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 if (used <= buf_len) {
4506 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004507 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004508 }
4509
4510#if defined(MBEDTLS_SSL_PROTO_DTLS)
4511 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 if (used <= buf_len) {
4513 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004514 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004515 }
4516#endif /* MBEDTLS_SSL_PROTO_DTLS */
4517
4518#if defined(MBEDTLS_SSL_ALPN)
4519 {
4520 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004522 : 0;
4523
4524 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004526 *p++ = alpn_len;
4527
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 if (ssl->alpn_chosen != NULL) {
4529 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004530 p += alpn_len;
4531 }
4532 }
4533 }
4534#endif /* MBEDTLS_SSL_ALPN */
4535
4536 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004537 * Done
4538 */
4539 *olen = used;
4540
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 if (used > buf_len) {
4542 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4543 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004544
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004548}
4549
4550/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004551 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004552 *
4553 * This internal version is wrapped by a public function that cleans up in
4554 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004555 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004556MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004557static int ssl_context_load(mbedtls_ssl_context *ssl,
4558 const unsigned char *buf,
4559 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004560{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004561 const unsigned char *p = buf;
4562 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004563 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004564 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004565#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004566 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004567#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004568
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004569 /*
4570 * The context should have been freshly setup or reset.
4571 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004572 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004573 * renegotiating, or if the user mistakenly loaded a session first.)
4574 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004575 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4576 ssl->session != NULL) {
4577 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004578 }
4579
4580 /*
4581 * We can't check that the config matches the initial one, but we can at
4582 * least check it matches the requirements for serializing.
4583 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004585 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4586 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004587#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004588 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004589#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 0) {
4591 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004592 }
4593
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004595
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004596 /*
4597 * Check version identifier
4598 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004599 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4600 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004601 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004602
4603 if (memcmp(p, ssl_serialized_context_header,
4604 sizeof(ssl_serialized_context_header)) != 0) {
4605 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4606 }
4607 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004608
4609 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004610 * Session
4611 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004612 if ((size_t) (end - p) < 4) {
4613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4614 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004615
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004616 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004617 p += 4;
4618
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004619 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004620 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004621 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004622 ssl->session_in = ssl->session;
4623 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004624 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004625
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 if ((size_t) (end - p) < session_len) {
4627 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4628 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004629
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 ret = ssl_session_load(ssl->session, 1, p, session_len);
4631 if (ret != 0) {
4632 mbedtls_ssl_session_free(ssl->session);
4633 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004634 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004635
4636 p += session_len;
4637
4638 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004639 * Transform
4640 */
4641
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004642 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004643 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004644#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004645 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004646 ssl->transform_in = ssl->transform;
4647 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004648 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004649#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004650
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004651#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4653 if (prf_func == NULL) {
4654 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4655 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004656
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004657 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4659 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4660 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004661
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 ret = ssl_tls12_populate_transform(ssl->transform,
4663 ssl->session->ciphersuite,
4664 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004665#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004667#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 prf_func,
4669 p, /* currently pointing to randbytes */
4670 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4671 ssl->conf->endpoint,
4672 ssl);
4673 if (ret != 0) {
4674 return ret;
4675 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004676#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004678
4679#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4680 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 if ((size_t) (end - p) < 1) {
4682 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4683 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004684
4685 ssl->transform->in_cid_len = *p++;
4686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4688 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4689 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004690
Gilles Peskine449bd832023-01-11 14:50:10 +01004691 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004692 p += ssl->transform->in_cid_len;
4693
4694 ssl->transform->out_cid_len = *p++;
4695
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4697 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4698 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004699
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004701 p += ssl->transform->out_cid_len;
4702#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4703
4704 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004705 * Saved fields from top-level ssl_context structure
4706 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 if ((size_t) (end - p) < 4) {
4708 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4709 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004710
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004711 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004712 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004713
4714#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 if ((size_t) (end - p) < 16) {
4716 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4717 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004718
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004719 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004720 p += 8;
4721
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004722 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004723 p += 8;
4724#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4725
4726#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 if ((size_t) (end - p) < 1) {
4728 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4729 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004730
4731 ssl->disable_datagram_packing = *p++;
4732#endif /* MBEDTLS_SSL_PROTO_DTLS */
4733
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4735 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4736 }
4737 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4738 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004739
4740#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if ((size_t) (end - p) < 2) {
4742 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4743 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004744
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004746 p += 2;
4747#endif /* MBEDTLS_SSL_PROTO_DTLS */
4748
4749#if defined(MBEDTLS_SSL_ALPN)
4750 {
4751 uint8_t alpn_len;
4752 const char **cur;
4753
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 if ((size_t) (end - p) < 1) {
4755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4756 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004757
4758 alpn_len = *p++;
4759
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004761 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4763 if (strlen(*cur) == alpn_len &&
4764 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004765 ssl->alpn_chosen = *cur;
4766 break;
4767 }
4768 }
4769 }
4770
4771 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4773 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4774 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004775
4776 p += alpn_len;
4777 }
4778#endif /* MBEDTLS_SSL_ALPN */
4779
4780 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004781 * Forced fields from top-level ssl_context structure
4782 *
4783 * Most of them already set to the correct value by mbedtls_ssl_init() and
4784 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4785 */
4786 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004787 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004788
Hanno Becker361b10d2019-08-30 10:42:49 +01004789 /* Adjust pointers for header fields of outgoing records to
4790 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004792
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004793#if defined(MBEDTLS_SSL_PROTO_DTLS)
4794 ssl->in_epoch = 1;
4795#endif
4796
4797 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4798 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004799 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4800 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 if (ssl->handshake != NULL) {
4802 mbedtls_ssl_handshake_free(ssl);
4803 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004804 ssl->handshake = NULL;
4805 }
4806
4807 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004808 * Done - should have consumed entire buffer
4809 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 if (p != end) {
4811 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4812 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004813
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004815}
4816
4817/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004818 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004819 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004820int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4821 const unsigned char *buf,
4822 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004823{
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004825
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (ret != 0) {
4827 mbedtls_ssl_free(context);
4828 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004831}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004832#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004833
4834/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004835 * Free an SSL context
4836 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004837void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004838{
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004840 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004842
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004844
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004846#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4847 size_t out_buf_len = ssl->out_buf_len;
4848#else
4849 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4850#endif
4851
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 mbedtls_platform_zeroize(ssl->out_buf, out_buf_len);
4853 mbedtls_free(ssl->out_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004854 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004855 }
4856
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004858#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4859 size_t in_buf_len = ssl->in_buf_len;
4860#else
4861 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4862#endif
4863
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 mbedtls_platform_zeroize(ssl->in_buf, in_buf_len);
4865 mbedtls_free(ssl->in_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004866 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004867 }
4868
Gilles Peskine449bd832023-01-11 14:50:10 +01004869 if (ssl->transform) {
4870 mbedtls_ssl_transform_free(ssl->transform);
4871 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004872 }
4873
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 if (ssl->handshake) {
4875 mbedtls_ssl_handshake_free(ssl);
4876 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004877
4878#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004879 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4880 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004881#endif
4882
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 mbedtls_ssl_session_free(ssl->session_negotiate);
4884 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004885 }
4886
Ronald Cron6f135e12021-12-08 16:57:54 +01004887#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 mbedtls_ssl_transform_free(ssl->transform_application);
4889 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004890#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004891
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 if (ssl->session) {
4893 mbedtls_ssl_session_free(ssl->session);
4894 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004895 }
4896
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004897#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 if (ssl->hostname != NULL) {
4899 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
4900 mbedtls_free(ssl->hostname);
Paul Bakker5121ce52009-01-03 21:22:43 +00004901 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004902#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004903
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004904#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004906#endif
4907
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004909
Paul Bakker86f04f42013-02-14 11:20:09 +01004910 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004912}
4913
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004914/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004915 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004916 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004917void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004918{
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004920}
4921
Gilles Peskineae270bf2021-06-02 00:05:29 +02004922/* The selection should be the same as mbedtls_x509_crt_profile_default in
4923 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004924 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004925 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004926 * about this list.
4927 */
Brett Warrene0edc842021-08-17 09:53:13 +01004928static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004929#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004930 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004931#endif
4932#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004933 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004934#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004935#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004936 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004937#endif
4938#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004939 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004940#endif
4941#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004942 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004943#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004944#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004945 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004946#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004947#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004948 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004949#endif
4950#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004951 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004952#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004953 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004954};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004955
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03004956static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004957 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4958 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4959 0
4960};
4961
Ronald Crone68ab4f2022-10-05 12:46:29 +02004962#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004963
Jerry Yu909df7b2022-01-22 11:56:27 +08004964/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004965 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004966 * rules SHOULD be upheld.
4967 * - No duplicate entries.
4968 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004969 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004970 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004971 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004972static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004973
Valerio Setti75fba322023-02-23 17:35:09 +01004974#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004975 defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004976 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4977 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004978#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA256 &&
Jerry Yued5e9f42022-01-26 11:21:34 +08004979 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004980
Valerio Setti75fba322023-02-23 17:35:09 +01004981#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004982 defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08004983 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4984 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004985#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004986 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4987
Valerio Setti75fba322023-02-23 17:35:09 +01004988#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004989 defined(MBEDTLS_MD_CAN_SHA512) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004990 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4991 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004992#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yued5e9f42022-01-26 11:21:34 +08004993 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004994
Gilles Peskine449bd832023-01-11 14:50:10 +01004995#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004996 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004997 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01004998#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004999 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005000
Gilles Peskine449bd832023-01-11 14:50:10 +01005001#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005002 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005003 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005004#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005005 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005006
Gilles Peskine449bd832023-01-11 14:50:10 +01005007#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005008 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005009 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005010#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005011 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005012
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005013#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005014 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005015#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005016
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005017#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005018 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005019#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005020
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005021#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005022 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005023#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005024
Gabor Mezei15b95a62022-05-09 16:37:58 +02005025 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005026};
5027
5028/* NOTICE: see above */
5029#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5030static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005031#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Setti75fba322023-02-23 17:35:09 +01005032#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005033 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005034#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005035#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5036 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5037#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005038#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005040#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005041#endif /* MBEDTLS_MD_CAN_SHA512*/
5042#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Setti75fba322023-02-23 17:35:09 +01005043#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005045#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005046#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5047 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5048#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005049#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005051#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005052#endif /* MBEDTLS_MD_CAN_SHA384*/
5053#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Setti75fba322023-02-23 17:35:09 +01005054#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005056#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005057#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5058 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5059#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005060#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005062#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005063#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005064 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005065};
5066#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5067/* NOTICE: see above */
5068static uint16_t ssl_preset_suiteb_sig_algs[] = {
5069
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005070#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08005071 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5072 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005073#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA256&&
Jerry Yu909df7b2022-01-22 11:56:27 +08005074 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
5075
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005076#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu53037892022-01-25 11:02:06 +08005077 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5078 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005079#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu53037892022-01-25 11:02:06 +08005080 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005081
Gilles Peskine449bd832023-01-11 14:50:10 +01005082#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005083 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005084 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005085#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005086 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005087
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005088#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005089 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005090#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005091
Gabor Mezei15b95a62022-05-09 16:37:58 +02005092 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005093};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005094
Jerry Yu909df7b2022-01-22 11:56:27 +08005095/* NOTICE: see above */
5096#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5097static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005098#if defined(MBEDTLS_MD_CAN_SHA256)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005099#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005101#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005102#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005104#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005105#endif /* MBEDTLS_MD_CAN_SHA256*/
5106#if defined(MBEDTLS_MD_CAN_SHA384)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005107#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005109#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005110#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005112#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005113#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005114 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005115};
Jerry Yu909df7b2022-01-22 11:56:27 +08005116#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5117
Ronald Crone68ab4f2022-10-05 12:46:29 +02005118#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005119
Brett Warrene0edc842021-08-17 09:53:13 +01005120static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01005121#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005122 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005123#endif
5124#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005125 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005126#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005127 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005128};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005129
Ronald Crone68ab4f2022-10-05 12:46:29 +02005130#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005131/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005132 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005133MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005134static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005135{
5136 size_t i, j;
5137 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005138
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5140 for (j = 0; j < i; j++) {
5141 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005142 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 }
5144 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5145 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5146 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005147 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005148 }
5149 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005150 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005151}
5152
Ronald Crone68ab4f2022-10-05 12:46:29 +02005153#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005154
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005155/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005156 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005157 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005158int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5159 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005160{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005161#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005162 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005163#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005164
Ronald Crone68ab4f2022-10-05 12:46:29 +02005165#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5167 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5168 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005169 }
5170
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5172 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5173 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005174 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005175
5176#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5178 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5179 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005180 }
5181
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5183 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5184 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005185 }
5186#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005187#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005188
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005189 /* Use the functions here so that they are covered in tests,
5190 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 mbedtls_ssl_conf_endpoint(conf, endpoint);
5192 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005193
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005194 /*
5195 * Things that are common to all presets
5196 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005197#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005199 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5200#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5201 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5202#endif
5203 }
5204#endif
5205
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005206#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5207 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5208#endif
5209
5210#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5211 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5212#endif
5213
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005214#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005215 conf->f_cookie_write = ssl_cookie_write_dummy;
5216 conf->f_cookie_check = ssl_cookie_check_dummy;
5217#endif
5218
5219#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5220 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5221#endif
5222
Janos Follath088ce432017-04-10 12:42:31 +01005223#if defined(MBEDTLS_SSL_SRV_C)
5224 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005225 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005226#endif
5227
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005228#if defined(MBEDTLS_SSL_PROTO_DTLS)
5229 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5230 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5231#endif
5232
5233#if defined(MBEDTLS_SSL_RENEGOTIATION)
5234 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 memset(conf->renego_period, 0x00, 2);
5236 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005237#endif
5238
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005239#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005241 const unsigned char dhm_p[] =
5242 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5243 const unsigned char dhm_g[] =
5244 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005245
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5247 dhm_p, sizeof(dhm_p),
5248 dhm_g, sizeof(dhm_g))) != 0) {
5249 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005250 }
5251 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005252#endif
5253
Ronald Cron6f135e12021-12-08 16:57:54 +01005254#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005255
5256#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 mbedtls_ssl_tls13_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005258#if defined(MBEDTLS_SSL_SRV_C)
5259 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005261#endif
5262#endif /* MBEDTLS_SSL_EARLY_DATA */
5263
Jerry Yud0766ec2022-09-22 10:46:57 +08005264#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005265 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005267#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005268 /*
5269 * Allow all TLS 1.3 key exchange modes by default.
5270 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005271 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005272#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005273
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005275#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005276 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005277 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005278#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005280#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005282#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005283 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5284 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005285#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5286 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5287 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5288#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5289 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5290 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5291#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005293#endif
5294 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005295
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005296 /*
5297 * Preset-specific defaults
5298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005300 /*
5301 * NSA Suite B
5302 */
5303 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005304
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005305 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005306
5307#if defined(MBEDTLS_X509_CRT_PARSE_C)
5308 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005309#endif
5310
Ronald Crone68ab4f2022-10-05 12:46:29 +02005311#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005312#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005314 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005316#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005318#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005319
Brett Warrene0edc842021-08-17 09:53:13 +01005320#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5321 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005322#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005323 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005324 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005325
5326 /*
5327 * Default
5328 */
5329 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005330
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005331 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005332
5333#if defined(MBEDTLS_X509_CRT_PARSE_C)
5334 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5335#endif
5336
Ronald Crone68ab4f2022-10-05 12:46:29 +02005337#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005338#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005340 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005342#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005344#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005345
Brett Warrene0edc842021-08-17 09:53:13 +01005346#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5347 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005348#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005349 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005350
5351#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5352 conf->dhm_min_bitlen = 1024;
5353#endif
5354 }
5355
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005357}
5358
5359/*
5360 * Free mbedtls_ssl_config
5361 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005362void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005363{
5364#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 mbedtls_mpi_free(&conf->dhm_P);
5366 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005367#endif
5368
Ronald Cron73fe8df2022-10-05 14:31:43 +02005369#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005370#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005372 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5373 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005374#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 if (conf->psk != NULL) {
5376 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
5377 mbedtls_free(conf->psk);
Azim Khan27e8a122018-03-21 14:24:11 +00005378 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005379 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005380 }
5381
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 if (conf->psk_identity != NULL) {
5383 mbedtls_platform_zeroize(conf->psk_identity, conf->psk_identity_len);
5384 mbedtls_free(conf->psk_identity);
Azim Khan27e8a122018-03-21 14:24:11 +00005385 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005386 conf->psk_identity_len = 0;
5387 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005388#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005389
5390#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005392#endif
5393
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005395}
5396
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005397#if defined(MBEDTLS_PK_C) && \
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005398 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_CAN_ECDSA_SOME))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005399/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005400 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005401 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005402unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005403{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005404#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5406 return MBEDTLS_SSL_SIG_RSA;
5407 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005408#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005409#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5411 return MBEDTLS_SSL_SIG_ECDSA;
5412 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005413#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005415}
5416
Gilles Peskine449bd832023-01-11 14:50:10 +01005417unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005418{
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005420 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005422 case MBEDTLS_PK_ECDSA:
5423 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005425 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005427 }
5428}
5429
Gilles Peskine449bd832023-01-11 14:50:10 +01005430mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005431{
Gilles Peskine449bd832023-01-11 14:50:10 +01005432 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005433#if defined(MBEDTLS_RSA_C)
5434 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005436#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005437#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005438 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005440#endif
5441 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005443 }
5444}
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005445#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_PK_CAN_ECDSA_SOME ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005446
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005447/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005448 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005449 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005450mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005451{
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005453#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005454 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005456#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005457#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005458 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005460#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005461#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005462 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005464#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005465#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005466 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005468#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005469#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005470 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005472#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005473#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005474 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005476#endif
5477 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005479 }
5480}
5481
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005482/*
5483 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5484 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005485unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005486{
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005488#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005489 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005491#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005492#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005493 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005495#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005496#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005497 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005499#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005500#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005501 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005503#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005504#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005505 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005507#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005508#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005509 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005510 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005511#endif
5512 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005514 }
5515}
5516
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005517/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005518 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005519 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005520 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005521int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005522{
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005524
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 if (group_list == NULL) {
5526 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005527 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005528
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 for (; *group_list != 0; group_list++) {
5530 if (*group_list == tls_id) {
5531 return 0;
5532 }
5533 }
5534
5535 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005536}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005537
Valerio Settid4a5d462023-04-05 18:19:01 +02005538#if defined(MBEDTLS_ECP_LIGHT)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005539/*
5540 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5541 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005542int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005543{
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005545
Gilles Peskine449bd832023-01-11 14:50:10 +01005546 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005547 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005549
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005551}
Valerio Settid4a5d462023-04-05 18:19:01 +02005552#endif /* MBEDTLS_ECP_LIGHT */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005553
Gilles Peskine449bd832023-01-11 14:50:10 +01005554#if defined(MBEDTLS_DEBUG_C)
Valerio Setti67419f02023-01-04 16:12:42 +01005555#define EC_NAME(_name_) _name_
5556#else
5557#define EC_NAME(_name_) NULL
5558#endif
5559
Valerio Setti18c9fed2022-12-30 17:44:24 +01005560static const struct {
5561 uint16_t tls_id;
5562 mbedtls_ecp_group_id ecp_group_id;
5563 psa_ecc_family_t psa_family;
5564 uint16_t bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 const char *name;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005566} tls_id_match_table[] =
5567{
5568#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521, EC_NAME("secp521r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005570#endif
5571#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512, EC_NAME("brainpoolP512r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005573#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005574#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384, EC_NAME("secp384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005576#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005577#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384, EC_NAME("brainpoolP384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005579#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005580#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256, EC_NAME("secp256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005582#endif
5583#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256, EC_NAME("secp256k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005585#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005586#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256, EC_NAME("brainpoolP256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005588#endif
5589#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224, EC_NAME("secp224r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005591#endif
5592#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224, EC_NAME("secp224k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005594#endif
5595#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192, EC_NAME("secp192r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005597#endif
5598#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192, EC_NAME("secp192k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005600#endif
5601#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255, EC_NAME("x25519") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005603#endif
5604#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448, EC_NAME("x448") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005606#endif
5607 { 0, MBEDTLS_ECP_DP_NONE, 0, 0, NULL },
5608};
5609
Gilles Peskine449bd832023-01-11 14:50:10 +01005610int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
5611 psa_ecc_family_t *family,
5612 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005613{
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5615 if (tls_id_match_table[i].tls_id == tls_id) {
5616 if (family != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005617 *family = tls_id_match_table[i].psa_family;
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 }
5619 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005620 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005622 return PSA_SUCCESS;
5623 }
5624 }
5625
5626 return PSA_ERROR_NOT_SUPPORTED;
5627}
5628
Gilles Peskine449bd832023-01-11 14:50:10 +01005629mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005630{
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5632 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005633 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005635 }
5636
5637 return MBEDTLS_ECP_DP_NONE;
5638}
5639
Gilles Peskine449bd832023-01-11 14:50:10 +01005640uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005641{
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5643 i++) {
5644 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005645 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005647 }
5648
5649 return 0;
5650}
5651
Valerio Setti67419f02023-01-04 16:12:42 +01005652#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005653const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005654{
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5656 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005657 return tls_id_match_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005659 }
5660
5661 return NULL;
5662}
Valerio Setti67419f02023-01-04 16:12:42 +01005663#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005664
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005665#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005666int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5667 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5668 int cert_endpoint,
5669 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005670{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005671 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005672 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005673 const char *ext_oid;
5674 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005675
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005677 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005679 case MBEDTLS_KEY_EXCHANGE_RSA:
5680 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005681 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005682 break;
5683
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005684 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5685 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5686 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5687 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005688 break;
5689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005690 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5691 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005692 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005693 break;
5694
5695 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005696 case MBEDTLS_KEY_EXCHANGE_NONE:
5697 case MBEDTLS_KEY_EXCHANGE_PSK:
5698 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5699 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005700 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005701 usage = 0;
5702 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005703 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005704 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5705 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005706 }
5707
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005709 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005710 ret = -1;
5711 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005712
Gilles Peskine449bd832023-01-11 14:50:10 +01005713 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005714 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5716 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005717 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005719 }
5720
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005722 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005723 ret = -1;
5724 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005725
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005727}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005728#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005729
Jerry Yu148165c2021-09-24 23:20:59 +08005730#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005731int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5732 const mbedtls_md_type_t md,
5733 unsigned char *dst,
5734 size_t dst_len,
5735 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005736{
Ronald Cronf6893e12022-01-07 22:09:01 +01005737 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5738 psa_hash_operation_t *hash_operation_to_clone;
5739 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5740
Jerry Yu148165c2021-09-24 23:20:59 +08005741 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005742
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005744#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 case MBEDTLS_MD_SHA384:
5746 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5747 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005748#endif
5749
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005750#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 case MBEDTLS_MD_SHA256:
5752 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5753 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005754#endif
5755
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 default:
5757 goto exit;
5758 }
5759
5760 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5761 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005762 goto exit;
5763 }
5764
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5766 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005767 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005768 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005769
5770exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005771#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5772 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005773 (void) ssl;
5774#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005775 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005776}
5777#else /* MBEDTLS_USE_PSA_CRYPTO */
5778
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005779#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005780MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005781static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5782 unsigned char *dst,
5783 size_t dst_len,
5784 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005785{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005786 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005787 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005788
Gilles Peskine449bd832023-01-11 14:50:10 +01005789 if (dst_len < 48) {
5790 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5791 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005792
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005793 mbedtls_md_init(&sha384);
5794 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005795 if (ret != 0) {
5796 goto exit;
5797 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005798 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005799 if (ret != 0) {
5800 goto exit;
5801 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005802
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005803 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005804 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005805 goto exit;
5806 }
5807
5808 *olen = 48;
5809
5810exit:
5811
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005812 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005814}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005815#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005816
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005817#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005818MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005819static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5820 unsigned char *dst,
5821 size_t dst_len,
5822 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005823{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005824 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005825 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005826
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 if (dst_len < 32) {
5828 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5829 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005830
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005831 mbedtls_md_init(&sha256);
5832 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5833 if (ret != 0) {
5834 goto exit;
5835 }
5836 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5837 if (ret != 0) {
5838 goto exit;
5839 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005840
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005841 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5842 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005843 goto exit;
5844 }
5845
5846 *olen = 32;
5847
5848exit:
5849
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005850 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005852}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005853#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005854
Gilles Peskine449bd832023-01-11 14:50:10 +01005855int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5856 const mbedtls_md_type_t md,
5857 unsigned char *dst,
5858 size_t dst_len,
5859 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005860{
Gilles Peskine449bd832023-01-11 14:50:10 +01005861 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005862
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005863#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 case MBEDTLS_MD_SHA384:
5865 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005866#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005867
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005868#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 case MBEDTLS_MD_SHA256:
5870 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005871#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005872
Gilles Peskine449bd832023-01-11 14:50:10 +01005873 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005874#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5875 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 (void) ssl;
5877 (void) dst;
5878 (void) dst_len;
5879 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005880#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005881 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005882 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005883 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005884}
XiaokangQian647719a2021-12-07 09:16:29 +00005885
Jerry Yu148165c2021-09-24 23:20:59 +08005886#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005887
Ronald Crone68ab4f2022-10-05 12:46:29 +02005888#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005889/* mbedtls_ssl_parse_sig_alg_ext()
5890 *
5891 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5892 * value (TLS 1.3 RFC8446):
5893 * enum {
5894 * ....
5895 * ecdsa_secp256r1_sha256( 0x0403 ),
5896 * ecdsa_secp384r1_sha384( 0x0503 ),
5897 * ecdsa_secp521r1_sha512( 0x0603 ),
5898 * ....
5899 * } SignatureScheme;
5900 *
5901 * struct {
5902 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5903 * } SignatureSchemeList;
5904 *
5905 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5906 * value (TLS 1.2 RFC5246):
5907 * enum {
5908 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5909 * sha512(6), (255)
5910 * } HashAlgorithm;
5911 *
5912 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5913 * SignatureAlgorithm;
5914 *
5915 * struct {
5916 * HashAlgorithm hash;
5917 * SignatureAlgorithm signature;
5918 * } SignatureAndHashAlgorithm;
5919 *
5920 * SignatureAndHashAlgorithm
5921 * supported_signature_algorithms<2..2^16-2>;
5922 *
5923 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5924 * generalization of the TLS 1.2 signature algorithm extension.
5925 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5926 * `SignatureScheme` field of TLS 1.3
5927 *
5928 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005929int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5930 const unsigned char *buf,
5931 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005932{
5933 const unsigned char *p = buf;
5934 size_t supported_sig_algs_len = 0;
5935 const unsigned char *supported_sig_algs_end;
5936 uint16_t sig_alg;
5937 uint32_t common_idx = 0;
5938
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5940 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005941 p += 2;
5942
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 memset(ssl->handshake->received_sig_algs, 0,
5944 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005945
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005947 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 while (p < supported_sig_algs_end) {
5949 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5950 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005951 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5953 sig_alg,
5954 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005955#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5957 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5958 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005959 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005960 }
5961#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005962
Gilles Peskine449bd832023-01-11 14:50:10 +01005963 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5964 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005965
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005967 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5968 common_idx += 1;
5969 }
5970 }
5971 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 if (p != end) {
5973 MBEDTLS_SSL_DEBUG_MSG(1,
5974 ("Signature algorithms extension length misaligned"));
5975 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5976 MBEDTLS_ERR_SSL_DECODE_ERROR);
5977 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02005978 }
5979
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 if (common_idx == 0) {
5981 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
5982 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5983 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
5984 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005985 }
5986
Gabor Mezei15b95a62022-05-09 16:37:58 +02005987 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02005989}
5990
Ronald Crone68ab4f2022-10-05 12:46:29 +02005991#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02005992
Jerry Yudc7bd172022-02-17 13:44:15 +08005993#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5994
5995#if defined(MBEDTLS_USE_PSA_CRYPTO)
5996
Gilles Peskine449bd832023-01-11 14:50:10 +01005997static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
5998 mbedtls_svc_key_id_t key,
5999 psa_algorithm_t alg,
6000 const unsigned char *raw_psk, size_t raw_psk_length,
6001 const unsigned char *seed, size_t seed_length,
6002 const unsigned char *label, size_t label_length,
6003 const unsigned char *other_secret,
6004 size_t other_secret_length,
6005 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006006{
6007 psa_status_t status;
6008
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 status = psa_key_derivation_setup(derivation, alg);
6010 if (status != PSA_SUCCESS) {
6011 return status;
6012 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006013
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6015 status = psa_key_derivation_input_bytes(derivation,
6016 PSA_KEY_DERIVATION_INPUT_SEED,
6017 seed, seed_length);
6018 if (status != PSA_SUCCESS) {
6019 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006020 }
6021
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 if (other_secret != NULL) {
6023 status = psa_key_derivation_input_bytes(derivation,
6024 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6025 other_secret, other_secret_length);
6026 if (status != PSA_SUCCESS) {
6027 return status;
6028 }
6029 }
6030
6031 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006032 status = psa_key_derivation_input_bytes(
6033 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 raw_psk, raw_psk_length);
6035 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006036 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006037 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006038 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 if (status != PSA_SUCCESS) {
6040 return status;
6041 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006042
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 status = psa_key_derivation_input_bytes(derivation,
6044 PSA_KEY_DERIVATION_INPUT_LABEL,
6045 label, label_length);
6046 if (status != PSA_SUCCESS) {
6047 return status;
6048 }
6049 } else {
6050 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006051 }
6052
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 status = psa_key_derivation_set_capacity(derivation, capacity);
6054 if (status != PSA_SUCCESS) {
6055 return status;
6056 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006057
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006059}
6060
Andrzej Kurek57d10632022-10-24 10:32:01 -04006061#if defined(PSA_WANT_ALG_SHA_384) || \
6062 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006063MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006064static int tls_prf_generic(mbedtls_md_type_t md_type,
6065 const unsigned char *secret, size_t slen,
6066 const char *label,
6067 const unsigned char *random, size_t rlen,
6068 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006069{
6070 psa_status_t status;
6071 psa_algorithm_t alg;
6072 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6073 psa_key_derivation_operation_t derivation =
6074 PSA_KEY_DERIVATION_OPERATION_INIT;
6075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006077 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006079 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006081
6082 /* Normally a "secret" should be long enough to be impossible to
6083 * find by brute force, and in particular should not be empty. But
6084 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6085 * and for this use case it makes sense to have a 0-length "secret".
6086 * Since the key API doesn't allow importing a key of length 0,
6087 * keep master_key=0, which setup_psa_key_derivation() understands
6088 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006090 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6092 psa_set_key_algorithm(&key_attributes, alg);
6093 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006094
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6096 if (status != PSA_SUCCESS) {
6097 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6098 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006099 }
6100
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 status = setup_psa_key_derivation(&derivation,
6102 master_key, alg,
6103 NULL, 0,
6104 random, rlen,
6105 (unsigned char const *) label,
6106 (size_t) strlen(label),
6107 NULL, 0,
6108 dlen);
6109 if (status != PSA_SUCCESS) {
6110 psa_key_derivation_abort(&derivation);
6111 psa_destroy_key(master_key);
6112 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006113 }
6114
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6116 if (status != PSA_SUCCESS) {
6117 psa_key_derivation_abort(&derivation);
6118 psa_destroy_key(master_key);
6119 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006120 }
6121
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 status = psa_key_derivation_abort(&derivation);
6123 if (status != PSA_SUCCESS) {
6124 psa_destroy_key(master_key);
6125 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006126 }
6127
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 if (!mbedtls_svc_key_id_is_null(master_key)) {
6129 status = psa_destroy_key(master_key);
6130 }
6131 if (status != PSA_SUCCESS) {
6132 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6133 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006134
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006136}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006137#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006138#else /* MBEDTLS_USE_PSA_CRYPTO */
6139
Andrzej Kurek57d10632022-10-24 10:32:01 -04006140#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006141 (defined(MBEDTLS_MD_CAN_SHA256) || \
6142 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006143MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006144static int tls_prf_generic(mbedtls_md_type_t md_type,
6145 const unsigned char *secret, size_t slen,
6146 const char *label,
6147 const unsigned char *random, size_t rlen,
6148 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006149{
6150 size_t nb;
6151 size_t i, j, k, md_len;
6152 unsigned char *tmp;
6153 size_t tmp_len = 0;
6154 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6155 const mbedtls_md_info_t *md_info;
6156 mbedtls_md_context_t md_ctx;
6157 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6158
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006160
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6162 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6163 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006164
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006166
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 tmp_len = md_len + strlen(label) + rlen;
6168 tmp = mbedtls_calloc(1, tmp_len);
6169 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006170 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6171 goto exit;
6172 }
6173
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 nb = strlen(label);
6175 memcpy(tmp + md_len, label, nb);
6176 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006177 nb += rlen;
6178
6179 /*
6180 * Compute P_<hash>(secret, label + random)[0..dlen]
6181 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006183 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006185
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6187 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006188 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 }
6190 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6191 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006192 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 }
6194 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6195 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006196 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006198
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 for (i = 0; i < dlen; i += md_len) {
6200 ret = mbedtls_md_hmac_reset(&md_ctx);
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_update(&md_ctx, tmp, md_len + nb);
6205 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006206 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 }
6208 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6209 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006210 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006212
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 ret = mbedtls_md_hmac_reset(&md_ctx);
6214 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006215 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 }
6217 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6218 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006219 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 }
6221 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6222 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006223 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006225
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006227
Gilles Peskine449bd832023-01-11 14:50:10 +01006228 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006229 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006231 }
6232
6233exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006235
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 if (tmp != NULL) {
6237 mbedtls_platform_zeroize(tmp, tmp_len);
6238 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006239
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006241
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006243
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006245}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006246#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006247#endif /* MBEDTLS_USE_PSA_CRYPTO */
6248
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006249#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006250MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006251static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6252 const char *label,
6253 const unsigned char *random, size_t rlen,
6254 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006255{
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6257 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006258}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006259#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006260
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006261#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006262MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006263static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6264 const char *label,
6265 const unsigned char *random, size_t rlen,
6266 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006267{
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6269 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006270}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006271#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006272
Jerry Yuf009d862022-02-17 14:01:37 +08006273/*
6274 * Set appropriate PRF function and other SSL / TLS1.2 functions
6275 *
6276 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006277 * - hash associated with the ciphersuite (only used by TLS 1.2)
6278 *
6279 * Outputs:
6280 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6281 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006282MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006283static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6284 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006285{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006286#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006288 handshake->tls_prf = tls_prf_sha384;
6289 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6290 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006292#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006293#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006294 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006295 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006296 handshake->tls_prf = tls_prf_sha256;
6297 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6298 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6299 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006300#else
Jerry Yuf009d862022-02-17 14:01:37 +08006301 {
Jerry Yuf009d862022-02-17 14:01:37 +08006302 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006303 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006305 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006306#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006307
Gilles Peskine449bd832023-01-11 14:50:10 +01006308 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006309}
Jerry Yud6ab2352022-02-17 14:03:43 +08006310
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006311/*
6312 * Compute master secret if needed
6313 *
6314 * Parameters:
6315 * [in/out] handshake
6316 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6317 * (PSA-PSK) ciphersuite_info, psk_opaque
6318 * [out] premaster (cleared)
6319 * [out] master
6320 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6321 * debug: conf->f_dbg, conf->p_dbg
6322 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006323 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006324 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006325MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006326static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6327 unsigned char *master,
6328 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006329{
6330 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6331
6332 /* cf. RFC 5246, Section 8.1:
6333 * "The master secret is always exactly 48 bytes in length." */
6334 size_t const master_secret_len = 48;
6335
6336#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6337 unsigned char session_hash[48];
6338#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6339
6340 /* The label for the KDF used for key expansion.
6341 * This is either "master secret" or "extended master secret"
6342 * depending on whether the Extended Master Secret extension
6343 * is used. */
6344 char const *lbl = "master secret";
6345
Przemek Stekielae4ed302022-04-05 17:15:55 +02006346 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006347 * - If the Extended Master Secret extension is not used,
6348 * this is ClientHello.Random + ServerHello.Random
6349 * (see Sect. 8.1 in RFC 5246).
6350 * - If the Extended Master Secret extension is used,
6351 * this is the transcript of the handshake so far.
6352 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006353 unsigned char const *seed = handshake->randbytes;
6354 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006355
6356#if !defined(MBEDTLS_DEBUG_C) && \
6357 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6358 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006359 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006360 ssl = NULL; /* make sure we don't use it except for those cases */
6361 (void) ssl;
6362#endif
6363
Gilles Peskine449bd832023-01-11 14:50:10 +01006364 if (handshake->resume != 0) {
6365 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6366 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006367 }
6368
6369#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006371 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006372 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006373 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6374 if (ret != 0) {
6375 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6376 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006377
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6379 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006380 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006381#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006382
Przemek Stekiel99114f32022-04-22 11:20:09 +02006383#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006384 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006385 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006386 /* Perform PSK-to-MS expansion in a single step. */
6387 psa_status_t status;
6388 psa_algorithm_t alg;
6389 mbedtls_svc_key_id_t psk;
6390 psa_key_derivation_operation_t derivation =
6391 PSA_KEY_DERIVATION_OPERATION_INIT;
6392 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6393
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006395
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006397
Gilles Peskine449bd832023-01-11 14:50:10 +01006398 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006399 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006401 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006403
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006404 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006406
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006408 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006409 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006410 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006411 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006412 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006413 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006414 other_secret_len = 48;
6415 other_secret = handshake->premaster + 2;
6416 break;
6417 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006418 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006419 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6420 other_secret = handshake->premaster + 2;
6421 break;
6422 default:
6423 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006424 }
6425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 status = setup_psa_key_derivation(&derivation, psk, alg,
6427 ssl->conf->psk, ssl->conf->psk_len,
6428 seed, seed_len,
6429 (unsigned char const *) lbl,
6430 (size_t) strlen(lbl),
6431 other_secret, other_secret_len,
6432 master_secret_len);
6433 if (status != PSA_SUCCESS) {
6434 psa_key_derivation_abort(&derivation);
6435 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006436 }
6437
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 status = psa_key_derivation_output_bytes(&derivation,
6439 master,
6440 master_secret_len);
6441 if (status != PSA_SUCCESS) {
6442 psa_key_derivation_abort(&derivation);
6443 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006444 }
6445
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 status = psa_key_derivation_abort(&derivation);
6447 if (status != PSA_SUCCESS) {
6448 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6449 }
6450 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006451#endif
6452 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006453#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006454 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6455 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006456 psa_status_t status;
6457 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6458 psa_key_derivation_operation_t derivation =
6459 PSA_KEY_DERIVATION_OPERATION_INIT;
6460
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006462
6463 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6464
Gilles Peskine449bd832023-01-11 14:50:10 +01006465 status = psa_key_derivation_setup(&derivation, alg);
6466 if (status != PSA_SUCCESS) {
6467 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006468 }
6469
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 status = psa_key_derivation_set_capacity(&derivation,
6471 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6472 if (status != PSA_SUCCESS) {
6473 psa_key_derivation_abort(&derivation);
6474 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006475 }
6476
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6478 &derivation);
6479 if (status != PSA_SUCCESS) {
6480 psa_key_derivation_abort(&derivation);
6481 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006482 }
6483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 status = psa_key_derivation_output_bytes(&derivation,
6485 handshake->premaster,
6486 handshake->pmslen);
6487 if (status != PSA_SUCCESS) {
6488 psa_key_derivation_abort(&derivation);
6489 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6490 }
6491
6492 status = psa_key_derivation_abort(&derivation);
6493 if (status != PSA_SUCCESS) {
6494 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006495 }
6496 }
6497#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6499 lbl, seed, seed_len,
6500 master,
6501 master_secret_len);
6502 if (ret != 0) {
6503 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6504 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006505 }
6506
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6508 handshake->premaster,
6509 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006510
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 mbedtls_platform_zeroize(handshake->premaster,
6512 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006513 }
6514
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006516}
6517
Gilles Peskine449bd832023-01-11 14:50:10 +01006518int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006519{
6520 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6521 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6522 ssl->handshake->ciphersuite_info;
6523
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006525
6526 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006527 ret = ssl_set_handshake_prfs(ssl->handshake,
6528 ciphersuite_info->mac);
6529 if (ret != 0) {
6530 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6531 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006532 }
6533
6534 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 ret = ssl_compute_master(ssl->handshake,
6536 ssl->session_negotiate->master,
6537 ssl);
6538 if (ret != 0) {
6539 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6540 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006541 }
6542
6543 /* Swap the client and server random values:
6544 * - MS derivation wanted client+server (RFC 5246 8.1)
6545 * - key derivation wants server+client (RFC 5246 6.3) */
6546 {
6547 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006548 memcpy(tmp, ssl->handshake->randbytes, 64);
6549 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6550 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6551 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006552 }
6553
6554 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6556 ssl->session_negotiate->ciphersuite,
6557 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006558#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006560#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 ssl->handshake->tls_prf,
6562 ssl->handshake->randbytes,
6563 ssl->tls_version,
6564 ssl->conf->endpoint,
6565 ssl);
6566 if (ret != 0) {
6567 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6568 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006569 }
6570
6571 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6573 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006574
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006576
Gilles Peskine449bd832023-01-11 14:50:10 +01006577 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006578}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006579
Gilles Peskine449bd832023-01-11 14:50:10 +01006580int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006581{
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006583#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006584 case MBEDTLS_SSL_HASH_SHA384:
6585 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6586 break;
6587#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006588#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006589 case MBEDTLS_SSL_HASH_SHA256:
6590 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6591 break;
6592#endif
6593 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006594 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006595 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006596#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6597 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006598 (void) ssl;
6599#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006601}
6602
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006603#if defined(MBEDTLS_USE_PSA_CRYPTO)
6604static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6605 const psa_hash_operation_t *hs_op,
6606 size_t buffer_size,
6607 unsigned char *hash,
6608 size_t *hlen)
6609{
6610 psa_status_t status;
6611 psa_hash_operation_t copy = psa_hash_operation_init();
6612
6613#if !defined(MBEDTLS_DEBUG_C)
6614 (void) ssl;
6615#endif
6616 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
6617 status = psa_hash_clone(hs_op, &copy);
6618 if (status != PSA_SUCCESS) {
6619 goto exit;
6620 }
6621
6622 status = psa_hash_finish(&copy, hash, buffer_size, hlen);
6623 if (status != PSA_SUCCESS) {
6624 goto exit;
6625 }
6626
6627 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6628 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6629
6630exit:
6631 psa_hash_abort(&copy);
6632 return mbedtls_md_error_from_psa(status);
6633}
6634#else
6635static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6636 const mbedtls_md_context_t *hs_ctx,
6637 unsigned char *hash,
6638 size_t *hlen)
6639{
6640 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6641 mbedtls_md_context_t copy;
6642
6643 mbedtls_md_init(&copy);
6644
6645#if !defined(MBEDTLS_DEBUG_C)
6646 (void) ssl;
6647#endif
6648 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6649
6650 ret = mbedtls_md_setup(&copy, mbedtls_md_info_from_ctx(hs_ctx), 0);
6651 if (ret != 0) {
6652 goto exit;
6653 }
6654 ret = mbedtls_md_clone(&copy, hs_ctx);
6655 if (ret != 0) {
6656 goto exit;
6657 }
6658
6659 ret = mbedtls_md_finish(&copy, hash);
6660 if (ret != 0) {
6661 goto exit;
6662 }
6663
6664 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6665
6666 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6667 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6668
6669exit:
6670 mbedtls_md_free(&copy);
6671 return ret;
6672}
6673#endif /* MBEDTLS_USE_PSA_CRYPTO */
6674
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006675#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006676int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6677 unsigned char *hash,
6678 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006679{
6680#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006681 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6682 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006683#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006684 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6685 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006686#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006687}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006688#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006689
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006690#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006691int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6692 unsigned char *hash,
6693 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006694{
6695#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006696 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6697 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006698#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006699 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6700 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006701#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006702}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006703#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006704
Neil Armstrong80f6f322022-05-03 17:56:38 +02006705#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6706 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006707int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006708{
6709 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006710 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006711 const unsigned char *psk = NULL;
6712 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006713 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006714
Gilles Peskine449bd832023-01-11 14:50:10 +01006715 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006716 /*
6717 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006718 * checked before calling this function.
6719 *
6720 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006721 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006722 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006723 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6724 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6725 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006726 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006727 }
6728
6729 /*
6730 * PMS = struct {
6731 * opaque other_secret<0..2^16-1>;
6732 * opaque psk<0..2^16-1>;
6733 * };
6734 * with "other_secret" depending on the particular key exchange
6735 */
6736#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006737 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6738 if (end - p < 2) {
6739 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6740 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006741
Gilles Peskine449bd832023-01-11 14:50:10 +01006742 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006743 p += 2;
6744
Gilles Peskine449bd832023-01-11 14:50:10 +01006745 if (end < p || (size_t) (end - p) < psk_len) {
6746 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6747 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006748
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006750 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006752#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6753#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006755 /*
6756 * other_secret already set by the ClientKeyExchange message,
6757 * and is 48 bytes long
6758 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 if (end - p < 2) {
6760 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6761 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006762
6763 *p++ = 0;
6764 *p++ = 48;
6765 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006767#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6768#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006770 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6771 size_t len;
6772
6773 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6775 p + 2, end - (p + 2), &len,
6776 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6777 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6778 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006779 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006781 p += 2 + len;
6782
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6784 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006785#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006786#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006788 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6789 size_t zlen;
6790
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6792 p + 2, end - (p + 2),
6793 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6794 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6795 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006796 }
6797
Gilles Peskine449bd832023-01-11 14:50:10 +01006798 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006799 p += 2 + zlen;
6800
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6802 MBEDTLS_DEBUG_ECDH_Z);
6803 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006804#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006805 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6807 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006808 }
6809
6810 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 if (end - p < 2) {
6812 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6813 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006814
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006816 p += 2;
6817
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 if (end < p || (size_t) (end - p) < psk_len) {
6819 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6820 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006821
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006823 p += psk_len;
6824
6825 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6826
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006828}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006829#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006830
6831#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006832MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006833static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006834
6835#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006836int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006837{
6838 /* If renegotiation is not enforced, retransmit until we would reach max
6839 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006841 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6842 unsigned char doublings = 1;
6843
Gilles Peskine449bd832023-01-11 14:50:10 +01006844 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006845 ++doublings;
6846 ratio >>= 1;
6847 }
6848
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 if (++ssl->renego_records_seen > doublings) {
6850 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6851 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006852 }
6853 }
6854
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006856}
6857#endif
6858#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006859
Jerry Yud9526692022-02-17 14:23:47 +08006860/*
6861 * Handshake functions
6862 */
6863#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6864/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006865int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006866{
6867 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6868 ssl->handshake->ciphersuite_info;
6869
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006871
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6873 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006874 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006876 }
6877
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6879 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006880}
6881
Gilles Peskine449bd832023-01-11 14:50:10 +01006882int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006883{
6884 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6885 ssl->handshake->ciphersuite_info;
6886
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006888
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6890 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006891 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006893 }
6894
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6896 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006897}
6898
6899#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6900/* Some certificate support -> implement write and parse */
6901
Gilles Peskine449bd832023-01-11 14:50:10 +01006902int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006903{
6904 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6905 size_t i, n;
6906 const mbedtls_x509_crt *crt;
6907 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6908 ssl->handshake->ciphersuite_info;
6909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006911
Gilles Peskine449bd832023-01-11 14:50:10 +01006912 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6913 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006914 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006916 }
6917
6918#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6920 if (ssl->handshake->client_auth == 0) {
6921 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006922 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006924 }
6925 }
6926#endif /* MBEDTLS_SSL_CLI_C */
6927#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6929 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006930 /* Should never happen because we shouldn't have picked the
6931 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006933 }
6934 }
6935#endif
6936
Gilles Peskine449bd832023-01-11 14:50:10 +01006937 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006938
6939 /*
6940 * 0 . 0 handshake type
6941 * 1 . 3 handshake length
6942 * 4 . 6 length of all certs
6943 * 7 . 9 length of cert. 1
6944 * 10 . n-1 peer certificate
6945 * n . n+2 length of cert. 2
6946 * n+3 . ... upper level cert, etc.
6947 */
6948 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006949 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006950
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006952 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6954 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6955 " > %" MBEDTLS_PRINTF_SIZET,
6956 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6957 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006958 }
6959
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6961 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6962 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006963
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006965 i += n; crt = crt->next;
6966 }
6967
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6969 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6970 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006971
6972 ssl->out_msglen = i;
6973 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6974 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6975
6976 ssl->state++;
6977
Gilles Peskine449bd832023-01-11 14:50:10 +01006978 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6979 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6980 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006981 }
6982
Gilles Peskine449bd832023-01-11 14:50:10 +01006983 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006984
Gilles Peskine449bd832023-01-11 14:50:10 +01006985 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006986}
6987
6988#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6989
6990#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006991MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006992static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6993 unsigned char *crt_buf,
6994 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006995{
6996 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6997
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 if (peer_crt == NULL) {
6999 return -1;
7000 }
Jerry Yud9526692022-02-17 14:23:47 +08007001
Gilles Peskine449bd832023-01-11 14:50:10 +01007002 if (peer_crt->raw.len != crt_buf_len) {
7003 return -1;
7004 }
Jerry Yud9526692022-02-17 14:23:47 +08007005
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007007}
7008#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007009MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007010static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7011 unsigned char *crt_buf,
7012 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007013{
7014 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7015 unsigned char const * const peer_cert_digest =
7016 ssl->session->peer_cert_digest;
7017 mbedtls_md_type_t const peer_cert_digest_type =
7018 ssl->session->peer_cert_digest_type;
7019 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007020 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007021 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7022 size_t digest_len;
7023
Gilles Peskine449bd832023-01-11 14:50:10 +01007024 if (peer_cert_digest == NULL || digest_info == NULL) {
7025 return -1;
7026 }
Jerry Yud9526692022-02-17 14:23:47 +08007027
Gilles Peskine449bd832023-01-11 14:50:10 +01007028 digest_len = mbedtls_md_get_size(digest_info);
7029 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7030 return -1;
7031 }
Jerry Yud9526692022-02-17 14:23:47 +08007032
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7034 if (ret != 0) {
7035 return -1;
7036 }
Jerry Yud9526692022-02-17 14:23:47 +08007037
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007039}
7040#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7041#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7042
7043/*
7044 * Once the certificate message is read, parse it into a cert chain and
7045 * perform basic checks, but leave actual verification to the caller
7046 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007047MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007048static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7049 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007050{
7051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7052#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007053 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007054#endif
7055 size_t i, n;
7056 uint8_t alert;
7057
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7059 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7060 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7061 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7062 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007063 }
7064
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7066 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7067 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7068 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007069 }
7070
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7072 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7073 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7074 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7075 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007076 }
7077
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007079
7080 /*
7081 * Same message structure as in mbedtls_ssl_write_certificate()
7082 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007084
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 if (ssl->in_msg[i] != 0 ||
7086 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7087 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7088 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7089 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7090 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007091 }
7092
7093 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7094 i += 3;
7095
7096 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007098 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007099 if (i + 3 > ssl->in_hslen) {
7100 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7101 mbedtls_ssl_send_alert_message(ssl,
7102 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7103 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7104 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007105 }
7106 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7107 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007108 if (ssl->in_msg[i] != 0) {
7109 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7110 mbedtls_ssl_send_alert_message(ssl,
7111 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7112 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7113 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007114 }
7115
7116 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007118 | (unsigned int) ssl->in_msg[i + 2];
7119 i += 3;
7120
Gilles Peskine449bd832023-01-11 14:50:10 +01007121 if (n < 128 || i + n > ssl->in_hslen) {
7122 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7123 mbedtls_ssl_send_alert_message(ssl,
7124 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7125 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7126 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007127 }
7128
7129 /* Check if we're handling the first CRT in the chain. */
7130#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007132 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007134 /* During client-side renegotiation, check that the server's
7135 * end-CRTs hasn't changed compared to the initial handshake,
7136 * mitigating the triple handshake attack. On success, reuse
7137 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7139 if (ssl_check_peer_crt_unchanged(ssl,
7140 &ssl->in_msg[i],
7141 n) != 0) {
7142 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7143 mbedtls_ssl_send_alert_message(ssl,
7144 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7145 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7146 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007147 }
7148
7149 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007150 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007151 }
7152#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7153
7154 /* Parse the next certificate in the chain. */
7155#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007157#else
7158 /* If we don't need to store the CRT chain permanently, parse
7159 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007161#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007163 case 0: /*ok*/
7164 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7165 /* Ignore certificate with an unknown algorithm: maybe a
7166 prior certificate was already trusted. */
7167 break;
7168
7169 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7170 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7171 goto crt_parse_der_failed;
7172
7173 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7174 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7175 goto crt_parse_der_failed;
7176
7177 default:
7178 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007179crt_parse_der_failed:
7180 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7181 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7182 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007183 }
7184
7185 i += n;
7186 }
7187
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7189 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007190}
7191
7192#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007193MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007194static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007195{
Gilles Peskine449bd832023-01-11 14:50:10 +01007196 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7197 return -1;
7198 }
Jerry Yud9526692022-02-17 14:23:47 +08007199
Gilles Peskine449bd832023-01-11 14:50:10 +01007200 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007201 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7202 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7204 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7205 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007206 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007207 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007208}
7209#endif /* MBEDTLS_SSL_SRV_C */
7210
7211/* Check if a certificate message is expected.
7212 * Return either
7213 * - SSL_CERTIFICATE_EXPECTED, or
7214 * - SSL_CERTIFICATE_SKIP
7215 * indicating whether a Certificate message is expected or not.
7216 */
7217#define SSL_CERTIFICATE_EXPECTED 0
7218#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007219MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007220static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7221 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007222{
7223 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7224 ssl->handshake->ciphersuite_info;
7225
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7227 return SSL_CERTIFICATE_SKIP;
7228 }
Jerry Yud9526692022-02-17 14:23:47 +08007229
7230#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007231 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7232 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7233 return SSL_CERTIFICATE_SKIP;
7234 }
Jerry Yud9526692022-02-17 14:23:47 +08007235
Gilles Peskine449bd832023-01-11 14:50:10 +01007236 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007237 ssl->session_negotiate->verify_result =
7238 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007240 }
7241 }
7242#else
7243 ((void) authmode);
7244#endif /* MBEDTLS_SSL_SRV_C */
7245
Gilles Peskine449bd832023-01-11 14:50:10 +01007246 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007247}
7248
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007249MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007250static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7251 int authmode,
7252 mbedtls_x509_crt *chain,
7253 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007254{
7255 int ret = 0;
7256 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7257 ssl->handshake->ciphersuite_info;
7258 int have_ca_chain = 0;
7259
7260 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7261 void *p_vrfy;
7262
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7264 return 0;
7265 }
Jerry Yud9526692022-02-17 14:23:47 +08007266
Gilles Peskine449bd832023-01-11 14:50:10 +01007267 if (ssl->f_vrfy != NULL) {
7268 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007269 f_vrfy = ssl->f_vrfy;
7270 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 } else {
7272 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007273 f_vrfy = ssl->conf->f_vrfy;
7274 p_vrfy = ssl->conf->p_vrfy;
7275 }
7276
7277 /*
7278 * Main check: verify certificate
7279 */
7280#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007282 ((void) rs_ctx);
7283 have_ca_chain = 1;
7284
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007286 ret = mbedtls_x509_crt_verify_with_ca_cb(
7287 chain,
7288 ssl->conf->f_ca_cb,
7289 ssl->conf->p_ca_cb,
7290 ssl->conf->cert_profile,
7291 ssl->hostname,
7292 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007293 f_vrfy, p_vrfy);
7294 } else
Jerry Yud9526692022-02-17 14:23:47 +08007295#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7296 {
7297 mbedtls_x509_crt *ca_chain;
7298 mbedtls_x509_crl *ca_crl;
7299
7300#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007301 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007302 ca_chain = ssl->handshake->sni_ca_chain;
7303 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 } else
Jerry Yud9526692022-02-17 14:23:47 +08007305#endif
7306 {
7307 ca_chain = ssl->conf->ca_chain;
7308 ca_crl = ssl->conf->ca_crl;
7309 }
7310
Gilles Peskine449bd832023-01-11 14:50:10 +01007311 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007312 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007313 }
Jerry Yud9526692022-02-17 14:23:47 +08007314
7315 ret = mbedtls_x509_crt_verify_restartable(
7316 chain,
7317 ca_chain, ca_crl,
7318 ssl->conf->cert_profile,
7319 ssl->hostname,
7320 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007321 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007322 }
7323
Gilles Peskine449bd832023-01-11 14:50:10 +01007324 if (ret != 0) {
7325 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007326 }
7327
7328#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7330 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7331 }
Jerry Yud9526692022-02-17 14:23:47 +08007332#endif
7333
7334 /*
7335 * Secondary checks: always done, but change 'ret' only if it was 0
7336 */
7337
Valerio Setti6c496a12023-04-07 15:53:51 +02007338#if defined(MBEDTLS_ECP_LIGHT)
Jerry Yud9526692022-02-17 14:23:47 +08007339 {
7340 const mbedtls_pk_context *pk = &chain->pk;
7341
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007342 /* If certificate uses an EC key, make sure the curve is OK.
7343 * This is a public key, so it can't be opaque, so can_do() is a good
7344 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007345 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007346 /* and in the unlikely case the above assumption no longer holds
7347 * we are making sure that pk_ec() here does not return a NULL
7348 */
Valerio Settid0405092023-05-24 13:16:40 +02007349 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7350 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7351 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007353 }
Valerio Setti97207782023-05-18 18:59:06 +02007354 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007355 ssl->session_negotiate->verify_result |=
7356 MBEDTLS_X509_BADCERT_BAD_KEY;
7357
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7359 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007360 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007362 }
Jerry Yud9526692022-02-17 14:23:47 +08007363 }
7364 }
Valerio Setti6c496a12023-04-07 15:53:51 +02007365#endif /* MBEDTLS_ECP_LIGHT */
Jerry Yud9526692022-02-17 14:23:47 +08007366
Gilles Peskine449bd832023-01-11 14:50:10 +01007367 if (mbedtls_ssl_check_cert_usage(chain,
7368 ciphersuite_info,
7369 !ssl->conf->endpoint,
7370 &ssl->session_negotiate->verify_result) != 0) {
7371 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7372 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007373 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007374 }
Jerry Yud9526692022-02-17 14:23:47 +08007375 }
7376
7377 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7378 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7379 * with details encoded in the verification flags. All other kinds
7380 * of error codes, including those from the user provided f_vrfy
7381 * functions, are treated as fatal and lead to a failure of
7382 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007383 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7384 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7385 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007386 ret = 0;
7387 }
7388
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7390 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007391 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7392 }
7393
Gilles Peskine449bd832023-01-11 14:50:10 +01007394 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007395 uint8_t alert;
7396
7397 /* The certificate may have been rejected for several reasons.
7398 Pick one and send the corresponding alert. Which alert to send
7399 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007401 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007402 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007403 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007405 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007407 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007409 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007411 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007413 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007415 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007417 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007419 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007421 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 }
7423 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7424 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007425 }
7426
7427#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 if (ssl->session_negotiate->verify_result != 0) {
7429 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7430 (unsigned int) ssl->session_negotiate->verify_result));
7431 } else {
7432 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007433 }
7434#endif /* MBEDTLS_DEBUG_C */
7435
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007437}
7438
7439#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007440MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007441static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7442 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007443{
7444 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7445 /* Remember digest of the peer's end-CRT. */
7446 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7448 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7449 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7450 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7451 mbedtls_ssl_send_alert_message(ssl,
7452 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7453 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007454
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007456 }
7457
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 ret = mbedtls_md(mbedtls_md_info_from_type(
7459 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7460 start, len,
7461 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007462
7463 ssl->session_negotiate->peer_cert_digest_type =
7464 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7465 ssl->session_negotiate->peer_cert_digest_len =
7466 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7467
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007469}
7470
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007471MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007472static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7473 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007474{
7475 unsigned char *end = start + len;
7476 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7477
7478 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7480 ret = mbedtls_pk_parse_subpubkey(&start, end,
7481 &ssl->handshake->peer_pubkey);
7482 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007483 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007485 }
7486
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007488}
7489#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7490
Gilles Peskine449bd832023-01-11 14:50:10 +01007491int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007492{
7493 int ret = 0;
7494 int crt_expected;
7495#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7496 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7497 ? ssl->handshake->sni_authmode
7498 : ssl->conf->authmode;
7499#else
7500 const int authmode = ssl->conf->authmode;
7501#endif
7502 void *rs_ctx = NULL;
7503 mbedtls_x509_crt *chain = NULL;
7504
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007506
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7508 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7509 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007510 goto exit;
7511 }
7512
7513#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 if (ssl->handshake->ecrs_enabled &&
7515 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007516 chain = ssl->handshake->ecrs_peer_cert;
7517 ssl->handshake->ecrs_peer_cert = NULL;
7518 goto crt_verify;
7519 }
7520#endif
7521
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007523 /* mbedtls_ssl_read_record may have sent an alert already. We
7524 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007526 goto exit;
7527 }
7528
7529#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007531 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7532
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007534 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 }
Jerry Yud9526692022-02-17 14:23:47 +08007536
7537 goto exit;
7538 }
7539#endif /* MBEDTLS_SSL_SRV_C */
7540
7541 /* Clear existing peer CRT structure in case we tried to
7542 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007544
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7546 if (chain == NULL) {
7547 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7548 sizeof(mbedtls_x509_crt)));
7549 mbedtls_ssl_send_alert_message(ssl,
7550 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7551 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007552
7553 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7554 goto exit;
7555 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007557
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 ret = ssl_parse_certificate_chain(ssl, chain);
7559 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007560 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 }
Jerry Yud9526692022-02-17 14:23:47 +08007562
7563#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007565 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 }
Jerry Yud9526692022-02-17 14:23:47 +08007567
7568crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007570 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 }
Jerry Yud9526692022-02-17 14:23:47 +08007572#endif
7573
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 ret = ssl_parse_certificate_verify(ssl, authmode,
7575 chain, rs_ctx);
7576 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007577 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 }
Jerry Yud9526692022-02-17 14:23:47 +08007579
7580#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7581 {
7582 unsigned char *crt_start, *pk_start;
7583 size_t crt_len, pk_len;
7584
7585 /* We parse the CRT chain without copying, so
7586 * these pointers point into the input buffer,
7587 * and are hence still valid after freeing the
7588 * CRT chain. */
7589
7590 crt_start = chain->raw.p;
7591 crt_len = chain->raw.len;
7592
7593 pk_start = chain->pk_raw.p;
7594 pk_len = chain->pk_raw.len;
7595
7596 /* Free the CRT structures before computing
7597 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 mbedtls_x509_crt_free(chain);
7599 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007600 chain = NULL;
7601
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7603 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007604 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 }
Jerry Yud9526692022-02-17 14:23:47 +08007606
Gilles Peskine449bd832023-01-11 14:50:10 +01007607 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7608 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007609 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 }
Jerry Yud9526692022-02-17 14:23:47 +08007611 }
7612#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7613 /* Pass ownership to session structure. */
7614 ssl->session_negotiate->peer_cert = chain;
7615 chain = NULL;
7616#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7617
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007619
7620exit:
7621
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007623 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 }
Jerry Yud9526692022-02-17 14:23:47 +08007625
7626#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007628 ssl->handshake->ecrs_peer_cert = chain;
7629 chain = NULL;
7630 }
7631#endif
7632
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 if (chain != NULL) {
7634 mbedtls_x509_crt_free(chain);
7635 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007636 }
7637
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007639}
7640#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7641
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007642static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7643 unsigned char *padbuf, size_t hlen,
7644 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007645{
7646 int len = 12;
7647 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007648#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007649 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007650 psa_hash_operation_t *hs_op = ctx;
7651 psa_hash_operation_t copy = PSA_HASH_OPERATION_INIT;
7652 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007653#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007654 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007655 mbedtls_md_context_t *hs_ctx = ctx;
7656 mbedtls_md_context_t copy;
7657 mbedtls_md_init(&copy);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007658#endif
7659
7660 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007662 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007663 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007664
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007666 ? "client finished"
7667 : "server finished";
7668
7669#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007670 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007671
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007672 status = psa_hash_clone(hs_op, &copy);
Gilles Peskine449bd832023-01-11 14:50:10 +01007673 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007674 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007675 }
7676
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007677 status = psa_hash_finish(&copy, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007679 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007680 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007681 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007682#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007683 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007684
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007685 ret = mbedtls_md_setup(&copy, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007686 if (ret != 0) {
7687 goto exit;
7688 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007689 ret = mbedtls_md_clone(&copy, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007690 if (ret != 0) {
7691 goto exit;
7692 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007693
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007694 ret = mbedtls_md_finish(&copy, padbuf);
7695 if (ret != 0) {
7696 goto exit;
7697 }
7698#endif /* MBEDTLS_USE_PSA_CRYPTO */
7699
7700 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7701
Jerry Yu615bd6f2022-02-17 14:25:15 +08007702 /*
7703 * TLSv1.2:
7704 * hash = PRF( master, finished_label,
7705 * Hash( handshake ) )[0.11]
7706 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007707 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007708 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007709
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007711
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007713
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007714 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007715
7716exit:
7717#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007718 psa_hash_abort(&copy);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007719 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007720#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007721 mbedtls_md_free(&copy);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007722 return ret;
7723#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007724}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007725
7726#if defined(MBEDTLS_MD_CAN_SHA256)
7727static int ssl_calc_finished_tls_sha256(
7728 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7729{
7730 unsigned char padbuf[32];
7731 return ssl_calc_finished_tls_generic(ssl,
7732#if defined(MBEDTLS_USE_PSA_CRYPTO)
7733 &ssl->handshake->fin_sha256_psa,
7734#else
7735 &ssl->handshake->fin_sha256,
7736#endif
7737 padbuf, sizeof(padbuf),
7738 buf, from);
7739}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007740#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007741
Jerry Yub7ba49e2022-02-17 14:25:53 +08007742
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007743#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007744static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007746{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007747 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007748 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007749#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007750 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007751#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007752 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007753#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007754 padbuf, sizeof(padbuf),
7755 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007756}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007757#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007758
Gilles Peskine449bd832023-01-11 14:50:10 +01007759void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007760{
Gilles Peskine449bd832023-01-11 14:50:10 +01007761 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007762
7763 /*
7764 * Free our handshake params
7765 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 mbedtls_ssl_handshake_free(ssl);
7767 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007768 ssl->handshake = NULL;
7769
7770 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007771 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007772 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007773 if (ssl->transform) {
7774 mbedtls_ssl_transform_free(ssl->transform);
7775 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007776 }
7777 ssl->transform = ssl->transform_negotiate;
7778 ssl->transform_negotiate = NULL;
7779
Gilles Peskine449bd832023-01-11 14:50:10 +01007780 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007781}
7782
Gilles Peskine449bd832023-01-11 14:50:10 +01007783void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007784{
7785 int resume = ssl->handshake->resume;
7786
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007788
7789#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007791 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7792 ssl->renego_records_seen = 0;
7793 }
7794#endif
7795
7796 /*
7797 * Free the previous session and switch in the current one
7798 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007800#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7801 /* RFC 7366 3.1: keep the EtM state */
7802 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007804#endif
7805
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 mbedtls_ssl_session_free(ssl->session);
7807 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007808 }
7809 ssl->session = ssl->session_negotiate;
7810 ssl->session_negotiate = NULL;
7811
7812 /*
7813 * Add cache entry
7814 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007816 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 resume == 0) {
7818 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7819 ssl->session->id,
7820 ssl->session->id_len,
7821 ssl->session) != 0) {
7822 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7823 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007824 }
7825
7826#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007827 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7828 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007829 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007830 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007831
7832 /* Keep last flight around in case we need to resend it:
7833 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007834 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7835 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007836#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007837 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007838
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007839 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007840
Gilles Peskine449bd832023-01-11 14:50:10 +01007841 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007842}
7843
Gilles Peskine449bd832023-01-11 14:50:10 +01007844int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007845{
7846 int ret, hash_len;
7847
Gilles Peskine449bd832023-01-11 14:50:10 +01007848 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007849
Gilles Peskine449bd832023-01-11 14:50:10 +01007850 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007851
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007852 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7853 if (ret != 0) {
7854 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7855 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007856
7857 /*
7858 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7859 * may define some other value. Currently (early 2016), no defined
7860 * ciphersuite does this (and this is unlikely to change as activity has
7861 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7862 */
7863 hash_len = 12;
7864
7865#if defined(MBEDTLS_SSL_RENEGOTIATION)
7866 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007868#endif
7869
7870 ssl->out_msglen = 4 + hash_len;
7871 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7872 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7873
7874 /*
7875 * In case of session resuming, invert the client and server
7876 * ChangeCipherSpec messages order.
7877 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007878 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007879#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007881 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007882 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007883#endif
7884#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007886 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007888#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007889 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007890 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007891 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007892
7893 /*
7894 * Switch to our negotiated transform and session parameters for outbound
7895 * data.
7896 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007898
7899#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007901 unsigned char i;
7902
7903 /* Remember current epoch settings for resending */
7904 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7906 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007907
7908 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007910
7911
7912 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 for (i = 2; i > 0; i--) {
7914 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007915 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 }
7917 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007918
7919 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 if (i == 0) {
7921 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7922 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007923 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007925#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007927
7928 ssl->transform_out = ssl->transform_negotiate;
7929 ssl->session_out = ssl->session_negotiate;
7930
7931#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007932 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7933 mbedtls_ssl_send_flight_completed(ssl);
7934 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007935#endif
7936
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7938 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7939 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007940 }
7941
7942#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007943 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7944 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7945 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7946 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007947 }
7948#endif
7949
Gilles Peskine449bd832023-01-11 14:50:10 +01007950 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007951
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007953}
7954
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007955#define SSL_MAX_HASH_LEN 12
7956
Gilles Peskine449bd832023-01-11 14:50:10 +01007957int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007958{
7959 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7960 unsigned int hash_len = 12;
7961 unsigned char buf[SSL_MAX_HASH_LEN];
7962
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007964
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007965 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7966 if (ret != 0) {
7967 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7968 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007969
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7971 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007972 goto exit;
7973 }
7974
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7976 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7977 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7978 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007979 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7980 goto exit;
7981 }
7982
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7984 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7985 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007986 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7987 goto exit;
7988 }
7989
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7991 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7992 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7993 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007994 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7995 goto exit;
7996 }
7997
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7999 buf, hash_len) != 0) {
8000 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8001 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8002 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008003 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8004 goto exit;
8005 }
8006
8007#if defined(MBEDTLS_SSL_RENEGOTIATION)
8008 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008009 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008010#endif
8011
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008013#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008015 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008017#endif
8018#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008020 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008021 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008022#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008024 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008026
8027#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8029 mbedtls_ssl_recv_flight_completed(ssl);
8030 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008031#endif
8032
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008034
8035exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008036 mbedtls_platform_zeroize(buf, hash_len);
8037 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008038}
8039
Jerry Yu392112c2022-02-17 14:34:10 +08008040#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8041/*
8042 * Helper to get TLS 1.2 PRF from ciphersuite
8043 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8044 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008045static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008046{
Jerry Yu392112c2022-02-17 14:34:10 +08008047 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008049#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008050 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8051 return tls_prf_sha384;
8052 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008053#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008054#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008055 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008056 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8057 return tls_prf_sha256;
8058 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008059 }
8060#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008061#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8062 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008063 (void) ciphersuite_info;
8064#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008065
Gilles Peskine449bd832023-01-11 14:50:10 +01008066 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008067}
8068#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008069
Gilles Peskine449bd832023-01-11 14:50:10 +01008070static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008071{
8072 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008073#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 if (tls_prf == tls_prf_sha384) {
8075 return MBEDTLS_SSL_TLS_PRF_SHA384;
8076 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008077#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008078#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 if (tls_prf == tls_prf_sha256) {
8080 return MBEDTLS_SSL_TLS_PRF_SHA256;
8081 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008082#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008084}
8085
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008086/*
8087 * Populate a transform structure with session keys and all the other
8088 * necessary information.
8089 *
8090 * Parameters:
8091 * - [in/out]: transform: structure to populate
8092 * [in] must be just initialised with mbedtls_ssl_transform_init()
8093 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8094 * - [in] ciphersuite
8095 * - [in] master
8096 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008097 * - [in] tls_prf: pointer to PRF to use for key derivation
8098 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008099 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008100 * - [in] endpoint: client or server
8101 * - [in] ssl: used for:
8102 * - ssl->conf->{f,p}_export_keys
8103 * [in] optionally used for:
8104 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8105 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008106MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008107static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8108 int ciphersuite,
8109 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008110#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008112#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008113 ssl_tls_prf_t tls_prf,
8114 const unsigned char randbytes[64],
8115 mbedtls_ssl_protocol_version tls_version,
8116 unsigned endpoint,
8117 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008118{
8119 int ret = 0;
8120 unsigned char keyblk[256];
8121 unsigned char *key1;
8122 unsigned char *key2;
8123 unsigned char *mac_enc;
8124 unsigned char *mac_dec;
8125 size_t mac_key_len = 0;
8126 size_t iv_copy_len;
8127 size_t keylen;
8128 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008129 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008130#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008131 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008132 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008133#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008134
8135#if defined(MBEDTLS_USE_PSA_CRYPTO)
8136 psa_key_type_t key_type;
8137 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8138 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008139 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008140 size_t key_bits;
8141 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8142#endif
8143
8144#if !defined(MBEDTLS_DEBUG_C) && \
8145 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008147 ssl = NULL; /* make sure we don't use it except for these cases */
8148 (void) ssl;
8149 }
8150#endif
8151
8152 /*
8153 * Some data just needs copying into the structure
8154 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008155#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008156 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008157#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008158 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008159
8160#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008161 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008162#endif
8163
8164#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008165 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008166 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8167 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008168 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008169 }
8170#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8171
8172 /*
8173 * Get various info structures
8174 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008175 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8176 if (ciphersuite_info == NULL) {
8177 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8178 ciphersuite));
8179 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008180 }
8181
Neil Armstrongab555e02022-04-04 11:07:59 +02008182 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008183#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008184 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008185#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008186 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008187
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008189 transform->taglen =
8190 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008191 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008192
8193#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008194 if ((status = mbedtls_ssl_cipher_to_psa(ciphersuite_info->cipher,
8195 transform->taglen,
8196 &alg,
8197 &key_type,
8198 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008199 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008201 goto end;
8202 }
8203#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008204 cipher_info = mbedtls_cipher_info_from_type(ciphersuite_info->cipher);
8205 if (cipher_info == NULL) {
8206 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8207 ciphersuite_info->cipher));
8208 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008209 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008210#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008211
Neil Armstronge4512952022-03-08 09:08:22 +01008212#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008213 mac_alg = mbedtls_md_psa_alg_from_type(ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008214 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008215 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008216 (unsigned) ciphersuite_info->mac));
8217 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008218 }
8219#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 md_info = mbedtls_md_info_from_type(ciphersuite_info->mac);
8221 if (md_info == NULL) {
8222 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8223 (unsigned) ciphersuite_info->mac));
8224 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008225 }
Neil Armstronge4512952022-03-08 09:08:22 +01008226#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008227
8228#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8229 /* Copy own and peer's CID if the use of the CID
8230 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008231 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8232 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008233
8234 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008235 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8236 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8237 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008238
8239 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008240 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8241 ssl->handshake->peer_cid_len);
8242 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8243 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008244 }
8245#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8246
8247 /*
8248 * Compute key block using the PRF
8249 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008250 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8251 if (ret != 0) {
8252 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8253 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008254 }
8255
Gilles Peskine449bd832023-01-11 14:50:10 +01008256 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8257 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8258 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8259 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8260 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008261
8262 /*
8263 * Determine the appropriate key, IV and MAC length.
8264 */
8265
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008266#if defined(MBEDTLS_USE_PSA_CRYPTO)
8267 keylen = PSA_BITS_TO_BYTES(key_bits);
8268#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008269 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008270#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008271
8272#if defined(MBEDTLS_GCM_C) || \
8273 defined(MBEDTLS_CCM_C) || \
8274 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008275 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008276 size_t explicit_ivlen;
8277
8278 transform->maclen = 0;
8279 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008280
8281 /* All modes haves 96-bit IVs, but the length of the static parts vary
8282 * with mode and version:
8283 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8284 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8285 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8286 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8287 * sequence number).
8288 */
8289 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008290
8291 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008292#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008293 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008294#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8296 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008297#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008298
Gilles Peskine449bd832023-01-11 14:50:10 +01008299 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008300 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008301 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008302 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008304
8305 /* Minimum length of encrypted record */
8306 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8307 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008309#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8310#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008312 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008313 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008314#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008315 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008316#else
8317 size_t block_size = cipher_info->block_size;
8318#endif /* MBEDTLS_USE_PSA_CRYPTO */
8319
8320#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008321 /* Get MAC length */
8322 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8323#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008324 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008325 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8326 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8327 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008328 goto end;
8329 }
8330
8331 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008332 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008333#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008334 transform->maclen = mac_key_len;
8335
8336 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008337#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008339#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008340 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008341#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008342
8343 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008344 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008345 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008346 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008347 /*
8348 * GenericBlockCipher:
8349 * 1. if EtM is in use: one block plus MAC
8350 * otherwise: * first multiple of blocklen greater than maclen
8351 * 2. IV
8352 */
8353#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008355 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008356 + block_size;
8357 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008358#endif
8359 {
8360 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008361 + block_size
8362 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008363 }
8364
Gilles Peskine449bd832023-01-11 14:50:10 +01008365 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008366 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 } else {
8368 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008369 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8370 goto end;
8371 }
8372 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008373 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008374#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8375 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008376 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8377 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008378 }
8379
Gilles Peskine449bd832023-01-11 14:50:10 +01008380 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8381 (unsigned) keylen,
8382 (unsigned) transform->minlen,
8383 (unsigned) transform->ivlen,
8384 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008385
8386 /*
8387 * Finally setup the cipher contexts, IVs and MAC secrets.
8388 */
8389#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008390 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008391 key1 = keyblk + mac_key_len * 2;
8392 key2 = keyblk + mac_key_len * 2 + keylen;
8393
8394 mac_enc = keyblk;
8395 mac_dec = keyblk + mac_key_len;
8396
Gilles Peskine449bd832023-01-11 14:50:10 +01008397 iv_copy_len = (transform->fixed_ivlen) ?
8398 transform->fixed_ivlen : transform->ivlen;
8399 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8400 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8401 iv_copy_len);
8402 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008403#endif /* MBEDTLS_SSL_CLI_C */
8404#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008405 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008406 key1 = keyblk + mac_key_len * 2 + keylen;
8407 key2 = keyblk + mac_key_len * 2;
8408
8409 mac_enc = keyblk + mac_key_len;
8410 mac_dec = keyblk;
8411
Gilles Peskine449bd832023-01-11 14:50:10 +01008412 iv_copy_len = (transform->fixed_ivlen) ?
8413 transform->fixed_ivlen : transform->ivlen;
8414 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8415 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8416 iv_copy_len);
8417 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008418#endif /* MBEDTLS_SSL_SRV_C */
8419 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008420 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008421 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8422 goto end;
8423 }
8424
Gilles Peskine449bd832023-01-11 14:50:10 +01008425 if (ssl != NULL && ssl->f_export_keys != NULL) {
8426 ssl->f_export_keys(ssl->p_export_keys,
8427 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8428 master, 48,
8429 randbytes + 32,
8430 randbytes,
8431 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008432 }
8433
8434#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008435 transform->psa_alg = alg;
8436
Gilles Peskine449bd832023-01-11 14:50:10 +01008437 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8438 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8439 psa_set_key_algorithm(&attributes, alg);
8440 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008441
Gilles Peskine449bd832023-01-11 14:50:10 +01008442 if ((status = psa_import_key(&attributes,
8443 key1,
8444 PSA_BITS_TO_BYTES(key_bits),
8445 &transform->psa_key_enc)) != PSA_SUCCESS) {
8446 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008447 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008448 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008449 goto end;
8450 }
8451
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008453
Gilles Peskine449bd832023-01-11 14:50:10 +01008454 if ((status = psa_import_key(&attributes,
8455 key2,
8456 PSA_BITS_TO_BYTES(key_bits),
8457 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008458 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008460 goto end;
8461 }
8462 }
8463#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008464 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8465 cipher_info)) != 0) {
8466 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008467 goto end;
8468 }
8469
Gilles Peskine449bd832023-01-11 14:50:10 +01008470 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8471 cipher_info)) != 0) {
8472 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008473 goto end;
8474 }
8475
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8477 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8478 MBEDTLS_ENCRYPT)) != 0) {
8479 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008480 goto end;
8481 }
8482
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8484 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8485 MBEDTLS_DECRYPT)) != 0) {
8486 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008487 goto end;
8488 }
8489
8490#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8492 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8493 MBEDTLS_PADDING_NONE)) != 0) {
8494 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008495 goto end;
8496 }
8497
Gilles Peskine449bd832023-01-11 14:50:10 +01008498 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8499 MBEDTLS_PADDING_NONE)) != 0) {
8500 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008501 goto end;
8502 }
8503 }
8504#endif /* MBEDTLS_CIPHER_MODE_CBC */
8505#endif /* MBEDTLS_USE_PSA_CRYPTO */
8506
Neil Armstrong29c0c042022-03-17 17:47:28 +01008507#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8508 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8509 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008511#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008512 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008513
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8515 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8516 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008517
Gilles Peskine449bd832023-01-11 14:50:10 +01008518 if ((status = psa_import_key(&attributes,
8519 mac_enc, mac_key_len,
8520 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008521 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008522 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008523 goto end;
8524 }
8525
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8527 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008528#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008529 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008530#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008532 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008533 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8534 PSA_KEY_USAGE_VERIFY_HASH);
8535 } else {
8536 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8537 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008538
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 if ((status = psa_import_key(&attributes,
8540 mac_dec, mac_key_len,
8541 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008542 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008543 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008544 goto end;
8545 }
8546#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008547 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8548 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008549 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008550 }
8551 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8552 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008553 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008555#endif /* MBEDTLS_USE_PSA_CRYPTO */
8556 }
8557#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8558
8559 ((void) mac_dec);
8560 ((void) mac_enc);
8561
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008562end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8564 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008565}
8566
Valerio Settia08b1a42022-11-17 15:10:02 +01008567#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8568 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008569int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 psa_pake_operation_t *pake_ctx,
8571 const unsigned char *buf,
8572 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008573{
8574 psa_status_t status;
8575 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008576 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008577 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8578 * At round two perform a single cycle
8579 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008580 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008581
Gilles Peskine449bd832023-01-11 14:50:10 +01008582 for (; remaining_steps > 0; remaining_steps--) {
8583 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008584 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008585 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008586 /* Length is stored at the first byte */
8587 size_t length = buf[input_offset];
8588 input_offset += 1;
8589
Gilles Peskine449bd832023-01-11 14:50:10 +01008590 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008591 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8592 }
8593
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 status = psa_pake_input(pake_ctx, step,
8595 buf + input_offset, length);
8596 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008597 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008598 }
8599
8600 input_offset += length;
8601 }
8602 }
8603
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008605 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008607
Gilles Peskine449bd832023-01-11 14:50:10 +01008608 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008609}
8610
Valerio Setti6b3dab02022-11-17 17:14:54 +01008611int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008612 psa_pake_operation_t *pake_ctx,
8613 unsigned char *buf,
8614 size_t len, size_t *olen,
8615 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008616{
8617 psa_status_t status;
8618 size_t output_offset = 0;
8619 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008620 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008621 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8622 * At round two perform a single cycle
8623 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008624 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008625
Gilles Peskine449bd832023-01-11 14:50:10 +01008626 for (; remaining_steps > 0; remaining_steps--) {
8627 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8628 step <= PSA_PAKE_STEP_ZK_PROOF;
8629 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008630 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008631 * For each step, prepend 1 byte with the length of the data as
8632 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008633 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008634 status = psa_pake_output(pake_ctx, step,
8635 buf + output_offset + 1,
8636 len - output_offset - 1,
8637 &output_len);
8638 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008639 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008640 }
8641
Valerio Setti99d88c12022-11-22 16:03:43 +01008642 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008643
8644 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008645 }
8646 }
8647
8648 *olen = output_offset;
8649
Gilles Peskine449bd832023-01-11 14:50:10 +01008650 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008651}
Valerio Settia08b1a42022-11-17 15:10:02 +01008652#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8653
Jerry Yuee40f9d2022-02-17 14:55:16 +08008654#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008655int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8656 unsigned char *hash, size_t *hashlen,
8657 unsigned char *data, size_t data_len,
8658 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008659{
8660 psa_status_t status;
8661 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008662 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008663
Gilles Peskine449bd832023-01-11 14:50:10 +01008664 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008665
Gilles Peskine449bd832023-01-11 14:50:10 +01008666 if ((status = psa_hash_setup(&hash_operation,
8667 hash_alg)) != PSA_SUCCESS) {
8668 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008669 goto exit;
8670 }
8671
Gilles Peskine449bd832023-01-11 14:50:10 +01008672 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8673 64)) != PSA_SUCCESS) {
8674 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008675 goto exit;
8676 }
8677
Gilles Peskine449bd832023-01-11 14:50:10 +01008678 if ((status = psa_hash_update(&hash_operation,
8679 data, data_len)) != PSA_SUCCESS) {
8680 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008681 goto exit;
8682 }
8683
Gilles Peskine449bd832023-01-11 14:50:10 +01008684 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8685 hashlen)) != PSA_SUCCESS) {
8686 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8687 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008688 }
8689
8690exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008691 if (status != PSA_SUCCESS) {
8692 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8693 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8694 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008695 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008696 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008697 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8698 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008700 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008701 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008702 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008703 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008704 }
8705 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008706 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008707}
8708
8709#else
8710
Gilles Peskine449bd832023-01-11 14:50:10 +01008711int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8712 unsigned char *hash, size_t *hashlen,
8713 unsigned char *data, size_t data_len,
8714 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008715{
8716 int ret = 0;
8717 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008718 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8719 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008720
Gilles Peskine449bd832023-01-11 14:50:10 +01008721 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008722
Gilles Peskine449bd832023-01-11 14:50:10 +01008723 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008724
8725 /*
8726 * digitally-signed struct {
8727 * opaque client_random[32];
8728 * opaque server_random[32];
8729 * ServerDHParams params;
8730 * };
8731 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008732 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8733 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008734 goto exit;
8735 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008736 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8737 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008738 goto exit;
8739 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008740 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8741 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008742 goto exit;
8743 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008744 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8745 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008746 goto exit;
8747 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008748 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8749 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008750 goto exit;
8751 }
8752
8753exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008754 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008755
Gilles Peskine449bd832023-01-11 14:50:10 +01008756 if (ret != 0) {
8757 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8758 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8759 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008760
Gilles Peskine449bd832023-01-11 14:50:10 +01008761 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008762}
8763#endif /* MBEDTLS_USE_PSA_CRYPTO */
8764
Jerry Yud9d91da2022-02-17 14:57:06 +08008765#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8766
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008767/* Find the preferred hash for a given signature algorithm. */
8768unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008769 mbedtls_ssl_context *ssl,
8770 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008771{
Gabor Mezei078e8032022-04-27 21:17:56 +02008772 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008773 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008774
Gilles Peskine449bd832023-01-11 14:50:10 +01008775 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8776 return MBEDTLS_SSL_HASH_NONE;
8777 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008778
Gilles Peskine449bd832023-01-11 14:50:10 +01008779 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008780 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008781 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8782 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008783 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008784 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8785 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008786
Gilles Peskine449bd832023-01-11 14:50:10 +01008787 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008788#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008789 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008790 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008791 mbedtls_md_psa_alg_from_type(hash_alg_received);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008792
Gilles Peskine449bd832023-01-11 14:50:10 +01008793 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8794 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8795 PSA_ALG_ECDSA(psa_hash_alg),
8796 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008797 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008798 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008799
Gilles Peskine449bd832023-01-11 14:50:10 +01008800 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8801 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8802 PSA_ALG_RSA_PKCS1V15_SIGN(
8803 psa_hash_alg),
8804 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008805 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008806 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008807 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008808#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008809
Gilles Peskine449bd832023-01-11 14:50:10 +01008810 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008811 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008812 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008813
Gilles Peskine449bd832023-01-11 14:50:10 +01008814 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008815}
8816
8817#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8818
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008819/* Serialization of TLS 1.2 sessions:
8820 *
8821 * struct {
8822 * uint64 start_time;
8823 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008824 * uint8 session_id_len; // at most 32
8825 * opaque session_id[32];
8826 * opaque master[48]; // fixed length in the standard
8827 * uint32 verify_result;
8828 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8829 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8830 * uint32 ticket_lifetime;
8831 * uint8 mfl_code; // up to 255 according to standard
8832 * uint8 encrypt_then_mac; // 0 or 1
8833 * } serialized_session_tls12;
8834 *
8835 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008836static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8837 unsigned char *buf,
8838 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008839{
8840 unsigned char *p = buf;
8841 size_t used = 0;
8842
8843#if defined(MBEDTLS_HAVE_TIME)
8844 uint64_t start;
8845#endif
8846#if defined(MBEDTLS_X509_CRT_PARSE_C)
8847#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8848 size_t cert_len;
8849#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8850#endif /* MBEDTLS_X509_CRT_PARSE_C */
8851
8852 /*
8853 * Time
8854 */
8855#if defined(MBEDTLS_HAVE_TIME)
8856 used += 8;
8857
Gilles Peskine449bd832023-01-11 14:50:10 +01008858 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008859 start = (uint64_t) session->start;
8860
Gilles Peskine449bd832023-01-11 14:50:10 +01008861 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008862 p += 8;
8863 }
8864#endif /* MBEDTLS_HAVE_TIME */
8865
8866 /*
8867 * Basic mandatory fields
8868 */
8869 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008870 + 1 /* id_len */
8871 + sizeof(session->id)
8872 + sizeof(session->master)
8873 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008874
Gilles Peskine449bd832023-01-11 14:50:10 +01008875 if (used <= buf_len) {
8876 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008877 p += 2;
8878
Gilles Peskine449bd832023-01-11 14:50:10 +01008879 *p++ = MBEDTLS_BYTE_0(session->id_len);
8880 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008881 p += 32;
8882
Gilles Peskine449bd832023-01-11 14:50:10 +01008883 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008884 p += 48;
8885
Gilles Peskine449bd832023-01-11 14:50:10 +01008886 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008887 p += 4;
8888 }
8889
8890 /*
8891 * Peer's end-entity certificate
8892 */
8893#if defined(MBEDTLS_X509_CRT_PARSE_C)
8894#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008895 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008896 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008897 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008898 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008899 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008900
8901 used += 3 + cert_len;
8902
Gilles Peskine449bd832023-01-11 14:50:10 +01008903 if (used <= buf_len) {
8904 *p++ = MBEDTLS_BYTE_2(cert_len);
8905 *p++ = MBEDTLS_BYTE_1(cert_len);
8906 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008907
Gilles Peskine449bd832023-01-11 14:50:10 +01008908 if (session->peer_cert != NULL) {
8909 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008910 p += cert_len;
8911 }
8912 }
8913#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008914 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008915 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008916 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008917 *p++ = (unsigned char) session->peer_cert_digest_type;
8918 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008919 memcpy(p, session->peer_cert_digest,
8920 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008921 p += session->peer_cert_digest_len;
8922 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008923 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008924 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008925 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008926 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8927 *p++ = 0;
8928 }
8929 }
8930#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8931#endif /* MBEDTLS_X509_CRT_PARSE_C */
8932
8933 /*
8934 * Session ticket if any, plus associated data
8935 */
8936#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8937 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8938
Gilles Peskine449bd832023-01-11 14:50:10 +01008939 if (used <= buf_len) {
8940 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
8941 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
8942 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008943
Gilles Peskine449bd832023-01-11 14:50:10 +01008944 if (session->ticket != NULL) {
8945 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008946 p += session->ticket_len;
8947 }
8948
Gilles Peskine449bd832023-01-11 14:50:10 +01008949 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008950 p += 4;
8951 }
8952#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8953
8954 /*
8955 * Misc extension-related info
8956 */
8957#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8958 used += 1;
8959
Gilles Peskine449bd832023-01-11 14:50:10 +01008960 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008961 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01008962 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008963#endif
8964
8965#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8966 used += 1;
8967
Gilles Peskine449bd832023-01-11 14:50:10 +01008968 if (used <= buf_len) {
8969 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
8970 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008971#endif
8972
Gilles Peskine449bd832023-01-11 14:50:10 +01008973 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008974}
8975
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008976MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008977static int ssl_tls12_session_load(mbedtls_ssl_session *session,
8978 const unsigned char *buf,
8979 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008980{
8981#if defined(MBEDTLS_HAVE_TIME)
8982 uint64_t start;
8983#endif
8984#if defined(MBEDTLS_X509_CRT_PARSE_C)
8985#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8986 size_t cert_len;
8987#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8988#endif /* MBEDTLS_X509_CRT_PARSE_C */
8989
8990 const unsigned char *p = buf;
8991 const unsigned char * const end = buf + len;
8992
8993 /*
8994 * Time
8995 */
8996#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01008997 if (8 > (size_t) (end - p)) {
8998 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8999 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009000
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009001 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009002 p += 8;
9003
9004 session->start = (time_t) start;
9005#endif /* MBEDTLS_HAVE_TIME */
9006
9007 /*
9008 * Basic mandatory fields
9009 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009010 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9011 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9012 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009013
Gilles Peskine449bd832023-01-11 14:50:10 +01009014 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009015 p += 2;
9016
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009017 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009018 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009019 p += 32;
9020
Gilles Peskine449bd832023-01-11 14:50:10 +01009021 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009022 p += 48;
9023
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009024 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009025 p += 4;
9026
9027 /* Immediately clear invalid pointer values that have been read, in case
9028 * we exit early before we replaced them with valid ones. */
9029#if defined(MBEDTLS_X509_CRT_PARSE_C)
9030#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9031 session->peer_cert = NULL;
9032#else
9033 session->peer_cert_digest = NULL;
9034#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9035#endif /* MBEDTLS_X509_CRT_PARSE_C */
9036#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9037 session->ticket = NULL;
9038#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9039
9040 /*
9041 * Peer certificate
9042 */
9043#if defined(MBEDTLS_X509_CRT_PARSE_C)
9044#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9045 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009046 if (3 > (size_t) (end - p)) {
9047 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9048 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009049
Gilles Peskine449bd832023-01-11 14:50:10 +01009050 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009051 p += 3;
9052
Gilles Peskine449bd832023-01-11 14:50:10 +01009053 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009054 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9055
Gilles Peskine449bd832023-01-11 14:50:10 +01009056 if (cert_len > (size_t) (end - p)) {
9057 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9058 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009059
Gilles Peskine449bd832023-01-11 14:50:10 +01009060 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009061
Gilles Peskine449bd832023-01-11 14:50:10 +01009062 if (session->peer_cert == NULL) {
9063 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9064 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009065
Gilles Peskine449bd832023-01-11 14:50:10 +01009066 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009067
Gilles Peskine449bd832023-01-11 14:50:10 +01009068 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9069 p, cert_len)) != 0) {
9070 mbedtls_x509_crt_free(session->peer_cert);
9071 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009072 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009073 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009074 }
9075
9076 p += cert_len;
9077 }
9078#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9079 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009080 if (2 > (size_t) (end - p)) {
9081 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9082 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009083
9084 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9085 session->peer_cert_digest_len = (size_t) *p++;
9086
Gilles Peskine449bd832023-01-11 14:50:10 +01009087 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009088 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009089 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9090 if (md_info == NULL) {
9091 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9092 }
9093 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9094 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9095 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009096
Gilles Peskine449bd832023-01-11 14:50:10 +01009097 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9098 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9099 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009100
9101 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009102 mbedtls_calloc(1, session->peer_cert_digest_len);
9103 if (session->peer_cert_digest == NULL) {
9104 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9105 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009106
Gilles Peskine449bd832023-01-11 14:50:10 +01009107 memcpy(session->peer_cert_digest, p,
9108 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009109 p += session->peer_cert_digest_len;
9110 }
9111#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9112#endif /* MBEDTLS_X509_CRT_PARSE_C */
9113
9114 /*
9115 * Session ticket and associated data
9116 */
9117#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009118 if (3 > (size_t) (end - p)) {
9119 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9120 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009121
Gilles Peskine449bd832023-01-11 14:50:10 +01009122 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009123 p += 3;
9124
Gilles Peskine449bd832023-01-11 14:50:10 +01009125 if (session->ticket_len != 0) {
9126 if (session->ticket_len > (size_t) (end - p)) {
9127 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9128 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009129
Gilles Peskine449bd832023-01-11 14:50:10 +01009130 session->ticket = mbedtls_calloc(1, session->ticket_len);
9131 if (session->ticket == NULL) {
9132 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9133 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009134
Gilles Peskine449bd832023-01-11 14:50:10 +01009135 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009136 p += session->ticket_len;
9137 }
9138
Gilles Peskine449bd832023-01-11 14:50:10 +01009139 if (4 > (size_t) (end - p)) {
9140 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9141 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009142
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009143 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009144 p += 4;
9145#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9146
9147 /*
9148 * Misc extension-related info
9149 */
9150#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009151 if (1 > (size_t) (end - p)) {
9152 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9153 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009154
9155 session->mfl_code = *p++;
9156#endif
9157
9158#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009159 if (1 > (size_t) (end - p)) {
9160 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9161 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009162
9163 session->encrypt_then_mac = *p++;
9164#endif
9165
9166 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009167 if (p != end) {
9168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9169 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009170
Gilles Peskine449bd832023-01-11 14:50:10 +01009171 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009172}
Jerry Yudc7bd172022-02-17 13:44:15 +08009173#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9174
XiaokangQian75d40ef2022-04-20 11:05:24 +00009175int mbedtls_ssl_validate_ciphersuite(
9176 const mbedtls_ssl_context *ssl,
9177 const mbedtls_ssl_ciphersuite_t *suite_info,
9178 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009179 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009180{
9181 (void) ssl;
9182
Gilles Peskine449bd832023-01-11 14:50:10 +01009183 if (suite_info == NULL) {
9184 return -1;
9185 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009186
Gilles Peskine449bd832023-01-11 14:50:10 +01009187 if ((suite_info->min_tls_version > max_tls_version) ||
9188 (suite_info->max_tls_version < min_tls_version)) {
9189 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009190 }
9191
XiaokangQian060d8672022-04-21 09:24:56 +00009192#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009193#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009194#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009195 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9196 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009197#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009198 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9199 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009200#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009201 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009203 }
9204#endif
9205
9206 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9207#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009208 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9209 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9210 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009211 }
9212#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9213#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9214
Gilles Peskine449bd832023-01-11 14:50:10 +01009215 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009216}
9217
Ronald Crone68ab4f2022-10-05 12:46:29 +02009218#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009219/*
9220 * Function for writing a signature algorithm extension.
9221 *
9222 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9223 * value (TLS 1.3 RFC8446):
9224 * enum {
9225 * ....
9226 * ecdsa_secp256r1_sha256( 0x0403 ),
9227 * ecdsa_secp384r1_sha384( 0x0503 ),
9228 * ecdsa_secp521r1_sha512( 0x0603 ),
9229 * ....
9230 * } SignatureScheme;
9231 *
9232 * struct {
9233 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9234 * } SignatureSchemeList;
9235 *
9236 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9237 * value (TLS 1.2 RFC5246):
9238 * enum {
9239 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9240 * sha512(6), (255)
9241 * } HashAlgorithm;
9242 *
9243 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9244 * SignatureAlgorithm;
9245 *
9246 * struct {
9247 * HashAlgorithm hash;
9248 * SignatureAlgorithm signature;
9249 * } SignatureAndHashAlgorithm;
9250 *
9251 * SignatureAndHashAlgorithm
9252 * supported_signature_algorithms<2..2^16-2>;
9253 *
9254 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9255 * generalization of the TLS 1.2 signature algorithm extension.
9256 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9257 * `SignatureScheme` field of TLS 1.3
9258 *
9259 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009260int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9261 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009262{
9263 unsigned char *p = buf;
9264 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9265 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9266
9267 *out_len = 0;
9268
Gilles Peskine449bd832023-01-11 14:50:10 +01009269 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009270
9271 /* Check if we have space for header and length field:
9272 * - extension_type (2 bytes)
9273 * - extension_data_length (2 bytes)
9274 * - supported_signature_algorithms_length (2 bytes)
9275 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009276 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009277 p += 6;
9278
9279 /*
9280 * Write supported_signature_algorithms
9281 */
9282 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009283 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9284 if (sig_alg == NULL) {
9285 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9286 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009287
Gilles Peskine449bd832023-01-11 14:50:10 +01009288 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9289 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9290 *sig_alg,
9291 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9292 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009293 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009294 }
9295 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9296 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009297 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009298 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9299 *sig_alg,
9300 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009301 }
9302
9303 /* Length of supported_signature_algorithms */
9304 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009305 if (supported_sig_alg_len == 0) {
9306 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9307 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009308 }
9309
Gilles Peskine449bd832023-01-11 14:50:10 +01009310 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9311 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9312 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009313
XiaokangQianeaf36512022-04-24 09:07:44 +00009314 *out_len = p - buf;
9315
9316#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009317 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009318#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009319
Gilles Peskine449bd832023-01-11 14:50:10 +01009320 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009321}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009322#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009323
XiaokangQian40a35232022-05-07 09:02:40 +00009324#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009325/*
9326 * mbedtls_ssl_parse_server_name_ext
9327 *
9328 * Structure of server_name extension:
9329 *
9330 * enum {
9331 * host_name(0), (255)
9332 * } NameType;
9333 * opaque HostName<1..2^16-1>;
9334 *
9335 * struct {
9336 * NameType name_type;
9337 * select (name_type) {
9338 * case host_name: HostName;
9339 * } name;
9340 * } ServerName;
9341 * struct {
9342 * ServerName server_name_list<1..2^16-1>
9343 * } ServerNameList;
9344 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009345MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009346int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9347 const unsigned char *buf,
9348 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009349{
9350 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9351 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009352 size_t server_name_list_len, hostname_len;
9353 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009354
Gilles Peskine449bd832023-01-11 14:50:10 +01009355 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009356
Gilles Peskine449bd832023-01-11 14:50:10 +01009357 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9358 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009359 p += 2;
9360
Gilles Peskine449bd832023-01-11 14:50:10 +01009361 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009362 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009363 while (p < server_name_list_end) {
9364 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9365 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9366 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9367 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009368
Gilles Peskine449bd832023-01-11 14:50:10 +01009369 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009370 /* sni_name is intended to be used only during the parsing of the
9371 * ClientHello message (it is reset to NULL before the end of
9372 * the message parsing). Thus it is ok to just point to the
9373 * reception buffer and not make a copy of it.
9374 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009375 ssl->handshake->sni_name = p + 3;
9376 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009377 if (ssl->conf->f_sni == NULL) {
9378 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009379 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009380 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9381 ssl, p + 3, hostname_len);
9382 if (ret != 0) {
9383 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9384 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9385 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9386 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9387 }
9388 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009389 }
9390
9391 p += hostname_len + 3;
9392 }
9393
Gilles Peskine449bd832023-01-11 14:50:10 +01009394 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009395}
9396#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9397
XiaokangQianacb39922022-06-17 10:18:48 +00009398#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009400int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9401 const unsigned char *buf,
9402 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009403{
9404 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009405 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009406 const unsigned char *protocol_name_list;
9407 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009408 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009409
9410 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009411 if (ssl->conf->alpn_list == NULL) {
9412 return 0;
9413 }
XiaokangQianacb39922022-06-17 10:18:48 +00009414
9415 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009416 * RFC7301, section 3.1
9417 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009418 *
XiaokangQianc7403452022-06-23 03:24:12 +00009419 * struct {
9420 * ProtocolName protocol_name_list<2..2^16-1>
9421 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009422 */
9423
XiaokangQianc7403452022-06-23 03:24:12 +00009424 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009425 * protocol_name_list_len 2 bytes
9426 * protocol_name_len 1 bytes
9427 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009428 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009429 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009430
Gilles Peskine449bd832023-01-11 14:50:10 +01009431 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009432 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009433 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009434 protocol_name_list = p;
9435 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009436
9437 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009438 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009439 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009440 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9441 protocol_name_len);
9442 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009443 MBEDTLS_SSL_PEND_FATAL_ALERT(
9444 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009445 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9446 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009447 }
9448
9449 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009450 }
9451
9452 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009453 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9454 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009455 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009456 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009457 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009458 if (protocol_name_len == alpn_len &&
9459 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009460 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009461 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009462 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009463
9464 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009465 }
9466 }
9467
XiaokangQian95d5f542022-06-24 02:29:26 +00009468 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009469 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009470 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9471 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9472 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009473}
9474
Gilles Peskine449bd832023-01-11 14:50:10 +01009475int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9476 unsigned char *buf,
9477 unsigned char *end,
9478 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009479{
9480 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009481 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009482 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009483
Gilles Peskine449bd832023-01-11 14:50:10 +01009484 if (ssl->alpn_chosen == NULL) {
9485 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009486 }
9487
Gilles Peskine449bd832023-01-11 14:50:10 +01009488 protocol_name_len = strlen(ssl->alpn_chosen);
9489 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009490
Gilles Peskine449bd832023-01-11 14:50:10 +01009491 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009492 /*
9493 * 0 . 1 ext identifier
9494 * 2 . 3 ext length
9495 * 4 . 5 protocol list length
9496 * 6 . 6 protocol name length
9497 * 7 . 7+n protocol name
9498 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009499 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009500
XiaokangQian95d5f542022-06-24 02:29:26 +00009501 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009502
Gilles Peskine449bd832023-01-11 14:50:10 +01009503 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9504 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009505 /* Note: the length of the chosen protocol has been checked to be less
9506 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9507 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009508 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009509
Gilles Peskine449bd832023-01-11 14:50:10 +01009510 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009511
9512#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009513 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009514#endif
9515
Gilles Peskine449bd832023-01-11 14:50:10 +01009516 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009517}
9518#endif /* MBEDTLS_SSL_ALPN */
9519
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009520#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009521 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009522 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009523 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009524int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9525 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009526{
9527 /* Initialize to suppress unnecessary compiler warning */
9528 size_t hostname_len = 0;
9529
9530 /* Check if new hostname is valid before
9531 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009532 if (hostname != NULL) {
9533 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009534
Gilles Peskine449bd832023-01-11 14:50:10 +01009535 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9536 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9537 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009538 }
9539
9540 /* Now it's clear that we will overwrite the old hostname,
9541 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009542 if (session->hostname != NULL) {
9543 mbedtls_platform_zeroize(session->hostname,
9544 strlen(session->hostname));
9545 mbedtls_free(session->hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009546 }
9547
9548 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009549 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009550 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009551 } else {
9552 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9553 if (session->hostname == NULL) {
9554 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9555 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009556
Gilles Peskine449bd832023-01-11 14:50:10 +01009557 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009558 }
9559
Gilles Peskine449bd832023-01-11 14:50:10 +01009560 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009561}
Xiaokang Qian03409292022-10-12 02:49:52 +00009562#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9563 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009564 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009565 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009566
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009567#endif /* MBEDTLS_SSL_TLS_C */