blob: 37b52f58188aa235353ed79af02d1fcf5c4b5774 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
SimonBd5800b72016-04-26 07:43:27 +010028#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010029
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000030#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010031#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010032#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000033#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040034
Janos Follath73c616b2019-12-18 15:07:04 +000035#include "mbedtls/debug.h"
36#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050037#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010038#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020039#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020040
Rich Evans00ab4702015-02-06 13:43:58 +000041#include <string.h>
42
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050043#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020044#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020045#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050046#include "psa/crypto.h"
47#endif
48
Janos Follath23bdca02016-10-07 14:47:14 +010049#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000050#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020051#endif
52
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050053#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040054/* Define local translating functions to save code size by not using too many
55 * arguments in each translating place. */
56static int local_err_translation(psa_status_t status)
57{
58 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040059 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040060 psa_generic_status_to_mbedtls);
61}
62#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050063#endif
64
Ronald Cronad8c17b2022-06-10 17:18:09 +020065#if defined(MBEDTLS_TEST_HOOKS)
66static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
67
68void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010069 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020070{
71 chk_buf_ptr_fail_args.cur = cur;
72 chk_buf_ptr_fail_args.end = end;
73 chk_buf_ptr_fail_args.need = need;
74}
75
Gilles Peskine449bd832023-01-11 14:50:10 +010076void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020077{
Gilles Peskine449bd832023-01-11 14:50:10 +010078 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020079}
80
Gilles Peskine449bd832023-01-11 14:50:10 +010081int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020082{
Gilles Peskine449bd832023-01-11 14:50:10 +010083 return (chk_buf_ptr_fail_args.cur != args->cur) ||
84 (chk_buf_ptr_fail_args.end != args->end) ||
85 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020086}
87#endif /* MBEDTLS_TEST_HOOKS */
88
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020089#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010090
Hanno Beckera0e20d02019-05-15 14:03:01 +010091#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010092/* Top-level Connection ID API */
93
Gilles Peskine449bd832023-01-11 14:50:10 +010094int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
95 size_t len,
96 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010097{
Gilles Peskine449bd832023-01-11 14:50:10 +010098 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
99 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
100 }
Hanno Beckerad4a1372019-05-03 13:06:44 +0100101
Gilles Peskine449bd832023-01-11 14:50:10 +0100102 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
103 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
104 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +0100105 }
106
107 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100108 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100109 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100110}
111
Gilles Peskine449bd832023-01-11 14:50:10 +0100112int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
113 int enable,
114 unsigned char const *own_cid,
115 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100116{
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
119 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100120
Hanno Beckerca092242019-04-25 16:01:49 +0100121 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100122 if (enable == MBEDTLS_SSL_CID_DISABLED) {
123 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
124 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100125 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
127 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 if (own_cid_len != ssl->conf->cid_len) {
130 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
131 (unsigned) own_cid_len,
132 (unsigned) ssl->conf->cid_len));
133 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100134 }
135
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100137 /* Truncation is not an issue here because
138 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
139 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100140
Gilles Peskine449bd832023-01-11 14:50:10 +0100141 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100142}
143
Gilles Peskine449bd832023-01-11 14:50:10 +0100144int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
145 int *enabled,
146 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
147 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000148{
149 *enabled = MBEDTLS_SSL_CID_DISABLED;
150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
152 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
153 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000154
155 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
156 * zero as this is indistinguishable from not requesting to use
157 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
159 return 0;
160 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000163 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100164 if (own_cid != NULL) {
165 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
166 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000167 }
168
169 *enabled = MBEDTLS_SSL_CID_ENABLED;
170
Gilles Peskine449bd832023-01-11 14:50:10 +0100171 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000172}
173
Gilles Peskine449bd832023-01-11 14:50:10 +0100174int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
175 int *enabled,
176 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
177 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100178{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100179 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100180
Gilles Peskine449bd832023-01-11 14:50:10 +0100181 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
182 mbedtls_ssl_is_handshake_over(ssl) == 0) {
183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100184 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100185
Hanno Beckerc5f24222019-05-03 12:54:52 +0100186 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
187 * were used, but client and server requested the empty CID.
188 * This is indistinguishable from not using the CID extension
189 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100190 if (ssl->transform_in->in_cid_len == 0 &&
191 ssl->transform_in->out_cid_len == 0) {
192 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100193 }
194
Gilles Peskine449bd832023-01-11 14:50:10 +0100195 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100196 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100197 if (peer_cid != NULL) {
198 memcpy(peer_cid, ssl->transform_in->out_cid,
199 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100200 }
201 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100202
203 *enabled = MBEDTLS_SSL_CID_ENABLED;
204
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100206}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100207#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100208
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200210
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200212/*
213 * Convert max_fragment_length codes to length.
214 * RFC 6066 says:
215 * enum{
216 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
217 * } MaxFragmentLength;
218 * and we add 0 -> extension unused
219 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100220static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200221{
Gilles Peskine449bd832023-01-11 14:50:10 +0100222 switch (mfl) {
223 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
224 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
225 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
226 return 512;
227 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
228 return 1024;
229 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
230 return 2048;
231 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
232 return 4096;
233 default:
234 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000235 }
236}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200238
Gilles Peskine449bd832023-01-11 14:50:10 +0100239int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
240 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200241{
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 mbedtls_ssl_session_free(dst);
243 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800244#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
245 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000246#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
247 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000248 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800249#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000250#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800251
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200252#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000253
254#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000256 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200257
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
259 if (dst->peer_cert == NULL) {
260 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
261 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
266 src->peer_cert->raw.len)) != 0) {
267 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200268 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200270 }
271 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000272#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000274 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 mbedtls_calloc(1, src->peer_cert_digest_len);
276 if (dst->peer_cert_digest == NULL) {
277 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
278 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000279
Gilles Peskine449bd832023-01-11 14:50:10 +0100280 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
281 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000282 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000283 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000284 }
285#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
286
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200287#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200288
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200289#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 if (src->ticket != NULL) {
291 dst->ticket = mbedtls_calloc(1, src->ticket_len);
292 if (dst->ticket == NULL) {
293 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
294 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200295
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200297 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000298
299#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
300 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000302 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
304 if (ret != 0) {
305 return ret;
306 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000307 }
308#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
309 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200310#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200311
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200313}
314
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500315#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200316MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100317static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500318{
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
320 if (resized_buffer == NULL) {
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500321 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500323
324 /* We want to copy len_new bytes when downsizing the buffer, and
325 * len_old bytes when upsizing, so we choose the smaller of two sizes,
326 * to fit one buffer into another. Size checks, ensuring that no data is
327 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 memcpy(resized_buffer, *buffer,
329 (len_new < *len_old) ? len_new : *len_old);
330 mbedtls_platform_zeroize(*buffer, *len_old);
331 mbedtls_free(*buffer);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500332
333 *buffer = resized_buffer;
334 *len_old = len_new;
335
336 return 0;
337}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200338
Gilles Peskine449bd832023-01-11 14:50:10 +0100339static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
340 size_t in_buf_new_len,
341 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200342{
343 int modified = 0;
344 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
345 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200347 written_in = ssl->in_msg - ssl->in_buf;
348 iv_offset_in = ssl->in_iv - ssl->in_buf;
349 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200351 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 ssl->in_buf_len < in_buf_new_len) {
353 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
354 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
355 } else {
356 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
357 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200358 modified = 1;
359 }
360 }
361 }
362
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200364 written_out = ssl->out_msg - ssl->out_buf;
365 iv_offset_out = ssl->out_iv - ssl->out_buf;
366 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200368 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 ssl->out_buf_len < out_buf_new_len) {
370 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
371 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
372 } else {
373 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
374 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200375 modified = 1;
376 }
377 }
378 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200380 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200382 /* Fields below might not be properly updated with record
383 * splitting or with CID, so they are manually updated here. */
384 ssl->out_msg = ssl->out_buf + written_out;
385 ssl->out_len = ssl->out_buf + len_offset_out;
386 ssl->out_iv = ssl->out_buf + iv_offset_out;
387
388 ssl->in_msg = ssl->in_buf + written_in;
389 ssl->in_len = ssl->in_buf + len_offset_in;
390 ssl->in_iv = ssl->in_buf + iv_offset_in;
391 }
392}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500393#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
394
Jerry Yudb8c48a2022-01-27 14:54:54 +0800395#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800396
397#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100398typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
399 const char *label,
400 const unsigned char *random, size_t rlen,
401 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800402
Gilles Peskine449bd832023-01-11 14:50:10 +0100403static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800404
405#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
406
407/* Type for the TLS PRF */
408typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
409 const unsigned char *, size_t,
410 unsigned char *, size_t);
411
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200412MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100413static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
414 int ciphersuite,
415 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200416#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200418#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 ssl_tls_prf_t tls_prf,
420 const unsigned char randbytes[64],
421 mbedtls_ssl_protocol_version tls_version,
422 unsigned endpoint,
423 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800424
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100425#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200426MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100427static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300428 const char *label,
429 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100431static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
432static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100433
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100434#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100435
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100436#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100437MBEDTLS_CHECK_RETURN_CRITICAL
438static int tls_prf_sha384(const unsigned char *secret, size_t slen,
439 const char *label,
440 const unsigned char *random, size_t rlen,
441 unsigned char *dstbuf, size_t dlen);
442
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100443static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
444static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100445#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100446
447static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
448 unsigned char *buf,
449 size_t buf_len);
450
451MBEDTLS_CHECK_RETURN_CRITICAL
452static int ssl_tls12_session_load(mbedtls_ssl_session *session,
453 const unsigned char *buf,
454 size_t len);
455#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
456
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100457static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100458
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100459#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100460static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100461#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100462
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100463#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100464static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100465#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100466
467int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
468 const unsigned char *secret, size_t slen,
469 const char *label,
470 const unsigned char *random, size_t rlen,
471 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300472{
473 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
474
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300476#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100477#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300478 case MBEDTLS_SSL_TLS_PRF_SHA384:
479 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100480 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100481#endif /* MBEDTLS_MD_CAN_SHA384*/
482#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300483 case MBEDTLS_SSL_TLS_PRF_SHA256:
484 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100486#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300487#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100488 default:
489 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300490 }
491
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300493}
494
Jerry Yuc73c6182022-02-08 20:29:25 +0800495#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100496static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800497{
498#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100499 if (session->peer_cert != NULL) {
500 mbedtls_x509_crt_free(session->peer_cert);
501 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800502 session->peer_cert = NULL;
503 }
504#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800506 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800508 session->peer_cert_digest = NULL;
509 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
510 session->peer_cert_digest_len = 0;
511 }
512#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
513}
514#endif /* MBEDTLS_X509_CRT_PARSE_C */
515
Gilles Peskine449bd832023-01-11 14:50:10 +0100516uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800517{
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800519 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800521
522 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100523 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800524
525 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100526 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800527
528 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100529 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800530
531 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800533
534 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800536
537 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800539
540 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800542
543 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800545
546 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800548
549 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800551
552 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800554
555 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800557
558 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800560
561 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800563
564 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800566
567 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800569
570 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800572
573 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800575
576 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800578
579 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800581
582 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800584
585 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800587
588 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800590
591 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800593
594 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100595 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800596
Jan Bruckner151f6422023-02-10 12:45:19 +0100597 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
598 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
599
Jerry Yu7a485c12022-10-31 13:08:18 +0800600 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800602
603 }
604
Gilles Peskine449bd832023-01-11 14:50:10 +0100605 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800606}
607
Gilles Peskine449bd832023-01-11 14:50:10 +0100608uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800609{
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800611}
612
Jerry Yud25cab02022-10-31 12:48:30 +0800613#if defined(MBEDTLS_DEBUG_C)
614static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800615 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800616 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
617 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
618 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
619 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
620 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
621 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
622 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
623 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
624 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
625 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
626 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
627 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
628 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
629 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
630 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
631 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
632 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
633 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
634 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
635 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
636 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
637 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
638 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
639 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
640 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
641 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100642 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
643 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800644};
645
Gilles Peskine449bd832023-01-11 14:50:10 +0100646static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800647 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
648 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
649 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
650 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
651 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
652 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
653 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
654 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
655 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
656 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
657 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
658 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
659 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
660 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
661 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
662 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
663 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
664 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
665 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
666 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
667 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
668 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
669 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
670 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
671 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
672 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
673 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100674 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
675 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800676};
677
Gilles Peskine449bd832023-01-11 14:50:10 +0100678const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800679{
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 return extension_name_table[
681 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800682}
683
Gilles Peskine449bd832023-01-11 14:50:10 +0100684static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800685{
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800687 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800689 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800691 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800693 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800695 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800697 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800699 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100700 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800701 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800703}
704
Gilles Peskine449bd832023-01-11 14:50:10 +0100705void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
706 int level, const char *file, int line,
707 int hs_msg_type, unsigned int extension_type,
708 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800709{
710 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800712 mbedtls_debug_print_msg(
713 ssl, level, file, line,
714 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100715 ssl_tls13_get_hs_msg_name(hs_msg_type),
716 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800717 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800719 return;
720 }
721
722 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100723 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800724 mbedtls_debug_print_msg(
725 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100726 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
727 mbedtls_ssl_get_extension_name(extension_type), extension_type,
728 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800729 return;
730 }
731
732 mbedtls_debug_print_msg(
733 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100734 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
735 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800736}
737
Gilles Peskine449bd832023-01-11 14:50:10 +0100738void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
739 int level, const char *file, int line,
740 int hs_msg_type, uint32_t extensions_mask,
741 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800742{
743
Gilles Peskine449bd832023-01-11 14:50:10 +0100744 for (unsigned i = 0;
745 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
746 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800747 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800748 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800750 }
751}
752
Pengyu Lvee455c02023-01-12 14:37:24 +0800753#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800754static const char *ticket_flag_name_table[] =
755{
756 [0] = "ALLOW_PSK_RESUMPTION",
757 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
758 [3] = "ALLOW_EARLY_DATA",
759};
760
Pengyu Lv4938a562023-01-16 11:28:49 +0800761void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
762 int level, const char *file, int line,
763 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800764{
765 size_t i;
766
767 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800768 "print ticket_flags (0x%02x)", flags);
769
770 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800771
772 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800773 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800774 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
775 ticket_flag_name_table[i]);
776 }
777 }
778}
779#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
780
Jerry Yud25cab02022-10-31 12:48:30 +0800781#endif /* MBEDTLS_DEBUG_C */
782
Gilles Peskine449bd832023-01-11 14:50:10 +0100783void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
784 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800785{
786 ((void) ciphersuite_info);
787
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100788#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800790 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100791 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800792#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100793#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800795 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800797#endif
798 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100799 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800800 return;
801 }
802}
803
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100804int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100805 unsigned hs_type,
806 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100807{
808 unsigned char hs_hdr[4];
809
810 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100811 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
812 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
813 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
814 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100815
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100816 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100817}
818
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100819int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100820 unsigned hs_type,
821 unsigned char const *msg,
822 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100823{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100824 int ret;
825 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100826 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100827 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100828 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100829 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100830}
831
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100832int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800833{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100834#if defined(MBEDTLS_MD_CAN_SHA256) || \
835 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100836#if defined(MBEDTLS_USE_PSA_CRYPTO)
837 psa_status_t status;
838#else
839 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
840#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100841#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800842 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100843#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100844#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800845#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100846 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
847 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200848 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100849 }
850 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
851 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200852 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100853 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100855 mbedtls_md_free(&ssl->handshake->fin_sha256);
856 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100857 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
858 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
859 0);
860 if (ret != 0) {
861 return ret;
862 }
863 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100864 if (ret != 0) {
865 return ret;
866 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800867#endif
868#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100869#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800870#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100871 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
872 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200873 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100874 }
875 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
876 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200877 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100878 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800879#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100880 mbedtls_md_free(&ssl->handshake->fin_sha384);
881 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100882 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
883 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
884 if (ret != 0) {
885 return ret;
886 }
887 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100888 if (ret != 0) {
889 return ret;
890 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800891#endif
892#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100893 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800894}
895
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100896static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100897 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800898{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100899#if defined(MBEDTLS_MD_CAN_SHA256) || \
900 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100901#if defined(MBEDTLS_USE_PSA_CRYPTO)
902 psa_status_t status;
903#else
904 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
905#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100906#else /* SHA-256 or SHA-384 */
907 ((void) ssl);
908 (void) buf;
909 (void) len;
910#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100911#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800912#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
914 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200915 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800917#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100918 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100919 if (ret != 0) {
920 return ret;
921 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800922#endif
923#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100924#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800925#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100926 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
927 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200928 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100929 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800930#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100931 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100932 if (ret != 0) {
933 return ret;
934 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800935#endif
936#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100937 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800938}
939
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100940#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100941static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100942 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800943{
944#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200945 return mbedtls_md_error_from_psa(psa_hash_update(
946 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800947#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100948 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800949#endif
950}
951#endif
952
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100953#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100954static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100955 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800956{
957#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200958 return mbedtls_md_error_from_psa(psa_hash_update(
959 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800960#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100961 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800962#endif
963}
964#endif
965
Gilles Peskine449bd832023-01-11 14:50:10 +0100966static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200967{
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200969
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100970#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500971#if defined(MBEDTLS_USE_PSA_CRYPTO)
972 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500973#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100974 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200975#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500976#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100977#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500978#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500979 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500980#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100981 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200982#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500983#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200984
985 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100986
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200987#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200989#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200990#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200991 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200993#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200994#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200995#if defined(MBEDTLS_USE_PSA_CRYPTO)
996 handshake->psa_pake_ctx = psa_pake_operation_init();
997 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
998#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02001000#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02001001#if defined(MBEDTLS_SSL_CLI_C)
1002 handshake->ecjpake_cache = NULL;
1003 handshake->ecjpake_cache_len = 0;
1004#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001005#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001006
Gilles Peskineeccd8882020-03-10 12:19:08 +01001007#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001009#endif
1010
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001011#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1012 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1013#endif
Hanno Becker75173122019-02-06 16:18:31 +00001014
1015#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1016 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001018#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001019}
1020
Gilles Peskine449bd832023-01-11 14:50:10 +01001021void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001022{
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001024
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001025#if defined(MBEDTLS_USE_PSA_CRYPTO)
1026 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1027 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001028#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001029 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1030 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001031#endif
1032
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001033#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001034#if defined(MBEDTLS_USE_PSA_CRYPTO)
1035 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1036 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001037#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001038 mbedtls_md_init(&transform->md_ctx_enc);
1039 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001040#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001041#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001042}
1043
Gilles Peskine449bd832023-01-11 14:50:10 +01001044void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001045{
Gilles Peskine449bd832023-01-11 14:50:10 +01001046 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001047}
1048
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001049MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001050static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001051{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001052 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1053
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001054 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001055#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 if (ssl->transform_negotiate) {
1057 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1058 }
Jerry Yu2e199812022-12-01 18:57:19 +08001059#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 if (ssl->session_negotiate) {
1061 mbedtls_ssl_session_free(ssl->session_negotiate);
1062 }
1063 if (ssl->handshake) {
1064 mbedtls_ssl_handshake_free(ssl);
1065 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001066
Jerry Yu2e199812022-12-01 18:57:19 +08001067#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001068 /*
1069 * Either the pointers are now NULL or cleared properly and can be freed.
1070 * Now allocate missing structures.
1071 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 if (ssl->transform_negotiate == NULL) {
1073 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001074 }
Jerry Yu2e199812022-12-01 18:57:19 +08001075#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001076
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 if (ssl->session_negotiate == NULL) {
1078 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001079 }
Paul Bakker48916f92012-09-16 19:57:18 +00001080
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 if (ssl->handshake == NULL) {
1082 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001083 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001084#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1085 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001086
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1088 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001089#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001090
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001091 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001093#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001094 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001095#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 ssl->session_negotiate == NULL) {
1097 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001098
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001100 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001101
1102#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001104 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001105#endif
1106
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001108 ssl->session_negotiate = NULL;
1109
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001111 }
1112
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001113 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 mbedtls_ssl_session_init(ssl->session_negotiate);
1115 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001116
Jerry Yu2e199812022-12-01 18:57:19 +08001117#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001119#endif
1120
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001121 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001122 ret = mbedtls_ssl_reset_checksum(ssl);
1123 if (ret != 0) {
1124 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1125 return ret;
1126 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001127
Jerry Yud0766ec2022-09-22 10:46:57 +08001128#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1129 defined(MBEDTLS_SSL_SRV_C) && \
1130 defined(MBEDTLS_SSL_SESSION_TICKETS)
1131 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001133#endif
1134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001135#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001137 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001138
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001140 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001142 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001144
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001146 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001147#endif
1148
Brett Warrene0edc842021-08-17 09:53:13 +01001149/*
1150 * curve_list is translated to IANA TLS group identifiers here because
1151 * mbedtls_ssl_conf_curves returns void and so can't return
1152 * any error codes.
1153 */
Valerio Setti6f0441d2023-07-03 12:11:36 +02001154#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01001155#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1156 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001158 size_t length;
1159 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1160
Thomas Daubney850a0792023-05-22 12:05:03 +01001161 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 }
Brett Warrene0edc842021-08-17 09:53:13 +01001163
1164 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1166 if (group_list == NULL) {
1167 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1168 }
Brett Warrene0edc842021-08-17 09:53:13 +01001169
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001171 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 curve_list[i]);
1173 if (tls_id == 0) {
1174 mbedtls_free(group_list);
1175 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001176 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001177 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001178 }
1179
1180 group_list[length] = 0;
1181
1182 ssl->handshake->group_list = group_list;
1183 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001185 ssl->handshake->group_list = ssl->conf->group_list;
1186 ssl->handshake->group_list_heap_allocated = 0;
1187 }
1188#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02001189#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01001190
Ronald Crone68ab4f2022-10-05 12:46:29 +02001191#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001192#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001193#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001194 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1195 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1197 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001198 const int *md;
1199 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001200 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001201 uint16_t *p;
1202
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001203 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1204 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1205 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001206
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1208 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001209 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 }
Valerio Setti75fba322023-02-23 17:35:09 +01001211#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001212 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001213#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001214
Jerry Yub476a442022-01-21 18:14:45 +08001215#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001217#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001218 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1219 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1220 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001221 }
1222
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1224 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1225 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001226
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1228 sizeof(uint16_t));
1229 if (ssl->handshake->sig_algs == NULL) {
1230 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1231 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001232
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 p = (uint16_t *) ssl->handshake->sig_algs;
1234 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1235 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1236 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001237 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 }
Valerio Setti75fba322023-02-23 17:35:09 +01001239#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001240 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001241 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001242#endif
1243#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001245 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001246#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001247 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001248 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001249 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001250 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001251#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001252 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001253 ssl->handshake->sig_algs_heap_allocated = 0;
1254 }
Jerry Yucc539102022-06-27 16:27:35 +08001255#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001256#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001257 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001258}
1259
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001260#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001261/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001262MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001263static int ssl_cookie_write_dummy(void *ctx,
1264 unsigned char **p, unsigned char *end,
1265 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001266{
1267 ((void) ctx);
1268 ((void) p);
1269 ((void) end);
1270 ((void) cli_id);
1271 ((void) cli_id_len);
1272
Gilles Peskine449bd832023-01-11 14:50:10 +01001273 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001274}
1275
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001276MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001277static int ssl_cookie_check_dummy(void *ctx,
1278 const unsigned char *cookie, size_t cookie_len,
1279 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001280{
1281 ((void) ctx);
1282 ((void) cookie);
1283 ((void) cookie_len);
1284 ((void) cli_id);
1285 ((void) cli_id_len);
1286
Gilles Peskine449bd832023-01-11 14:50:10 +01001287 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001288}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001289#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001290
Paul Bakker5121ce52009-01-03 21:22:43 +00001291/*
1292 * Initialize an SSL context
1293 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001294void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001295{
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001297}
1298
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001299MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001300static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001301{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001302 const mbedtls_ssl_config *conf = ssl->conf;
1303
Ronald Cron6f135e12021-12-08 16:57:54 +01001304#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1306 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1307 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1308 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001309 }
1310
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1312 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001313 }
1314#endif
1315
1316#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1318 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1319 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001320 }
1321#endif
1322
Ronald Cron6f135e12021-12-08 16:57:54 +01001323#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1325 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1326 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1327 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001328 }
1329
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1331 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001332 }
1333#endif
1334
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1336 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001337}
1338
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001339MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001340static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1341{
1342 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 ret = ssl_conf_version_check(ssl);
1344 if (ret != 0) {
1345 return ret;
1346 }
Jerry Yu60835a82021-08-04 10:13:52 +08001347
Jerry Yudef7ae42022-10-30 14:13:19 +08001348#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1349 /* RFC 8446 section 4.4.3
1350 *
1351 * If the verification fails, the receiver MUST terminate the handshake with
1352 * a "decrypt_error" alert.
1353 *
1354 * If the client is configured as TLS 1.3 only with optional verify, return
1355 * bad config.
1356 *
1357 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001358 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1359 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001360 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1361 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1362 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001364 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 1, ("Optional verify auth mode "
1366 "is not available for TLS 1.3 client"));
1367 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001368 }
1369#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1370
Jerry Yu60835a82021-08-04 10:13:52 +08001371 /* Space for further checks */
1372
Gilles Peskine449bd832023-01-11 14:50:10 +01001373 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001374}
1375
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001376/*
1377 * Setup an SSL context
1378 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1381 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001382{
Janos Follath865b3eb2019-12-16 11:46:15 +00001383 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001384 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1385 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001386
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001387 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001388
Gilles Peskine449bd832023-01-11 14:50:10 +01001389 if ((ret = ssl_conf_check(ssl)) != 0) {
1390 return ret;
1391 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001392 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001393
Paul Bakker62f2dee2012-09-28 07:31:51 +00001394 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001395 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001396 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001397
1398 /* Set to NULL in case of an error condition */
1399 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001400
Darryl Greenb33cc762019-11-28 14:29:44 +00001401#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1402 ssl->in_buf_len = in_buf_len;
1403#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1405 if (ssl->in_buf == NULL) {
1406 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001407 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001408 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001409 }
1410
Darryl Greenb33cc762019-11-28 14:29:44 +00001411#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1412 ssl->out_buf_len = out_buf_len;
1413#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1415 if (ssl->out_buf == NULL) {
1416 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001417 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001418 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001419 }
1420
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001422
Johan Pascalb62bb512015-12-03 21:56:45 +01001423#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001425#endif
1426
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001428 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001430
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001432
1433error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001434 mbedtls_free(ssl->in_buf);
1435 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001436
1437 ssl->conf = NULL;
1438
Darryl Greenb33cc762019-11-28 14:29:44 +00001439#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1440 ssl->in_buf_len = 0;
1441 ssl->out_buf_len = 0;
1442#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001443 ssl->in_buf = NULL;
1444 ssl->out_buf = NULL;
1445
1446 ssl->in_hdr = NULL;
1447 ssl->in_ctr = NULL;
1448 ssl->in_len = NULL;
1449 ssl->in_iv = NULL;
1450 ssl->in_msg = NULL;
1451
1452 ssl->out_hdr = NULL;
1453 ssl->out_ctr = NULL;
1454 ssl->out_len = NULL;
1455 ssl->out_iv = NULL;
1456 ssl->out_msg = NULL;
1457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001459}
1460
1461/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001462 * Reset an initialized and used SSL context for re-use while retaining
1463 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001464 *
1465 * If partial is non-zero, keep data in the input buffer and client ID.
1466 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001467 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001468void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1469 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001470{
Darryl Greenb33cc762019-11-28 14:29:44 +00001471#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1472 size_t in_buf_len = ssl->in_buf_len;
1473 size_t out_buf_len = ssl->out_buf_len;
1474#else
1475 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1476 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1477#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001478
Hanno Beckerb0302c42021-08-03 09:39:42 +01001479#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1480 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001481#endif
1482
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001483 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001484 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001485
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001487
1488 /* Reset incoming message parsing */
1489 ssl->in_offt = NULL;
1490 ssl->nb_zero = 0;
1491 ssl->in_msgtype = 0;
1492 ssl->in_msglen = 0;
1493 ssl->in_hslen = 0;
1494 ssl->keep_current_message = 0;
1495 ssl->transform_in = NULL;
1496
1497#if defined(MBEDTLS_SSL_PROTO_DTLS)
1498 ssl->next_record_offset = 0;
1499 ssl->in_epoch = 0;
1500#endif
1501
1502 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001504 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001506 }
1507
Ronald Cronad8c17b2022-06-10 17:18:09 +02001508 ssl->send_alert = 0;
1509
Hanno Beckerb0302c42021-08-03 09:39:42 +01001510 /* Reset outgoing message writing */
1511 ssl->out_msgtype = 0;
1512 ssl->out_msglen = 0;
1513 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 memset(ssl->out_buf, 0, out_buf_len);
1515 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001516 ssl->transform_out = NULL;
1517
1518#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001520#endif
1521
XiaokangQian2b01dc32022-01-21 02:53:13 +00001522#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001523 if (ssl->transform) {
1524 mbedtls_ssl_transform_free(ssl->transform);
1525 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001526 ssl->transform = NULL;
1527 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001528#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1529
XiaokangQian2b01dc32022-01-21 02:53:13 +00001530#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 mbedtls_ssl_transform_free(ssl->transform_application);
1532 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001533 ssl->transform_application = NULL;
1534
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001536#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001537 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1538 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001539 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001540#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001541
Gilles Peskine449bd832023-01-11 14:50:10 +01001542 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1543 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001544 ssl->handshake->transform_handshake = NULL;
1545 }
1546
XiaokangQian2b01dc32022-01-21 02:53:13 +00001547#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001548}
1549
Gilles Peskine449bd832023-01-11 14:50:10 +01001550int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001551{
1552 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1553
1554 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1555
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001557
1558 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559#if defined(MBEDTLS_SSL_RENEGOTIATION)
1560 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001561 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001562
1563 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1565 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001566#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001567 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001568
Hanno Beckerb0302c42021-08-03 09:39:42 +01001569 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001570 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 if (ssl->session) {
1572 mbedtls_ssl_session_free(ssl->session);
1573 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001574 ssl->session = NULL;
1575 }
1576
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001577#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001578 ssl->alpn_chosen = NULL;
1579#endif
1580
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001581#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001582 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001583#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001585#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 if (free_cli_id) {
1587 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001588 ssl->cli_id = NULL;
1589 ssl->cli_id_len = 0;
1590 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001591#endif
1592
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 if ((ret = ssl_handshake_init(ssl)) != 0) {
1594 return ret;
1595 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001596
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001598}
1599
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001600/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001601 * Reset an initialized and used SSL context for re-use while retaining
1602 * all application-set variables, function pointers and data.
1603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001604int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001605{
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001607}
1608
1609/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001610 * SSL set accessors
1611 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001612void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001613{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001614 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001615}
1616
Gilles Peskine449bd832023-01-11 14:50:10 +01001617void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001618{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001619 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001620}
1621
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001622#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001623void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001624{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001625 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001626}
1627#endif
1628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001630{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001631 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001632}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001633
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001634#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001635
Gilles Peskine449bd832023-01-11 14:50:10 +01001636void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1637 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001638{
1639 ssl->disable_datagram_packing = !allow_packing;
1640}
1641
Gilles Peskine449bd832023-01-11 14:50:10 +01001642void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1643 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001644{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001645 conf->hs_timeout_min = min;
1646 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001647}
1648#endif
1649
Gilles Peskine449bd832023-01-11 14:50:10 +01001650void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001651{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001652 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001653}
1654
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001656void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1657 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1658 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001659{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001660 conf->f_vrfy = f_vrfy;
1661 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001662}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001663#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001664
Gilles Peskine449bd832023-01-11 14:50:10 +01001665void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1666 int (*f_rng)(void *, unsigned char *, size_t),
1667 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001668{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001669 conf->f_rng = f_rng;
1670 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001671}
1672
Gilles Peskine449bd832023-01-11 14:50:10 +01001673void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1674 void (*f_dbg)(void *, int, const char *, int, const char *),
1675 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001676{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001677 conf->f_dbg = f_dbg;
1678 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001679}
1680
Gilles Peskine449bd832023-01-11 14:50:10 +01001681void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1682 void *p_bio,
1683 mbedtls_ssl_send_t *f_send,
1684 mbedtls_ssl_recv_t *f_recv,
1685 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001686{
1687 ssl->p_bio = p_bio;
1688 ssl->f_send = f_send;
1689 ssl->f_recv = f_recv;
1690 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001691}
1692
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001693#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001694void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001695{
1696 ssl->mtu = mtu;
1697}
1698#endif
1699
Gilles Peskine449bd832023-01-11 14:50:10 +01001700void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001701{
1702 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001703}
1704
Gilles Peskine449bd832023-01-11 14:50:10 +01001705void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1706 void *p_timer,
1707 mbedtls_ssl_set_timer_t *f_set_timer,
1708 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001709{
1710 ssl->p_timer = p_timer;
1711 ssl->f_set_timer = f_set_timer;
1712 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001713
1714 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001716}
1717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001719void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1720 void *p_cache,
1721 mbedtls_ssl_cache_get_t *f_get_cache,
1722 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001723{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001724 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001725 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001726 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001727}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001729
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001731int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001732{
Janos Follath865b3eb2019-12-16 11:46:15 +00001733 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001734
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001736 session == NULL ||
1737 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1739 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001740 }
1741
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 if (ssl->handshake->resume == 1) {
1743 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1744 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001745
Jerry Yu21092062022-10-10 21:21:31 +08001746#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001748 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001750
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001752 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1754 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1755 session->ciphersuite));
1756 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001757 }
Jerry Yu40afab62022-10-08 10:42:13 +08001758 }
Jerry Yu21092062022-10-10 21:21:31 +08001759#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1762 session)) != 0) {
1763 return ret;
1764 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001765
Paul Bakker0a597072012-09-25 21:55:46 +00001766 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001767
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001769}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001770#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001771
Gilles Peskine449bd832023-01-11 14:50:10 +01001772void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1773 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001774{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001775 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001776}
1777
Ronald Cron6f135e12021-12-08 16:57:54 +01001778#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001779void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1780 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001781{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001782 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001783}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001784
1785#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001786void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
1787 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001788{
1789 conf->early_data_enabled = early_data_enabled;
1790}
Jerry Yucc4e0072022-11-22 17:22:22 +08001791
1792#if defined(MBEDTLS_SSL_SRV_C)
1793void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001795{
Jerry Yu39da9852022-12-06 16:58:36 +08001796 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001797}
1798#endif /* MBEDTLS_SSL_SRV_C */
1799
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001800#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001801#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001804void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1805 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001806{
1807 conf->cert_profile = profile;
1808}
1809
Gilles Peskine449bd832023-01-11 14:50:10 +01001810static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001811{
1812 mbedtls_ssl_key_cert *cur = key_cert, *next;
1813
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001815 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001817 cur = next;
1818 }
1819}
1820
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001821/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001822MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001823static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1824 mbedtls_x509_crt *cert,
1825 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001826{
niisato8ee24222018-06-25 19:05:48 +09001827 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001828
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001830 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001832 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001834 }
1835
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1837 if (new_cert == NULL) {
1838 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1839 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001840
niisato8ee24222018-06-25 19:05:48 +09001841 new_cert->cert = cert;
1842 new_cert->key = key;
1843 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001844
Glenn Strauss36872db2022-01-22 05:06:31 -05001845 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001847 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001849 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001851 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 }
niisato8ee24222018-06-25 19:05:48 +09001853 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001854 }
1855
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001857}
1858
Gilles Peskine449bd832023-01-11 14:50:10 +01001859int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001860 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001862{
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001864}
1865
Gilles Peskine449bd832023-01-11 14:50:10 +01001866void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001867 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001869{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001870 conf->ca_chain = ca_chain;
1871 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001872
1873#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1874 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1875 * cannot be used together. */
1876 conf->f_ca_cb = NULL;
1877 conf->p_ca_cb = NULL;
1878#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001879}
Hanno Becker5adaad92019-03-27 16:54:37 +00001880
1881#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001882void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1883 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1884 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001885{
1886 conf->f_ca_cb = f_ca_cb;
1887 conf->p_ca_cb = p_ca_cb;
1888
1889 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1890 * cannot be used together. */
1891 conf->ca_chain = NULL;
1892 conf->ca_crl = NULL;
1893}
1894#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001896
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001897#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001898const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1899 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001900{
1901 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001903}
1904
Gilles Peskine449bd832023-01-11 14:50:10 +01001905int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1906 mbedtls_x509_crt *own_cert,
1907 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001908{
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1910 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001911}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001912
Gilles Peskine449bd832023-01-11 14:50:10 +01001913void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1914 mbedtls_x509_crt *ca_chain,
1915 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001916{
1917 ssl->handshake->sni_ca_chain = ca_chain;
1918 ssl->handshake->sni_ca_crl = ca_crl;
1919}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001920
Glenn Strauss999ef702022-03-11 01:37:23 -05001921#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001922void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1923 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001924{
1925 ssl->handshake->dn_hints = crt;
1926}
1927#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1928
Gilles Peskine449bd832023-01-11 14:50:10 +01001929void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1930 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001931{
1932 ssl->handshake->sni_authmode = authmode;
1933}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001934#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1935
Hanno Becker8927c832019-04-03 12:52:50 +01001936#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001937void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1938 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1939 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001940{
1941 ssl->f_vrfy = f_vrfy;
1942 ssl->p_vrfy = p_vrfy;
1943}
1944#endif
1945
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001946#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001947
Valerio Setti016f6822022-12-09 14:17:50 +01001948#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001949static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1950static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1951
Valerio Setti016f6822022-12-09 14:17:50 +01001952static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 mbedtls_ssl_context *ssl,
1954 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001955{
1956 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001957 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001958 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001959 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001960 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001961 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1963 psa_pake_cs_set_primitive(&cipher_suite,
1964 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1965 PSA_ECC_FAMILY_SECP_R1,
1966 256));
1967 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001968
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1970 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001971 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001973
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001975 user = jpake_server_id;
1976 user_len = sizeof(jpake_server_id);
1977 peer = jpake_client_id;
1978 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001980 user = jpake_client_id;
1981 user_len = sizeof(jpake_client_id);
1982 peer = jpake_server_id;
1983 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001985
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001986 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1987 if (status != PSA_SUCCESS) {
1988 return status;
1989 }
1990
1991 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001993 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 }
Valerio Setti016f6822022-12-09 14:17:50 +01001995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1997 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001998 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 }
Valerio Setti016f6822022-12-09 14:17:50 +01002000
2001 ssl->handshake->psa_pake_ctx_is_ok = 1;
2002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002004}
2005
Gilles Peskine449bd832023-01-11 14:50:10 +01002006int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2007 const unsigned char *pw,
2008 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002009{
2010 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2011 psa_status_t status;
2012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 if (ssl->handshake == NULL || ssl->conf == NULL) {
2014 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002015 }
2016
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 /* Empty password is not valid */
2018 if ((pw == NULL) || (pw_len == 0)) {
2019 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2020 }
2021
2022 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2023 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2024 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2025
2026 status = psa_import_key(&attributes, pw, pw_len,
2027 &ssl->handshake->psa_pake_password);
2028 if (status != PSA_SUCCESS) {
2029 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2030 }
2031
2032 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2033 ssl->handshake->psa_pake_password);
2034 if (status != PSA_SUCCESS) {
2035 psa_destroy_key(ssl->handshake->psa_pake_password);
2036 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2037 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2038 }
2039
2040 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002041}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002042
Gilles Peskine449bd832023-01-11 14:50:10 +01002043int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2044 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002045{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002046 psa_status_t status;
2047
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 if (ssl->handshake == NULL || ssl->conf == NULL) {
2049 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002050 }
2051
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 if (mbedtls_svc_key_id_is_null(pwd)) {
2053 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2054 }
2055
2056 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2057 if (status != PSA_SUCCESS) {
2058 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2059 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2060 }
2061
2062 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002063}
2064#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002065int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2066 const unsigned char *pw,
2067 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002068{
2069 mbedtls_ecjpake_role role;
2070
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 if (ssl->handshake == NULL || ssl->conf == NULL) {
2072 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2073 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002074
Valerio Settic689ed82022-12-07 14:40:38 +01002075 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if ((pw == NULL) || (pw_len == 0)) {
2077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2078 }
Valerio Settic689ed82022-12-07 14:40:38 +01002079
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002083 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002085
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2087 role,
2088 MBEDTLS_MD_SHA256,
2089 MBEDTLS_ECP_DP_SECP256R1,
2090 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002091}
Valerio Setti02c25b52022-11-15 14:08:42 +01002092#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002093#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002094
Ronald Cron73fe8df2022-10-05 14:31:43 +02002095#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002096int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002097{
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 if (conf->psk_identity == NULL ||
2099 conf->psk_identity_len == 0) {
2100 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002101 }
2102
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002103#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2105 return 1;
2106 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002107#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002108
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 if (conf->psk != NULL && conf->psk_len != 0) {
2110 return 1;
2111 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002112
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002114}
2115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002117{
2118 /* Remove reference to existing PSK, if any. */
2119#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002121 /* The maintenance of the PSK key slot is the
2122 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002123 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002124 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002125#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 if (conf->psk != NULL) {
2127 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 mbedtls_free(conf->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002130 conf->psk = NULL;
2131 conf->psk_len = 0;
2132 }
2133
2134 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 if (conf->psk_identity != NULL) {
2136 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002137 conf->psk_identity = NULL;
2138 conf->psk_identity_len = 0;
2139 }
2140}
2141
Hanno Becker7390c712018-11-15 13:33:04 +00002142/* This function assumes that PSK identity in the SSL config is unset.
2143 * It checks that the provided identity is well-formed and attempts
2144 * to make a copy of it in the SSL config.
2145 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002146MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002147static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2148 unsigned char const *psk_identity,
2149 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002150{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002151 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002153 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 (psk_identity_len >> 16) != 0 ||
2155 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2156 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002157 }
2158
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2160 if (conf->psk_identity == NULL) {
2161 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2162 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002163
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002164 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002168}
2169
Gilles Peskine449bd832023-01-11 14:50:10 +01002170int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2171 const unsigned char *psk, size_t psk_len,
2172 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002173{
Janos Follath865b3eb2019-12-16 11:46:15 +00002174 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002175
2176 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2178 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2179 }
Hanno Becker7390c712018-11-15 13:33:04 +00002180
2181 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 if (psk == NULL) {
2183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2184 }
2185 if (psk_len == 0) {
2186 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2187 }
2188 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2189 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2190 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2193 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2194 }
Hanno Becker7390c712018-11-15 13:33:04 +00002195 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002197
2198 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2200 if (ret != 0) {
2201 ssl_conf_remove_psk(conf);
2202 }
Hanno Becker7390c712018-11-15 13:33:04 +00002203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002205}
2206
Gilles Peskine449bd832023-01-11 14:50:10 +01002207static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002208{
2209#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002211 /* The maintenance of the external PSK key slot is the
2212 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 if (ssl->handshake->psk_opaque_is_internal) {
2214 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002215 ssl->handshake->psk_opaque_is_internal = 0;
2216 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002217 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002218 }
Neil Armstronge952a302022-05-03 10:22:14 +02002219#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 if (ssl->handshake->psk != NULL) {
2221 mbedtls_platform_zeroize(ssl->handshake->psk,
2222 ssl->handshake->psk_len);
2223 mbedtls_free(ssl->handshake->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002224 ssl->handshake->psk_len = 0;
2225 }
Neil Armstronge952a302022-05-03 10:22:14 +02002226#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002227}
2228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2230 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002231{
Neil Armstrong501c9322022-05-03 09:35:09 +02002232#if defined(MBEDTLS_USE_PSA_CRYPTO)
2233 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002234 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002235 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002236 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002237#endif /* MBEDTLS_USE_PSA_CRYPTO */
2238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 if (psk == NULL || ssl->handshake == NULL) {
2240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2241 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002242
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2244 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2245 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002246
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002248
Neil Armstrong501c9322022-05-03 09:35:09 +02002249#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002250#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2252 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2253 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2254 } else {
2255 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2256 }
2257 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002258 }
2259#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002260
Jerry Yu568ec252022-07-22 21:27:34 +08002261#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2263 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2264 psa_set_key_usage_flags(&key_attributes,
2265 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002266 }
2267#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 psa_set_key_algorithm(&key_attributes, alg);
2270 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2273 if (status != PSA_SUCCESS) {
2274 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2275 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002276
2277 /* Allow calling psa_destroy_key() on psk remove */
2278 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002280#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2282 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2283 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002284
2285 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002287
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002289#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002290}
2291
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002292#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002293int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2294 mbedtls_svc_key_id_t psk,
2295 const unsigned char *psk_identity,
2296 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002297{
Janos Follath865b3eb2019-12-16 11:46:15 +00002298 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002299
2300 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2302 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2303 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002304
Hanno Becker7390c712018-11-15 13:33:04 +00002305 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 if (mbedtls_svc_key_id_is_null(psk)) {
2307 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2308 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002309 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002310
2311 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2313 psk_identity_len);
2314 if (ret != 0) {
2315 ssl_conf_remove_psk(conf);
2316 }
Hanno Becker7390c712018-11-15 13:33:04 +00002317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002319}
2320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2322 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002323{
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 if ((mbedtls_svc_key_id_is_null(psk)) ||
2325 (ssl->handshake == NULL)) {
2326 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2327 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002328
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002330 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002332}
2333#endif /* MBEDTLS_USE_PSA_CRYPTO */
2334
Jerry Yu8897c072022-08-12 13:56:53 +08002335#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002336void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2337 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2338 size_t),
2339 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002340{
2341 conf->f_psk = f_psk;
2342 conf->p_psk = p_psk;
2343}
Jerry Yu8897c072022-08-12 13:56:53 +08002344#endif /* MBEDTLS_SSL_SRV_C */
2345
Ronald Cron73fe8df2022-10-05 14:31:43 +02002346#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002347
2348#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002349static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002351{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002352#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (alg == PSA_ALG_CBC_NO_PADDING) {
2354 return MBEDTLS_SSL_MODE_CBC;
2355 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002356#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002357 if (PSA_ALG_IS_AEAD(alg)) {
2358 return MBEDTLS_SSL_MODE_AEAD;
2359 }
2360 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002361}
2362
2363#else /* MBEDTLS_USE_PSA_CRYPTO */
2364
2365static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002367{
2368#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 if (mode == MBEDTLS_MODE_CBC) {
2370 return MBEDTLS_SSL_MODE_CBC;
2371 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002372#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2373
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002374#if defined(MBEDTLS_GCM_C) || \
2375 defined(MBEDTLS_CCM_C) || \
2376 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002378 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 mode == MBEDTLS_MODE_CHACHAPOLY) {
2380 return MBEDTLS_SSL_MODE_AEAD;
2381 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002382#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002383
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002385}
Gilles Peskine301711e2022-04-26 16:57:05 +02002386#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002387
Gilles Peskinee108d982022-04-26 16:50:40 +02002388static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2389 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002391{
2392#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2394 base_mode == MBEDTLS_SSL_MODE_CBC) {
2395 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002396 }
2397#else
2398 (void) encrypt_then_mac;
2399#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002401}
2402
Neil Armstrongab555e02022-04-04 11:07:59 +02002403mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002405{
Gilles Peskinee108d982022-04-26 16:50:40 +02002406 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002407#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002409#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002411#endif
2412 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002413
Gilles Peskinee108d982022-04-26 16:50:40 +02002414 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002415#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002416 encrypt_then_mac = transform->encrypt_then_mac;
2417#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002419}
2420
Neil Armstrongab555e02022-04-04 11:07:59 +02002421mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002422#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002424#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002426{
Gilles Peskinee108d982022-04-26 16:50:40 +02002427 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2428
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002429#if defined(MBEDTLS_USE_PSA_CRYPTO)
2430 psa_status_t status;
2431 psa_algorithm_t alg;
2432 psa_key_type_t type;
2433 size_t size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 status = mbedtls_ssl_cipher_to_psa(suite->cipher, 0, &alg, &type, &size);
2435 if (status == PSA_SUCCESS) {
2436 base_mode = mbedtls_ssl_get_base_mode(alg);
2437 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002438#else
2439 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002440 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002442 base_mode =
2443 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002445 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002446#endif /* MBEDTLS_USE_PSA_CRYPTO */
2447
Gilles Peskinee108d982022-04-26 16:50:40 +02002448#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2449 int encrypt_then_mac = 0;
2450#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002452}
2453
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002454#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002455
2456#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002457/* Serialization of TLS 1.3 sessions:
2458 *
2459 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002460 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002461 * uint64 ticket_received;
2462 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002463 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002464 * } ClientOnlyData;
2465 *
2466 * struct {
2467 * uint8 endpoint;
2468 * uint8 ciphersuite[2];
2469 * uint32 ticket_age_add;
2470 * uint8 ticket_flags;
2471 * opaque resumption_key<0..255>;
2472 * select ( endpoint ) {
2473 * case client: ClientOnlyData;
2474 * case server: uint64 start_time;
2475 * };
2476 * } serialized_session_tls13;
2477 *
2478 */
2479#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002480MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002481static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2482 unsigned char *buf,
2483 size_t buf_len,
2484 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002485{
2486 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002487#if defined(MBEDTLS_SSL_CLI_C) && \
2488 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 size_t hostname_len = (session->hostname == NULL) ?
2490 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002491#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002492 size_t needed = 1 /* endpoint */
2493 + 2 /* ciphersuite */
2494 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002495 + 1 /* ticket_flags */
2496 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002497 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2500 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2501 }
Jerry Yu34191072022-08-18 10:32:09 +08002502 needed += session->resumption_key_len; /* resumption_key */
2503
Jerry Yu438ddd82022-07-07 06:55:50 +00002504#if defined(MBEDTLS_HAVE_TIME)
2505 needed += 8; /* start_time or ticket_received */
2506#endif
2507
2508#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002510#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002511 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002513#endif
2514
Jerry Yu438ddd82022-07-07 06:55:50 +00002515 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002516 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002517
2518 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 if (session->ticket_len > SIZE_MAX - needed) {
2520 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2521 }
Jerry Yu34191072022-08-18 10:32:09 +08002522
Jerry Yue28d9742022-08-18 15:44:03 +08002523 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002524 }
2525#endif /* MBEDTLS_SSL_CLI_C */
2526
Jerry Yue36fdd62022-08-17 21:31:36 +08002527 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 if (needed > buf_len) {
2529 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2530 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002531
2532 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2534 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002535 p[7] = session->ticket_flags;
2536
2537 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002538 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002539 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002541 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002542
2543#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2545 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002546 p += 8;
2547 }
2548#endif /* MBEDTLS_HAVE_TIME */
2549
2550#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002552#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002554 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002556 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002558 p += hostname_len;
2559 }
2560#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2561
Jerry Yu438ddd82022-07-07 06:55:50 +00002562#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002564 p += 8;
2565#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002567 p += 4;
2568
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002570 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 if (session->ticket != NULL && session->ticket_len > 0) {
2573 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002574 p += session->ticket_len;
2575 }
2576 }
2577#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002579}
2580
2581MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002582static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2583 const unsigned char *buf,
2584 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002585{
2586 const unsigned char *p = buf;
2587 const unsigned char *end = buf + len;
2588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 if (end - p < 9) {
2590 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2591 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002592 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2594 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002595 session->ticket_flags = p[7];
2596
2597 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002598 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002599 p += 9;
2600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 if (end - p < session->resumption_key_len) {
2602 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2603 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2606 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2607 }
2608 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002609 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002610
2611#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2613 if (end - p < 8) {
2614 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2615 }
2616 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002617 p += 8;
2618 }
2619#endif /* MBEDTLS_HAVE_TIME */
2620
2621#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002623#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002625 size_t hostname_len;
2626 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 if (end - p < 2) {
2628 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2629 }
2630 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002631 p += 2;
2632
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 if (end - p < (long int) hostname_len) {
2634 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2635 }
2636 if (hostname_len > 0) {
2637 session->hostname = mbedtls_calloc(1, hostname_len);
2638 if (session->hostname == NULL) {
2639 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2640 }
2641 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002642 p += hostname_len;
2643 }
2644#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2645 MBEDTLS_SSL_SESSION_TICKETS */
2646
Jerry Yu438ddd82022-07-07 06:55:50 +00002647#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 if (end - p < 8) {
2649 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2650 }
2651 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002652 p += 8;
2653#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 if (end - p < 4) {
2655 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2656 }
2657 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002658 p += 4;
2659
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 if (end - p < 2) {
2661 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2662 }
2663 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002664 p += 2;
2665
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 if (end - p < (long int) session->ticket_len) {
2667 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2668 }
2669 if (session->ticket_len > 0) {
2670 session->ticket = mbedtls_calloc(1, session->ticket_len);
2671 if (session->ticket == NULL) {
2672 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2673 }
2674 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002675 p += session->ticket_len;
2676 }
2677 }
2678#endif /* MBEDTLS_SSL_CLI_C */
2679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002681
2682}
2683#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002684MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002685static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2686 unsigned char *buf,
2687 size_t buf_len,
2688 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002689{
2690 ((void) session);
2691 ((void) buf);
2692 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002693 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002695}
Jerry Yu438ddd82022-07-07 06:55:50 +00002696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2698 unsigned char *buf,
2699 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002700{
2701 ((void) session);
2702 ((void) buf);
2703 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002705}
2706#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002707#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2708
Gilles Peskine449bd832023-01-11 14:50:10 +01002709psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2710 size_t taglen,
2711 psa_algorithm_t *alg,
2712 psa_key_type_t *key_type,
2713 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002714{
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002716 case MBEDTLS_CIPHER_AES_128_CBC:
2717 *alg = PSA_ALG_CBC_NO_PADDING;
2718 *key_type = PSA_KEY_TYPE_AES;
2719 *key_size = 128;
2720 break;
2721 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002723 *key_type = PSA_KEY_TYPE_AES;
2724 *key_size = 128;
2725 break;
2726 case MBEDTLS_CIPHER_AES_128_GCM:
2727 *alg = PSA_ALG_GCM;
2728 *key_type = PSA_KEY_TYPE_AES;
2729 *key_size = 128;
2730 break;
2731 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002733 *key_type = PSA_KEY_TYPE_AES;
2734 *key_size = 192;
2735 break;
2736 case MBEDTLS_CIPHER_AES_192_GCM:
2737 *alg = PSA_ALG_GCM;
2738 *key_type = PSA_KEY_TYPE_AES;
2739 *key_size = 192;
2740 break;
2741 case MBEDTLS_CIPHER_AES_256_CBC:
2742 *alg = PSA_ALG_CBC_NO_PADDING;
2743 *key_type = PSA_KEY_TYPE_AES;
2744 *key_size = 256;
2745 break;
2746 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002748 *key_type = PSA_KEY_TYPE_AES;
2749 *key_size = 256;
2750 break;
2751 case MBEDTLS_CIPHER_AES_256_GCM:
2752 *alg = PSA_ALG_GCM;
2753 *key_type = PSA_KEY_TYPE_AES;
2754 *key_size = 256;
2755 break;
2756 case MBEDTLS_CIPHER_ARIA_128_CBC:
2757 *alg = PSA_ALG_CBC_NO_PADDING;
2758 *key_type = PSA_KEY_TYPE_ARIA;
2759 *key_size = 128;
2760 break;
2761 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002763 *key_type = PSA_KEY_TYPE_ARIA;
2764 *key_size = 128;
2765 break;
2766 case MBEDTLS_CIPHER_ARIA_128_GCM:
2767 *alg = PSA_ALG_GCM;
2768 *key_type = PSA_KEY_TYPE_ARIA;
2769 *key_size = 128;
2770 break;
2771 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002772 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002773 *key_type = PSA_KEY_TYPE_ARIA;
2774 *key_size = 192;
2775 break;
2776 case MBEDTLS_CIPHER_ARIA_192_GCM:
2777 *alg = PSA_ALG_GCM;
2778 *key_type = PSA_KEY_TYPE_ARIA;
2779 *key_size = 192;
2780 break;
2781 case MBEDTLS_CIPHER_ARIA_256_CBC:
2782 *alg = PSA_ALG_CBC_NO_PADDING;
2783 *key_type = PSA_KEY_TYPE_ARIA;
2784 *key_size = 256;
2785 break;
2786 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002788 *key_type = PSA_KEY_TYPE_ARIA;
2789 *key_size = 256;
2790 break;
2791 case MBEDTLS_CIPHER_ARIA_256_GCM:
2792 *alg = PSA_ALG_GCM;
2793 *key_type = PSA_KEY_TYPE_ARIA;
2794 *key_size = 256;
2795 break;
2796 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2797 *alg = PSA_ALG_CBC_NO_PADDING;
2798 *key_type = PSA_KEY_TYPE_CAMELLIA;
2799 *key_size = 128;
2800 break;
2801 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002803 *key_type = PSA_KEY_TYPE_CAMELLIA;
2804 *key_size = 128;
2805 break;
2806 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2807 *alg = PSA_ALG_GCM;
2808 *key_type = PSA_KEY_TYPE_CAMELLIA;
2809 *key_size = 128;
2810 break;
2811 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002813 *key_type = PSA_KEY_TYPE_CAMELLIA;
2814 *key_size = 192;
2815 break;
2816 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2817 *alg = PSA_ALG_GCM;
2818 *key_type = PSA_KEY_TYPE_CAMELLIA;
2819 *key_size = 192;
2820 break;
2821 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2822 *alg = PSA_ALG_CBC_NO_PADDING;
2823 *key_type = PSA_KEY_TYPE_CAMELLIA;
2824 *key_size = 256;
2825 break;
2826 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002828 *key_type = PSA_KEY_TYPE_CAMELLIA;
2829 *key_size = 256;
2830 break;
2831 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2832 *alg = PSA_ALG_GCM;
2833 *key_type = PSA_KEY_TYPE_CAMELLIA;
2834 *key_size = 256;
2835 break;
2836 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2837 *alg = PSA_ALG_CHACHA20_POLY1305;
2838 *key_type = PSA_KEY_TYPE_CHACHA20;
2839 *key_size = 256;
2840 break;
2841 case MBEDTLS_CIPHER_NULL:
2842 *alg = MBEDTLS_SSL_NULL_CIPHER;
2843 *key_type = 0;
2844 *key_size = 0;
2845 break;
2846 default:
2847 return PSA_ERROR_NOT_SUPPORTED;
2848 }
2849
2850 return PSA_SUCCESS;
2851}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002852#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002853
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002854#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002855int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2856 const unsigned char *dhm_P, size_t P_len,
2857 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002858{
Janos Follath865b3eb2019-12-16 11:46:15 +00002859 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 mbedtls_mpi_free(&conf->dhm_P);
2862 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2865 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2866 mbedtls_mpi_free(&conf->dhm_P);
2867 mbedtls_mpi_free(&conf->dhm_G);
2868 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002869 }
2870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002872}
Paul Bakker5121ce52009-01-03 21:22:43 +00002873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002875{
Janos Follath865b3eb2019-12-16 11:46:15 +00002876 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002877
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 mbedtls_mpi_free(&conf->dhm_P);
2879 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2882 &conf->dhm_P)) != 0 ||
2883 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2884 &conf->dhm_G)) != 0) {
2885 mbedtls_mpi_free(&conf->dhm_P);
2886 mbedtls_mpi_free(&conf->dhm_G);
2887 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002888 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002889
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002891}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002892#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002893
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002894#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2895/*
2896 * Set the minimum length for Diffie-Hellman parameters
2897 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002898void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2899 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002900{
2901 conf->dhm_min_bitlen = bitlen;
2902}
2903#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2904
Ronald Crone68ab4f2022-10-05 12:46:29 +02002905#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002906#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002907/*
2908 * Set allowed/preferred hashes for handshake signatures
2909 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002910void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2911 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002912{
2913 conf->sig_hashes = hashes;
2914}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002915#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002916
Jerry Yuf017ee42022-01-12 15:49:48 +08002917/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002918void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2919 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002920{
Jerry Yuf017ee42022-01-12 15:49:48 +08002921#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2922 conf->sig_hashes = NULL;
2923#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2924 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002925}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002926#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002927
Valerio Setti6f0441d2023-07-03 12:11:36 +02002928#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01002929#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002930/*
2931 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002932 *
2933 * mbedtls_ssl_setup() takes the provided list
2934 * and translates it to a list of IANA TLS group identifiers,
2935 * stored in ssl->handshake->group_list.
2936 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002937 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002938void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2939 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002940{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002941 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002942 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002943}
Brett Warrene0edc842021-08-17 09:53:13 +01002944#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02002945#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002946
Brett Warrene0edc842021-08-17 09:53:13 +01002947/*
2948 * Set the allowed groups
2949 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002950void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2951 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002952{
Valerio Setti6f0441d2023-07-03 12:11:36 +02002953#if defined(MBEDTLS_PK_HAVE_ECC_KEYS) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002954 conf->curve_list = NULL;
2955#endif
2956 conf->group_list = group_list;
2957}
2958
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002959#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002960int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002961{
Hanno Becker947194e2017-04-07 13:25:49 +01002962 /* Initialize to suppress unnecessary compiler warning */
2963 size_t hostname_len = 0;
2964
2965 /* Check if new hostname is valid before
2966 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 if (hostname != NULL) {
2968 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002969
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2971 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2972 }
Hanno Becker947194e2017-04-07 13:25:49 +01002973 }
2974
2975 /* Now it's clear that we will overwrite the old hostname,
2976 * so we can free it safely */
2977
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 if (ssl->hostname != NULL) {
2979 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
2980 mbedtls_free(ssl->hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002981 }
2982
2983 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002986 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 } else {
2988 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2989 if (ssl->hostname == NULL) {
2990 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2991 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002992
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002994
Hanno Becker947194e2017-04-07 13:25:49 +01002995 ssl->hostname[hostname_len] = '\0';
2996 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002997
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002999}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003000#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003001
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003002#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003003void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3004 int (*f_sni)(void *, mbedtls_ssl_context *,
3005 const unsigned char *, size_t),
3006 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003007{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003008 conf->f_sni = f_sni;
3009 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003010}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003011#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003014int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003015{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003016 size_t cur_len, tot_len;
3017 const char **p;
3018
3019 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003020 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3021 * MUST NOT be truncated."
3022 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003023 */
3024 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 for (p = protos; *p != NULL; p++) {
3026 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003027 tot_len += cur_len;
3028
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 if ((cur_len == 0) ||
3030 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3031 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3032 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3033 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003034 }
3035
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003036 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003039}
3040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003042{
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003044}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003045#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003046
Johan Pascalb62bb512015-12-03 21:56:45 +01003047#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003048void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3049 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003050{
3051 conf->dtls_srtp_mki_support = support_mki_value;
3052}
3053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3055 unsigned char *mki_value,
3056 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003057{
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003060 }
Ron Eldor591f1622018-01-22 12:30:04 +02003061
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3063 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003064 }
Ron Eldor591f1622018-01-22 12:30:04 +02003065
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003067 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003069}
3070
Gilles Peskine449bd832023-01-11 14:50:10 +01003071int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3072 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003073{
Johan Pascal253d0262020-09-22 13:04:45 +02003074 const mbedtls_ssl_srtp_profile *p;
3075 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003076
Johan Pascal253d0262020-09-22 13:04:45 +02003077 /* check the profiles list: all entry must be valid,
3078 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3080 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3081 p++) {
3082 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003083 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003085 /* unsupported value, stop parsing and set the size to an error value */
3086 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003087 }
3088 }
3089
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3091 conf->dtls_srtp_profile_list = NULL;
3092 conf->dtls_srtp_profile_list_len = 0;
3093 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003094 }
3095
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003096 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003097 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003098
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003100}
3101
Gilles Peskine449bd832023-01-11 14:50:10 +01003102void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3103 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003104{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003105 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3106 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003108 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003110 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3112 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003113 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003114}
Johan Pascalb62bb512015-12-03 21:56:45 +01003115#endif /* MBEDTLS_SSL_DTLS_SRTP */
3116
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303117#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003118void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003119{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003120 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003121}
3122
Gilles Peskine449bd832023-01-11 14:50:10 +01003123void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003124{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003125 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003126}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303127#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003128
Janos Follath088ce432017-04-10 12:42:31 +01003129#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003130void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3131 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003132{
3133 conf->cert_req_ca_list = cert_req_ca_list;
3134}
3135#endif
3136
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003138void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003139{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003140 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003141}
3142#endif
3143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003144#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003145void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003146{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003147 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003148}
3149#endif
3150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003152int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003153{
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3155 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3156 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003157 }
3158
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003159 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003160
Gilles Peskine449bd832023-01-11 14:50:10 +01003161 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003162}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003163#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003164
Gilles Peskine449bd832023-01-11 14:50:10 +01003165void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003166{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003167 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003168}
3169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003171void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003172{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003173 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003174}
3175
Gilles Peskine449bd832023-01-11 14:50:10 +01003176void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003177{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003178 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003179}
3180
Gilles Peskine449bd832023-01-11 14:50:10 +01003181void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3182 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003183{
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003185}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003189#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003190void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003191{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003192 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003193}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003194#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003195
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003196#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003197
Jerry Yud0766ec2022-09-22 10:46:57 +08003198#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003199void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3200 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003201{
Jerry Yud0766ec2022-09-22 10:46:57 +08003202 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003203}
3204#endif
3205
Gilles Peskine449bd832023-01-11 14:50:10 +01003206void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3207 mbedtls_ssl_ticket_write_t *f_ticket_write,
3208 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3209 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003210{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003211 conf->f_ticket_write = f_ticket_write;
3212 conf->f_ticket_parse = f_ticket_parse;
3213 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003214}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003215#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003216#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003217
Gilles Peskine449bd832023-01-11 14:50:10 +01003218void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3219 mbedtls_ssl_export_keys_t *f_export_keys,
3220 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003221{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003222 ssl->f_export_keys = f_export_keys;
3223 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003224}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003225
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003226#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003227void mbedtls_ssl_conf_async_private_cb(
3228 mbedtls_ssl_config *conf,
3229 mbedtls_ssl_async_sign_t *f_async_sign,
3230 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3231 mbedtls_ssl_async_resume_t *f_async_resume,
3232 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003233 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003234{
3235 conf->f_async_sign_start = f_async_sign;
3236 conf->f_async_decrypt_start = f_async_decrypt;
3237 conf->f_async_resume = f_async_resume;
3238 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003239 conf->p_async_config_data = async_config_data;
3240}
3241
Gilles Peskine449bd832023-01-11 14:50:10 +01003242void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003243{
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003245}
3246
Gilles Peskine449bd832023-01-11 14:50:10 +01003247void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003248{
Gilles Peskine449bd832023-01-11 14:50:10 +01003249 if (ssl->handshake == NULL) {
3250 return NULL;
3251 } else {
3252 return ssl->handshake->user_async_ctx;
3253 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003254}
3255
Gilles Peskine449bd832023-01-11 14:50:10 +01003256void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3257 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003258{
Gilles Peskine449bd832023-01-11 14:50:10 +01003259 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003260 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003262}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003263#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003264
Paul Bakker5121ce52009-01-03 21:22:43 +00003265/*
3266 * SSL get accessors
3267 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003268uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003269{
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 if (ssl->session != NULL) {
3271 return ssl->session->verify_result;
3272 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003273
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 if (ssl->session_negotiate != NULL) {
3275 return ssl->session_negotiate->verify_result;
3276 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003277
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003279}
3280
Gilles Peskine449bd832023-01-11 14:50:10 +01003281int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003282{
Gilles Peskine449bd832023-01-11 14:50:10 +01003283 if (ssl == NULL || ssl->session == NULL) {
3284 return 0;
3285 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003286
Gilles Peskine449bd832023-01-11 14:50:10 +01003287 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003288}
3289
Gilles Peskine449bd832023-01-11 14:50:10 +01003290const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003291{
Gilles Peskine449bd832023-01-11 14:50:10 +01003292 if (ssl == NULL || ssl->session == NULL) {
3293 return NULL;
3294 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003295
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003297}
3298
Gilles Peskine449bd832023-01-11 14:50:10 +01003299const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003300{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003301#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003302 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3303 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003304 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003306 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003308 }
3309 }
3310#endif
3311
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003313 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003315 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003317 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003319 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003320}
3321
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003322#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003323size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003324{
David Horstmann95d516f2021-05-04 18:36:56 +01003325 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003326 size_t read_mfl;
3327
Jerry Yuddda0502022-12-01 19:43:12 +08003328#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003329 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3331 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3332 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003333 }
Jerry Yuddda0502022-12-01 19:43:12 +08003334#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003335
3336 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003337 if (ssl->session_out != NULL) {
3338 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3339 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003340 max_len = read_mfl;
3341 }
3342 }
3343
Jerry Yuddda0502022-12-01 19:43:12 +08003344 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003345 if (ssl->session_negotiate != NULL) {
3346 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3347 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003348 max_len = read_mfl;
3349 }
3350 }
3351
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003353}
3354
Gilles Peskine449bd832023-01-11 14:50:10 +01003355size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003356{
3357 size_t max_len;
3358
3359 /*
3360 * Assume mfl_code is correct since it was checked when set
3361 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003363
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003364 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 if (ssl->session_out != NULL &&
3366 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3367 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003368 }
3369
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003370 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 if (ssl->session_negotiate != NULL &&
3372 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3373 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003374 }
3375
Gilles Peskine449bd832023-01-11 14:50:10 +01003376 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003377}
3378#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3379
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003380#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003381size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003382{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003383 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3385 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3386 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3387 return 0;
3388 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003389
Gilles Peskine449bd832023-01-11 14:50:10 +01003390 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3391 return ssl->mtu;
3392 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003393
Gilles Peskine449bd832023-01-11 14:50:10 +01003394 if (ssl->mtu == 0) {
3395 return ssl->handshake->mtu;
3396 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003397
Gilles Peskine449bd832023-01-11 14:50:10 +01003398 return ssl->mtu < ssl->handshake->mtu ?
3399 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003400}
3401#endif /* MBEDTLS_SSL_PROTO_DTLS */
3402
Gilles Peskine449bd832023-01-11 14:50:10 +01003403int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003404{
3405 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3406
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003407#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3408 !defined(MBEDTLS_SSL_PROTO_DTLS)
3409 (void) ssl;
3410#endif
3411
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003412#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003414
Gilles Peskine449bd832023-01-11 14:50:10 +01003415 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003416 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003417 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003418#endif
3419
3420#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003421 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3422 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3423 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003424 const size_t overhead = (size_t) ret;
3425
Gilles Peskine449bd832023-01-11 14:50:10 +01003426 if (ret < 0) {
3427 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003428 }
3429
Gilles Peskine449bd832023-01-11 14:50:10 +01003430 if (mtu <= overhead) {
3431 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3432 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3433 }
3434
3435 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003436 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003437 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003438 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003439#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003440
Hanno Becker0defedb2018-08-10 12:35:02 +01003441#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3442 !defined(MBEDTLS_SSL_PROTO_DTLS)
3443 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003444#endif
3445
Gilles Peskine449bd832023-01-11 14:50:10 +01003446 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003447}
3448
Gilles Peskine449bd832023-01-11 14:50:10 +01003449int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003450{
3451 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3452
3453#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3454 (void) ssl;
3455#endif
3456
3457#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003459
Gilles Peskine449bd832023-01-11 14:50:10 +01003460 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003461 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003462 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003463#endif
3464
Gilles Peskine449bd832023-01-11 14:50:10 +01003465 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003466}
3467
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003468#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003469const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003470{
Gilles Peskine449bd832023-01-11 14:50:10 +01003471 if (ssl == NULL || ssl->session == NULL) {
3472 return NULL;
3473 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003474
Hanno Beckere6824572019-02-07 13:18:46 +00003475#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003476 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003477#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003478 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003479#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003480}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003481#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003483#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003484int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3485 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003486{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003487 int ret;
3488
Gilles Peskine449bd832023-01-11 14:50:10 +01003489 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003490 dst == NULL ||
3491 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003492 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3493 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003494 }
3495
Hanno Beckere810bbc2021-05-14 16:01:05 +01003496 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3497 * idempotent: Each session can only be exported once.
3498 *
3499 * (This is in preparation for TLS 1.3 support where we will
3500 * need the ability to export multiple sessions (aka tickets),
3501 * which will be achieved by calling mbedtls_ssl_get_session()
3502 * multiple times until it fails.)
3503 *
3504 * Check whether we have already exported the current session,
3505 * and fail if so.
3506 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003507 if (ssl->session->exported == 1) {
3508 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3509 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003510
Gilles Peskine449bd832023-01-11 14:50:10 +01003511 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3512 if (ret != 0) {
3513 return ret;
3514 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003515
3516 /* Remember that we've exported the session. */
3517 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003518 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003519}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003521
Paul Bakker5121ce52009-01-03 21:22:43 +00003522/*
Hanno Beckera835da52019-05-16 12:39:07 +01003523 * Define ticket header determining Mbed TLS version
3524 * and structure of the ticket.
3525 */
3526
Hanno Becker94ef3b32019-05-16 12:50:45 +01003527/*
Hanno Becker50b59662019-05-28 14:30:45 +01003528 * Define bitflag determining compile-time settings influencing
3529 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003530 */
3531
Hanno Becker50b59662019-05-28 14:30:45 +01003532#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003533#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003534#else
Hanno Becker3e088662019-05-29 11:10:18 +01003535#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003536#endif /* MBEDTLS_HAVE_TIME */
3537
3538#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003539#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003540#else
Hanno Becker3e088662019-05-29 11:10:18 +01003541#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003542#endif /* MBEDTLS_X509_CRT_PARSE_C */
3543
3544#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003545#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003546#else
Hanno Becker3e088662019-05-29 11:10:18 +01003547#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003548#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3549
3550#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003551#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003552#else
Hanno Becker3e088662019-05-29 11:10:18 +01003553#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003554#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3555
Hanno Becker94ef3b32019-05-16 12:50:45 +01003556#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003557#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003558#else
Hanno Becker3e088662019-05-29 11:10:18 +01003559#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003560#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3561
Hanno Becker94ef3b32019-05-16 12:50:45 +01003562#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3563#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3564#else
3565#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3566#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3567
Hanno Becker3e088662019-05-29 11:10:18 +01003568#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3569#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3570#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3571#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003572#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3573#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003574
Hanno Becker50b59662019-05-28 14:30:45 +01003575#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003576 ((uint16_t) ( \
3577 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3578 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3579 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3580 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3581 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3582 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3583 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003584
Hanno Beckerf8787072019-05-16 12:41:07 +01003585static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003586 MBEDTLS_VERSION_MAJOR,
3587 MBEDTLS_VERSION_MINOR,
3588 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003589 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3590 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003591};
Hanno Beckera835da52019-05-16 12:39:07 +01003592
3593/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003594 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003595 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003596 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003597 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003598 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003599 * opaque mbedtls_version[3]; // library version: major, minor, patch
3600 * opaque session_format[2]; // library-version specific 16-bit field
3601 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003602 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003603 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003604 * Note: When updating the format, remember to keep
3605 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003606 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003607 * // In this version, `session_format` determines
3608 * // the setting of those compile-time
3609 * // configuration options which influence
3610 * // the structure of mbedtls_ssl_session.
3611 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003612 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003613 * // - TLS 1.2 (0x0303)
3614 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003615 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003616 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003617 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003618 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003619 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003620 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003621 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003622 *
3623 * };
3624 *
3625 * } serialized_session;
3626 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003627 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003628
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003629MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003630static int ssl_session_save(const mbedtls_ssl_session *session,
3631 unsigned char omit_header,
3632 unsigned char *buf,
3633 size_t buf_len,
3634 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003635{
3636 unsigned char *p = buf;
3637 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003638 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003639#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3640 size_t out_len;
3641 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3642#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003643 if (session == NULL) {
3644 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3645 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003646
Gilles Peskine449bd832023-01-11 14:50:10 +01003647 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003648 /*
3649 * Add Mbed TLS version identifier
3650 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003651 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003652
Gilles Peskine449bd832023-01-11 14:50:10 +01003653 if (used <= buf_len) {
3654 memcpy(p, ssl_serialized_session_header,
3655 sizeof(ssl_serialized_session_header));
3656 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003657 }
3658 }
3659
3660 /*
3661 * TLS version identifier
3662 */
3663 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003664 if (used <= buf_len) {
3665 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003666 }
3667
3668 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003669 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003670 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003671#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003672 case MBEDTLS_SSL_VERSION_TLS1_2:
3673 used += ssl_tls12_session_save(session, p, remaining_len);
3674 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003675#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3676
Jerry Yu251a12e2022-07-13 15:15:48 +08003677#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003678 case MBEDTLS_SSL_VERSION_TLS1_3:
3679 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3680 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3681 return ret;
3682 }
3683 used += out_len;
3684 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003685#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3686
Gilles Peskine449bd832023-01-11 14:50:10 +01003687 default:
3688 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003689 }
3690
3691 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003692 if (used > buf_len) {
3693 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3694 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003695
Gilles Peskine449bd832023-01-11 14:50:10 +01003696 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003697}
3698
3699/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003700 * Public wrapper for ssl_session_save()
3701 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003702int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3703 unsigned char *buf,
3704 size_t buf_len,
3705 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003706{
Gilles Peskine449bd832023-01-11 14:50:10 +01003707 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003708}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003709
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003710/*
3711 * Deserialize session, see mbedtls_ssl_session_save() for format.
3712 *
3713 * This internal version is wrapped by a public function that cleans up in
3714 * case of error, and has an extra option omit_header.
3715 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003716MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003717static int ssl_session_load(mbedtls_ssl_session *session,
3718 unsigned char omit_header,
3719 const unsigned char *buf,
3720 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003721{
3722 const unsigned char *p = buf;
3723 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003724 size_t remaining_len;
3725
3726
Gilles Peskine449bd832023-01-11 14:50:10 +01003727 if (session == NULL) {
3728 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3729 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003730
Gilles Peskine449bd832023-01-11 14:50:10 +01003731 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003732 /*
3733 * Check Mbed TLS version identifier
3734 */
3735
Gilles Peskine449bd832023-01-11 14:50:10 +01003736 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003738 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003739
3740 if (memcmp(p, ssl_serialized_session_header,
3741 sizeof(ssl_serialized_session_header)) != 0) {
3742 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3743 }
3744 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003745 }
3746
3747 /*
3748 * TLS version identifier
3749 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003750 if (1 > (size_t) (end - p)) {
3751 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3752 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003753 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003754
3755 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003756 remaining_len = (end - p);
3757 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003758#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003759 case MBEDTLS_SSL_VERSION_TLS1_2:
3760 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003761#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3762
Jerry Yu438ddd82022-07-07 06:55:50 +00003763#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003764 case MBEDTLS_SSL_VERSION_TLS1_3:
3765 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003766#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3767
Gilles Peskine449bd832023-01-11 14:50:10 +01003768 default:
3769 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003770 }
3771}
3772
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003773/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003774 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003775 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003776int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3777 const unsigned char *buf,
3778 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003779{
Gilles Peskine449bd832023-01-11 14:50:10 +01003780 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003781
Gilles Peskine449bd832023-01-11 14:50:10 +01003782 if (ret != 0) {
3783 mbedtls_ssl_session_free(session);
3784 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003785
Gilles Peskine449bd832023-01-11 14:50:10 +01003786 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003787}
3788
3789/*
Paul Bakker1961b702013-01-25 14:49:24 +01003790 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003791 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003792MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003793static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003794{
3795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3796
Ronald Cron66dbf912022-02-02 15:33:46 +01003797 /*
3798 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003799 * that were written into the output buffer by the previous handshake step,
3800 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003801 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3802 * We proceed to the next handshake step only when all data from the
3803 * previous one have been sent to the peer, thus we make sure that this is
3804 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3805 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3806 * we have to wait before to go ahead.
3807 * In the case of TLS 1.3, handshake step handlers do not send data to the
3808 * peer. Data are only sent here and through
3809 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003810 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003811 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003812 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3813 return ret;
3814 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003815
3816#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003817 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3818 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3819 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3820 return ret;
3821 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003822 }
3823#endif /* MBEDTLS_SSL_PROTO_DTLS */
3824
Gilles Peskine449bd832023-01-11 14:50:10 +01003825 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003826}
3827
Gilles Peskine449bd832023-01-11 14:50:10 +01003828int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003829{
Hanno Becker41934dd2021-08-07 19:13:43 +01003830 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003831
Gilles Peskine449bd832023-01-11 14:50:10 +01003832 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003833 ssl->conf == NULL ||
3834 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003835 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3836 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003837 }
3838
Gilles Peskine449bd832023-01-11 14:50:10 +01003839 ret = ssl_prepare_handshake_step(ssl);
3840 if (ret != 0) {
3841 return ret;
3842 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003843
Gilles Peskine449bd832023-01-11 14:50:10 +01003844 ret = mbedtls_ssl_handle_pending_alert(ssl);
3845 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003846 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003847 }
Jerry Yue7047812021-09-13 19:26:39 +08003848
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003849 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3850 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3851 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3852
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003853#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003854 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3855 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003856 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003857
Gilles Peskine449bd832023-01-11 14:50:10 +01003858 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003859 case MBEDTLS_SSL_HELLO_REQUEST:
3860 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003861 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003862 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003863
Ronald Cron9f0fba32022-02-10 16:45:15 +01003864 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003865 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003866 break;
3867
3868 default:
3869#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003870 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3871 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3872 } else {
3873 ret = mbedtls_ssl_handshake_client_step(ssl);
3874 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003875#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003876 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003877#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003878 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003879#endif
3880 }
Jerry Yub9930e72021-08-06 17:11:51 +08003881 }
Ronald Cron6291b232023-03-08 15:51:25 +01003882#endif /* MBEDTLS_SSL_CLI_C */
3883
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003884#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003885 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003886#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3887 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003888 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003889 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003890 ret = mbedtls_ssl_handshake_server_step(ssl);
3891 }
Ronald Cron6291b232023-03-08 15:51:25 +01003892#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3893 ret = mbedtls_ssl_handshake_server_step(ssl);
3894#else
3895 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003896#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003897 }
3898#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003899
Gilles Peskine449bd832023-01-11 14:50:10 +01003900 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003901 /* handshake_step return error. And it is same
3902 * with alert_reason.
3903 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003904 if (ssl->send_alert) {
3905 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003906 goto cleanup;
3907 }
3908 }
3909
3910cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003911 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003912}
3913
3914/*
3915 * Perform the SSL handshake
3916 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003917int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003918{
3919 int ret = 0;
3920
Hanno Beckera817ea42020-10-20 15:20:23 +01003921 /* Sanity checks */
3922
Gilles Peskine449bd832023-01-11 14:50:10 +01003923 if (ssl == NULL || ssl->conf == NULL) {
3924 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3925 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003926
Hanno Beckera817ea42020-10-20 15:20:23 +01003927#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003928 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3929 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3930 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3931 "mbedtls_ssl_set_timer_cb() for DTLS"));
3932 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003933 }
3934#endif /* MBEDTLS_SSL_PROTO_DTLS */
3935
Gilles Peskine449bd832023-01-11 14:50:10 +01003936 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003937
Hanno Beckera817ea42020-10-20 15:20:23 +01003938 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003939 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3940 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003941
Gilles Peskine449bd832023-01-11 14:50:10 +01003942 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003943 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003944 }
Paul Bakker1961b702013-01-25 14:49:24 +01003945 }
3946
Gilles Peskine449bd832023-01-11 14:50:10 +01003947 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003948
Gilles Peskine449bd832023-01-11 14:50:10 +01003949 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003950}
3951
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003952#if defined(MBEDTLS_SSL_RENEGOTIATION)
3953#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003954/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003955 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003956 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003957MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003958static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003959{
Janos Follath865b3eb2019-12-16 11:46:15 +00003960 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003961
Gilles Peskine449bd832023-01-11 14:50:10 +01003962 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003963
3964 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003965 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3966 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003967
Gilles Peskine449bd832023-01-11 14:50:10 +01003968 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3969 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3970 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003971 }
3972
Gilles Peskine449bd832023-01-11 14:50:10 +01003973 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003974
Gilles Peskine449bd832023-01-11 14:50:10 +01003975 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003976}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003977#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003978
3979/*
3980 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003981 * - any side: calling mbedtls_ssl_renegotiate(),
3982 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3983 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003984 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003985 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003986 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003987 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003988int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003989{
Janos Follath865b3eb2019-12-16 11:46:15 +00003990 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003991
Gilles Peskine449bd832023-01-11 14:50:10 +01003992 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00003993
Gilles Peskine449bd832023-01-11 14:50:10 +01003994 if ((ret = ssl_handshake_init(ssl)) != 0) {
3995 return ret;
3996 }
Paul Bakker48916f92012-09-16 19:57:18 +00003997
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003998 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3999 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004000#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004001 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4002 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4003 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004004 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004006 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004008 }
4009#endif
4010
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004011 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4012 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004013
Gilles Peskine449bd832023-01-11 14:50:10 +01004014 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4015 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4016 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004017 }
4018
Gilles Peskine449bd832023-01-11 14:50:10 +01004019 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004020
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004022}
4023
4024/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004025 * Renegotiate current connection on client,
4026 * or request renegotiation on server
4027 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004028int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004029{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004030 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004031
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 if (ssl == NULL || ssl->conf == NULL) {
4033 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4034 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004036#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004037 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004038 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4039 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4041 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004043 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004044
4045 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 if (ssl->out_left != 0) {
4047 return mbedtls_ssl_flush_output(ssl);
4048 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004049
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004051 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004052#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004053
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004054#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004055 /*
4056 * On client, either start the renegotiation process or,
4057 * if already in progress, continue the handshake
4058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4060 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4061 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004062 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004063
4064 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4065 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4066 return ret;
4067 }
4068 } else {
4069 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4070 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4071 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004072 }
4073 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004074#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004075
Gilles Peskine449bd832023-01-11 14:50:10 +01004076 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004077}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004078#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004079
Gilles Peskine449bd832023-01-11 14:50:10 +01004080void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004081{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004082 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4083
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004085 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004087
Valerio Setti6f0441d2023-07-03 12:11:36 +02004088#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004089#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004090 if (ssl->handshake->group_list_heap_allocated) {
4091 mbedtls_free((void *) handshake->group_list);
4092 }
Brett Warrene0edc842021-08-17 09:53:13 +01004093 handshake->group_list = NULL;
4094#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004095#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004096
Ronald Crone68ab4f2022-10-05 12:46:29 +02004097#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004098#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 if (ssl->handshake->sig_algs_heap_allocated) {
4100 mbedtls_free((void *) handshake->sig_algs);
4101 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004102 handshake->sig_algs = NULL;
4103#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004104#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004105 if (ssl->handshake->certificate_request_context) {
4106 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004107 }
4108#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004109#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004110
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004111#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4113 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004114 handshake->async_in_progress = 0;
4115 }
4116#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4117
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004118#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004119#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004120 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004121#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004122 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004123#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004124#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004125#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004126#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004128#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004129 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004130#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004131#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004133#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004135#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004136#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004137 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004139#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004140
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004141#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004142#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004144 /*
4145 * Opaque keys are not stored in the handshake's data and it's the user
4146 * responsibility to destroy them. Clear ones, instead, are created by
4147 * the TLS library and should be destroyed at the same level
4148 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4150 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004151 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004152 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4153#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004154 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004155#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004156#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004157 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004158 handshake->ecjpake_cache = NULL;
4159 handshake->ecjpake_cache_len = 0;
4160#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004161#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004162
Valerio Setti7aeec542023-07-05 18:57:21 +02004163#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
4164 defined(MBEDTLS_PK_CAN_ECDSA_SOME) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004165 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004166 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004168#endif
4169
Ronald Cron73fe8df2022-10-05 14:31:43 +02004170#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004171#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004173 /* The maintenance of the external PSK key slot is the
4174 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 if (ssl->handshake->psk_opaque_is_internal) {
4176 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004177 ssl->handshake->psk_opaque_is_internal = 0;
4178 }
4179 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4180 }
Neil Armstronge952a302022-05-03 10:22:14 +02004181#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 if (handshake->psk != NULL) {
4183 mbedtls_platform_zeroize(handshake->psk, handshake->psk_len);
4184 mbedtls_free(handshake->psk);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004185 }
Neil Armstronge952a302022-05-03 10:22:14 +02004186#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004187#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004188
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004189#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4190 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004191 /*
4192 * Free only the linked list wrapper, not the keys themselves
4193 * since the belong to the SNI callback
4194 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004196#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004197
Gilles Peskineeccd8882020-03-10 12:19:08 +01004198#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004199 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4200 if (handshake->ecrs_peer_cert != NULL) {
4201 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4202 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004203 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004204#endif
4205
Hanno Becker75173122019-02-06 16:18:31 +00004206#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4207 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004209#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4210
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004211#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4213 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004214#endif /* MBEDTLS_SSL_CLI_C &&
4215 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004216
4217#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004218 mbedtls_ssl_flight_free(handshake->flight);
4219 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004220#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004221
Valerio Settiea59c432023-07-25 11:14:03 +02004222#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004223 if (handshake->xxdh_psa_privkey_is_external == 0) {
4224 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 }
Valerio Settiea59c432023-07-25 11:14:03 +02004226#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004227
Ronald Cron6f135e12021-12-08 16:57:54 +01004228#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 mbedtls_ssl_transform_free(handshake->transform_handshake);
4230 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004231#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004232 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4233 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004234#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004235#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004236
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004237
4238#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4239 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4240 * processes datagrams and the fact that a datagram is allowed to have
4241 * several records in it, it is possible that the I/O buffers are not
4242 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4244 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004245#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004246
Jerry Yuba9c7272021-10-30 11:54:10 +08004247 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 mbedtls_platform_zeroize(handshake,
4249 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004250}
4251
Gilles Peskine449bd832023-01-11 14:50:10 +01004252void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004253{
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004255 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004257
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004258#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004259 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004260#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004261
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004262#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004263#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4264 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004266#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004268#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004269
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004271}
4272
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004273#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004274
4275#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4276#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4277#else
4278#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4279#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4280
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004281#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004282
4283#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4284#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4285#else
4286#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4287#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4288
4289#if defined(MBEDTLS_SSL_ALPN)
4290#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4291#else
4292#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4293#endif /* MBEDTLS_SSL_ALPN */
4294
4295#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4296#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4297#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4298#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4299
4300#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 ((uint32_t) ( \
4302 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4303 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4304 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4305 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4306 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4307 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4308 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4309 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004310
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004311static unsigned char ssl_serialized_context_header[] = {
4312 MBEDTLS_VERSION_MAJOR,
4313 MBEDTLS_VERSION_MINOR,
4314 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4316 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4317 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4318 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4319 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004320};
4321
Paul Bakker5121ce52009-01-03 21:22:43 +00004322/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004323 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004324 *
4325 * The format of the serialized data is:
4326 * (in the presentation language of TLS, RFC 8446 section 3)
4327 *
4328 * // header
4329 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004330 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004331 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004332 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004333 * Note: When updating the format, remember to keep these
4334 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004335 *
4336 * // session sub-structure
4337 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4338 * // transform sub-structure
4339 * uint8 random[64]; // ServerHello.random+ClientHello.random
4340 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4341 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4342 * // fields from ssl_context
4343 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4344 * uint64 in_window_top; // DTLS: last validated record seq_num
4345 * uint64 in_window; // DTLS: bitmask for replay protection
4346 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4347 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4348 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4349 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4350 *
4351 * Note that many fields of the ssl_context or sub-structures are not
4352 * serialized, as they fall in one of the following categories:
4353 *
4354 * 1. forced value (eg in_left must be 0)
4355 * 2. pointer to dynamically-allocated memory (eg session, transform)
4356 * 3. value can be re-derived from other data (eg session keys from MS)
4357 * 4. value was temporary (eg content of input buffer)
4358 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004359 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004360int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4361 unsigned char *buf,
4362 size_t buf_len,
4363 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004364{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004365 unsigned char *p = buf;
4366 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004367 size_t session_len;
4368 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004369
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004370 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004371 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4372 * this function's documentation.
4373 *
4374 * These are due to assumptions/limitations in the implementation. Some of
4375 * them are likely to stay (no handshake in progress) some might go away
4376 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004377 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004378 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4380 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4381 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004382 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (ssl->handshake != NULL) {
4384 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4385 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004386 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004387 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 if (ssl->transform == NULL || ssl->session == NULL) {
4389 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4390 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004391 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004392 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if (mbedtls_ssl_check_pending(ssl) != 0) {
4394 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4395 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004396 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 if (ssl->out_left != 0) {
4398 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4399 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004400 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004401 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4403 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4404 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004405 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004406 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4408 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4409 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004410 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004411 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4413 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4414 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004415 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004416 /* Renegotiation must not be enabled */
4417#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4419 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4420 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004421 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004422#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004423
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004424 /*
4425 * Version and format identifier
4426 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004428
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 if (used <= buf_len) {
4430 memcpy(p, ssl_serialized_context_header,
4431 sizeof(ssl_serialized_context_header));
4432 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004433 }
4434
4435 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004436 * Session (length + data)
4437 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4439 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4440 return ret;
4441 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004442
4443 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 if (used <= buf_len) {
4445 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004446 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 ret = ssl_session_save(ssl->session, 1,
4449 p, session_len, &session_len);
4450 if (ret != 0) {
4451 return ret;
4452 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004453
4454 p += session_len;
4455 }
4456
4457 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004458 * Transform
4459 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 used += sizeof(ssl->transform->randbytes);
4461 if (used <= buf_len) {
4462 memcpy(p, ssl->transform->randbytes,
4463 sizeof(ssl->transform->randbytes));
4464 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004465 }
4466
4467#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4468 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004470 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004472 p += ssl->transform->in_cid_len;
4473
4474 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004476 p += ssl->transform->out_cid_len;
4477 }
4478#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4479
4480 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004481 * Saved fields from top-level ssl_context structure
4482 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004483 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 if (used <= buf_len) {
4485 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004486 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004487 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004488
4489#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4490 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 if (used <= buf_len) {
4492 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004493 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004494
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004496 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004497 }
4498#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4499
4500#if defined(MBEDTLS_SSL_PROTO_DTLS)
4501 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004503 *p++ = ssl->disable_datagram_packing;
4504 }
4505#endif /* MBEDTLS_SSL_PROTO_DTLS */
4506
Jerry Yuae0b2e22021-10-08 15:21:19 +08004507 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (used <= buf_len) {
4509 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004510 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004511 }
4512
4513#if defined(MBEDTLS_SSL_PROTO_DTLS)
4514 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 if (used <= buf_len) {
4516 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004517 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004518 }
4519#endif /* MBEDTLS_SSL_PROTO_DTLS */
4520
4521#if defined(MBEDTLS_SSL_ALPN)
4522 {
4523 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004525 : 0;
4526
4527 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004529 *p++ = alpn_len;
4530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 if (ssl->alpn_chosen != NULL) {
4532 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004533 p += alpn_len;
4534 }
4535 }
4536 }
4537#endif /* MBEDTLS_SSL_ALPN */
4538
4539 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004540 * Done
4541 */
4542 *olen = used;
4543
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 if (used > buf_len) {
4545 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4546 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004547
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004549
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004551}
4552
4553/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004554 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004555 *
4556 * This internal version is wrapped by a public function that cleans up in
4557 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004558 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004559MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004560static int ssl_context_load(mbedtls_ssl_context *ssl,
4561 const unsigned char *buf,
4562 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004563{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004564 const unsigned char *p = buf;
4565 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004566 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004567 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004568#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004569 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004570#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004571
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004572 /*
4573 * The context should have been freshly setup or reset.
4574 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004575 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004576 * renegotiating, or if the user mistakenly loaded a session first.)
4577 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4579 ssl->session != NULL) {
4580 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004581 }
4582
4583 /*
4584 * We can't check that the config matches the initial one, but we can at
4585 * least check it matches the requirements for serializing.
4586 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004588 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4589 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004590#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004591 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004592#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 0) {
4594 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004595 }
4596
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004598
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004599 /*
4600 * Check version identifier
4601 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4603 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004604 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004605
4606 if (memcmp(p, ssl_serialized_context_header,
4607 sizeof(ssl_serialized_context_header)) != 0) {
4608 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4609 }
4610 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004611
4612 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004613 * Session
4614 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 if ((size_t) (end - p) < 4) {
4616 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4617 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004618
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004619 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004620 p += 4;
4621
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004622 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004623 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004624 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004625 ssl->session_in = ssl->session;
4626 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004627 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 if ((size_t) (end - p) < session_len) {
4630 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4631 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004632
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 ret = ssl_session_load(ssl->session, 1, p, session_len);
4634 if (ret != 0) {
4635 mbedtls_ssl_session_free(ssl->session);
4636 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004637 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004638
4639 p += session_len;
4640
4641 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004642 * Transform
4643 */
4644
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004645 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004646 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004647#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004648 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004649 ssl->transform_in = ssl->transform;
4650 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004651 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004652#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004653
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004654#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4656 if (prf_func == NULL) {
4657 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4658 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004659
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004660 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4662 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4663 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004664
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 ret = ssl_tls12_populate_transform(ssl->transform,
4666 ssl->session->ciphersuite,
4667 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004668#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004670#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 prf_func,
4672 p, /* currently pointing to randbytes */
4673 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4674 ssl->conf->endpoint,
4675 ssl);
4676 if (ret != 0) {
4677 return ret;
4678 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004679#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004681
4682#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4683 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 if ((size_t) (end - p) < 1) {
4685 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4686 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004687
4688 ssl->transform->in_cid_len = *p++;
4689
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4691 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4692 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004693
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004695 p += ssl->transform->in_cid_len;
4696
4697 ssl->transform->out_cid_len = *p++;
4698
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4700 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4701 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004702
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004704 p += ssl->transform->out_cid_len;
4705#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4706
4707 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004708 * Saved fields from top-level ssl_context structure
4709 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004710 if ((size_t) (end - p) < 4) {
4711 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4712 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004713
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004714 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004715 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004716
4717#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 if ((size_t) (end - p) < 16) {
4719 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4720 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004721
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004722 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004723 p += 8;
4724
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004725 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004726 p += 8;
4727#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4728
4729#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 if ((size_t) (end - p) < 1) {
4731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4732 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004733
4734 ssl->disable_datagram_packing = *p++;
4735#endif /* MBEDTLS_SSL_PROTO_DTLS */
4736
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4738 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4739 }
4740 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4741 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004742
4743#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 if ((size_t) (end - p) < 2) {
4745 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4746 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004747
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004749 p += 2;
4750#endif /* MBEDTLS_SSL_PROTO_DTLS */
4751
4752#if defined(MBEDTLS_SSL_ALPN)
4753 {
4754 uint8_t alpn_len;
4755 const char **cur;
4756
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 if ((size_t) (end - p) < 1) {
4758 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4759 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004760
4761 alpn_len = *p++;
4762
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004764 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4766 if (strlen(*cur) == alpn_len &&
4767 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004768 ssl->alpn_chosen = *cur;
4769 break;
4770 }
4771 }
4772 }
4773
4774 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4776 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4777 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004778
4779 p += alpn_len;
4780 }
4781#endif /* MBEDTLS_SSL_ALPN */
4782
4783 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004784 * Forced fields from top-level ssl_context structure
4785 *
4786 * Most of them already set to the correct value by mbedtls_ssl_init() and
4787 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4788 */
4789 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004790 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004791
Hanno Becker361b10d2019-08-30 10:42:49 +01004792 /* Adjust pointers for header fields of outgoing records to
4793 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004795
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004796#if defined(MBEDTLS_SSL_PROTO_DTLS)
4797 ssl->in_epoch = 1;
4798#endif
4799
4800 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4801 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004802 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4803 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (ssl->handshake != NULL) {
4805 mbedtls_ssl_handshake_free(ssl);
4806 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004807 ssl->handshake = NULL;
4808 }
4809
4810 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004811 * Done - should have consumed entire buffer
4812 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 if (p != end) {
4814 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4815 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004816
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004818}
4819
4820/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004821 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004822 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004823int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4824 const unsigned char *buf,
4825 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004826{
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004828
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 if (ret != 0) {
4830 mbedtls_ssl_free(context);
4831 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004834}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004835#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004836
4837/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004838 * Free an SSL context
4839 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004840void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004841{
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004843 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004845
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004847
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004849#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4850 size_t out_buf_len = ssl->out_buf_len;
4851#else
4852 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4853#endif
4854
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 mbedtls_platform_zeroize(ssl->out_buf, out_buf_len);
4856 mbedtls_free(ssl->out_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004857 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004858 }
4859
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004861#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4862 size_t in_buf_len = ssl->in_buf_len;
4863#else
4864 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4865#endif
4866
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 mbedtls_platform_zeroize(ssl->in_buf, in_buf_len);
4868 mbedtls_free(ssl->in_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004869 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004870 }
4871
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 if (ssl->transform) {
4873 mbedtls_ssl_transform_free(ssl->transform);
4874 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004875 }
4876
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 if (ssl->handshake) {
4878 mbedtls_ssl_handshake_free(ssl);
4879 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004880
4881#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4883 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004884#endif
4885
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 mbedtls_ssl_session_free(ssl->session_negotiate);
4887 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004888 }
4889
Ronald Cron6f135e12021-12-08 16:57:54 +01004890#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 mbedtls_ssl_transform_free(ssl->transform_application);
4892 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004893#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004894
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 if (ssl->session) {
4896 mbedtls_ssl_session_free(ssl->session);
4897 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004898 }
4899
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004900#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 if (ssl->hostname != NULL) {
4902 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
4903 mbedtls_free(ssl->hostname);
Paul Bakker5121ce52009-01-03 21:22:43 +00004904 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004905#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004906
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004907#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004909#endif
4910
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004912
Paul Bakker86f04f42013-02-14 11:20:09 +01004913 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004915}
4916
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004917/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004918 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004919 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004920void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004921{
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004923}
4924
Gilles Peskineae270bf2021-06-02 00:05:29 +02004925/* The selection should be the same as mbedtls_x509_crt_profile_default in
4926 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004927 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004928 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004929 * about this list.
4930 */
Brett Warrene0edc842021-08-17 09:53:13 +01004931static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004932#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004933 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004934#endif
4935#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004936 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004937#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004938#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004939 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004940#endif
4941#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004942 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004943#endif
4944#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004945 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004946#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004947#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004948 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004949#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004950#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004951 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004952#endif
4953#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004954 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004955#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02004956#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01004957 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
4958 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
4959 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
4960 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
4961 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
4962#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004963 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004964};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004965
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03004966static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004967 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4968 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4969 0
4970};
4971
Ronald Crone68ab4f2022-10-05 12:46:29 +02004972#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004973
Jerry Yu909df7b2022-01-22 11:56:27 +08004974/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004975 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004976 * rules SHOULD be upheld.
4977 * - No duplicate entries.
4978 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004979 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004980 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004981 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004982static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004983
Valerio Setti75fba322023-02-23 17:35:09 +01004984#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004985 defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004986 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4987 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004988#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA256 &&
Jerry Yued5e9f42022-01-26 11:21:34 +08004989 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004990
Valerio Setti75fba322023-02-23 17:35:09 +01004991#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004992 defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08004993 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4994 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004995#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004996 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4997
Valerio Setti75fba322023-02-23 17:35:09 +01004998#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004999 defined(MBEDTLS_MD_CAN_SHA512) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08005000 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
5001 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005002#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yued5e9f42022-01-26 11:21:34 +08005003 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005004
Gilles Peskine449bd832023-01-11 14:50:10 +01005005#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005006 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005007 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005008#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005009 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005010
Gilles Peskine449bd832023-01-11 14:50:10 +01005011#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005012 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005013 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005014#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005015 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005016
Gilles Peskine449bd832023-01-11 14:50:10 +01005017#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005018 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005019 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005020#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005021 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005022
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005023#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005024 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005025#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005026
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005027#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005028 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005029#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005030
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005031#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005032 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005033#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005034
Gabor Mezei15b95a62022-05-09 16:37:58 +02005035 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005036};
5037
5038/* NOTICE: see above */
5039#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5040static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005041#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Setti75fba322023-02-23 17:35:09 +01005042#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005044#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005045#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5046 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5047#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005048#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005050#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005051#endif /* MBEDTLS_MD_CAN_SHA512*/
5052#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Setti75fba322023-02-23 17:35:09 +01005053#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005055#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005056#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5057 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5058#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005059#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005061#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005062#endif /* MBEDTLS_MD_CAN_SHA384*/
5063#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Setti75fba322023-02-23 17:35:09 +01005064#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005066#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005067#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5068 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5069#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005070#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005072#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005073#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005074 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005075};
5076#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5077/* NOTICE: see above */
5078static uint16_t ssl_preset_suiteb_sig_algs[] = {
5079
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005080#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08005081 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5082 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005083#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA256&&
Jerry Yu909df7b2022-01-22 11:56:27 +08005084 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
5085
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005086#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu53037892022-01-25 11:02:06 +08005087 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5088 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005089#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu53037892022-01-25 11:02:06 +08005090 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005091
Gilles Peskine449bd832023-01-11 14:50:10 +01005092#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005093 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005094 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005095#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005096 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005097
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005098#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005099 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005100#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005101
Gabor Mezei15b95a62022-05-09 16:37:58 +02005102 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005103};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005104
Jerry Yu909df7b2022-01-22 11:56:27 +08005105/* NOTICE: see above */
5106#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5107static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005108#if defined(MBEDTLS_MD_CAN_SHA256)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005109#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005111#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005112#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005114#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005115#endif /* MBEDTLS_MD_CAN_SHA256*/
5116#if defined(MBEDTLS_MD_CAN_SHA384)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005117#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005119#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005120#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005122#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005123#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005124 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005125};
Jerry Yu909df7b2022-01-22 11:56:27 +08005126#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5127
Ronald Crone68ab4f2022-10-05 12:46:29 +02005128#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005129
Brett Warrene0edc842021-08-17 09:53:13 +01005130static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01005131#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005132 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005133#endif
5134#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005135 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005136#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005137 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005138};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005139
Ronald Crone68ab4f2022-10-05 12:46:29 +02005140#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005141/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005142 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005143MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005144static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005145{
5146 size_t i, j;
5147 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005148
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5150 for (j = 0; j < i; j++) {
5151 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005152 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 }
5154 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5155 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5156 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005157 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005158 }
5159 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005161}
5162
Ronald Crone68ab4f2022-10-05 12:46:29 +02005163#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005164
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005165/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005166 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005167 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005168int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5169 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005170{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005171#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005172 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005173#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005174
Ronald Crone68ab4f2022-10-05 12:46:29 +02005175#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5177 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5178 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005179 }
5180
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5182 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5183 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005184 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005185
5186#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5188 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5189 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005190 }
5191
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5193 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5194 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005195 }
5196#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005197#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005198
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005199 /* Use the functions here so that they are covered in tests,
5200 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 mbedtls_ssl_conf_endpoint(conf, endpoint);
5202 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005203
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005204 /*
5205 * Things that are common to all presets
5206 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005207#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005209 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5210#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5211 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5212#endif
5213 }
5214#endif
5215
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005216#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5217 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5218#endif
5219
5220#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5221 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5222#endif
5223
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005224#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005225 conf->f_cookie_write = ssl_cookie_write_dummy;
5226 conf->f_cookie_check = ssl_cookie_check_dummy;
5227#endif
5228
5229#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5230 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5231#endif
5232
Janos Follath088ce432017-04-10 12:42:31 +01005233#if defined(MBEDTLS_SSL_SRV_C)
5234 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005235 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005236#endif
5237
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005238#if defined(MBEDTLS_SSL_PROTO_DTLS)
5239 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5240 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5241#endif
5242
5243#if defined(MBEDTLS_SSL_RENEGOTIATION)
5244 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 memset(conf->renego_period, 0x00, 2);
5246 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005247#endif
5248
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005249#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005251 const unsigned char dhm_p[] =
5252 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5253 const unsigned char dhm_g[] =
5254 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005255
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5257 dhm_p, sizeof(dhm_p),
5258 dhm_g, sizeof(dhm_g))) != 0) {
5259 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005260 }
5261 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005262#endif
5263
Ronald Cron6f135e12021-12-08 16:57:54 +01005264#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005265
5266#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 mbedtls_ssl_tls13_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005268#if defined(MBEDTLS_SSL_SRV_C)
5269 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005271#endif
5272#endif /* MBEDTLS_SSL_EARLY_DATA */
5273
Jerry Yud0766ec2022-09-22 10:46:57 +08005274#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005275 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005277#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005278 /*
5279 * Allow all TLS 1.3 key exchange modes by default.
5280 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005281 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005282#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005283
Gilles Peskine449bd832023-01-11 14:50:10 +01005284 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005285#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005286 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005287 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005288#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005290#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005292#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005293 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5294 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005295#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5296 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5297 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5298#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5299 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5300 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5301#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005303#endif
5304 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005305
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005306 /*
5307 * Preset-specific defaults
5308 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005310 /*
5311 * NSA Suite B
5312 */
5313 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005314
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005315 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005316
5317#if defined(MBEDTLS_X509_CRT_PARSE_C)
5318 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005319#endif
5320
Ronald Crone68ab4f2022-10-05 12:46:29 +02005321#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005322#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005324 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005326#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005328#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005329
Valerio Setti6f0441d2023-07-03 12:11:36 +02005330#if defined(MBEDTLS_PK_HAVE_ECC_KEYS) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005331 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005332#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005333 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005334 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005335
5336 /*
5337 * Default
5338 */
5339 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005340
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005341 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005342
5343#if defined(MBEDTLS_X509_CRT_PARSE_C)
5344 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5345#endif
5346
Ronald Crone68ab4f2022-10-05 12:46:29 +02005347#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005348#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005350 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005352#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005354#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005355
Valerio Setti6f0441d2023-07-03 12:11:36 +02005356#if defined(MBEDTLS_PK_HAVE_ECC_KEYS) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005357 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005358#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005359 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005360
5361#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5362 conf->dhm_min_bitlen = 1024;
5363#endif
5364 }
5365
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005367}
5368
5369/*
5370 * Free mbedtls_ssl_config
5371 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005372void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005373{
5374#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 mbedtls_mpi_free(&conf->dhm_P);
5376 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005377#endif
5378
Ronald Cron73fe8df2022-10-05 14:31:43 +02005379#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005380#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005382 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5383 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005384#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 if (conf->psk != NULL) {
5386 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
5387 mbedtls_free(conf->psk);
Azim Khan27e8a122018-03-21 14:24:11 +00005388 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005389 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005390 }
5391
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 if (conf->psk_identity != NULL) {
5393 mbedtls_platform_zeroize(conf->psk_identity, conf->psk_identity_len);
5394 mbedtls_free(conf->psk_identity);
Azim Khan27e8a122018-03-21 14:24:11 +00005395 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005396 conf->psk_identity_len = 0;
5397 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005398#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005399
5400#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005402#endif
5403
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005405}
5406
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005407#if defined(MBEDTLS_PK_C) && \
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005408 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_CAN_ECDSA_SOME))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005409/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005410 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005411 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005412unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005413{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005414#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5416 return MBEDTLS_SSL_SIG_RSA;
5417 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005418#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005419#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5421 return MBEDTLS_SSL_SIG_ECDSA;
5422 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005423#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005425}
5426
Gilles Peskine449bd832023-01-11 14:50:10 +01005427unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005428{
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005430 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005432 case MBEDTLS_PK_ECDSA:
5433 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005435 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005437 }
5438}
5439
Gilles Peskine449bd832023-01-11 14:50:10 +01005440mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005441{
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005443#if defined(MBEDTLS_RSA_C)
5444 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005446#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005447#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005448 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005450#endif
5451 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005453 }
5454}
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005455#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_PK_CAN_ECDSA_SOME ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005456
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005457/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005458 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005459 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005460mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005461{
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005463#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005464 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005466#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005467#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005468 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005470#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005471#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005472 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005474#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005475#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005476 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005478#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005479#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005480 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005482#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005483#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005484 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005486#endif
5487 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005489 }
5490}
5491
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005492/*
5493 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5494 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005495unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005496{
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005498#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005499 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005501#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005502#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005503 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005505#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005506#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005507 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005509#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005510#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005511 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005513#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005514#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005515 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005517#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005518#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005519 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005521#endif
5522 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005524 }
5525}
5526
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005527/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005528 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005529 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005530 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005531int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005532{
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005534
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 if (group_list == NULL) {
5536 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005537 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005538
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 for (; *group_list != 0; group_list++) {
5540 if (*group_list == tls_id) {
5541 return 0;
5542 }
5543 }
5544
5545 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005546}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005547
Valerio Setti49e69072023-06-27 17:27:51 +02005548#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005549/*
5550 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5551 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005552int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005553{
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005555
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005557 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005559
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005561}
Valerio Setti49e69072023-06-27 17:27:51 +02005562#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005563
Valerio Setti18c9fed2022-12-30 17:44:24 +01005564static const struct {
5565 uint16_t tls_id;
5566 mbedtls_ecp_group_id ecp_group_id;
5567 psa_ecc_family_t psa_family;
5568 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005569} tls_id_match_table[] =
5570{
5571#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005572 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005573#endif
5574#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005575 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005576#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005577#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005578 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005579#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005580#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005581 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005582#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005583#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005584 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005585#endif
5586#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005587 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005588#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005589#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005590 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005591#endif
5592#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005593 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005594#endif
5595#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005596 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005597#endif
5598#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005599 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005600#endif
5601#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005602 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005603#endif
5604#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005605 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005606#endif
5607#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005608 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005609#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005610 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005611};
5612
Gilles Peskine449bd832023-01-11 14:50:10 +01005613int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005614 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005616{
Gilles Peskine449bd832023-01-11 14:50:10 +01005617 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5618 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005619 if (type != NULL) {
5620 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 }
5622 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005623 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005625 return PSA_SUCCESS;
5626 }
5627 }
5628
5629 return PSA_ERROR_NOT_SUPPORTED;
5630}
5631
Gilles Peskine449bd832023-01-11 14:50:10 +01005632mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005633{
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5635 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005636 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005638 }
5639
5640 return MBEDTLS_ECP_DP_NONE;
5641}
5642
Gilles Peskine449bd832023-01-11 14:50:10 +01005643uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005644{
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5646 i++) {
5647 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005648 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005650 }
5651
5652 return 0;
5653}
5654
Valerio Setti67419f02023-01-04 16:12:42 +01005655#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005656static const struct {
5657 uint16_t tls_id;
5658 const char *name;
5659} tls_id_curve_name_table[] =
5660{
Valerio Setti54e23792023-07-07 10:49:27 +02005661 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5662 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5663 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5664 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5665 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5666 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5667 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5668 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5669 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5670 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5671 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5672 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5673 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005674 { 0, NULL },
5675};
5676
Gilles Peskine449bd832023-01-11 14:50:10 +01005677const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005678{
Valerio Settiacd32c02023-06-29 18:06:29 +02005679 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5680 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5681 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005682 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005683 }
5684
5685 return NULL;
5686}
Valerio Setti67419f02023-01-04 16:12:42 +01005687#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005688
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005689#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005690int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5691 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5692 int cert_endpoint,
5693 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005694{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005695 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005696 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005697 const char *ext_oid;
5698 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005699
Gilles Peskine449bd832023-01-11 14:50:10 +01005700 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005701 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005703 case MBEDTLS_KEY_EXCHANGE_RSA:
5704 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005705 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005706 break;
5707
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005708 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5709 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5710 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5711 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005712 break;
5713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005714 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5715 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005716 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005717 break;
5718
5719 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005720 case MBEDTLS_KEY_EXCHANGE_NONE:
5721 case MBEDTLS_KEY_EXCHANGE_PSK:
5722 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5723 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005724 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005725 usage = 0;
5726 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005728 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5729 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005730 }
5731
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005733 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005734 ret = -1;
5735 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005736
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005738 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5740 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005741 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005743 }
5744
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005746 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005747 ret = -1;
5748 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005749
Gilles Peskine449bd832023-01-11 14:50:10 +01005750 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005751}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005752#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005753
Jerry Yu148165c2021-09-24 23:20:59 +08005754#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005755int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5756 const mbedtls_md_type_t md,
5757 unsigned char *dst,
5758 size_t dst_len,
5759 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005760{
Ronald Cronf6893e12022-01-07 22:09:01 +01005761 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5762 psa_hash_operation_t *hash_operation_to_clone;
5763 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5764
Jerry Yu148165c2021-09-24 23:20:59 +08005765 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005766
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005768#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 case MBEDTLS_MD_SHA384:
5770 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5771 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005772#endif
5773
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005774#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005775 case MBEDTLS_MD_SHA256:
5776 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5777 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005778#endif
5779
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 default:
5781 goto exit;
5782 }
5783
5784 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5785 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005786 goto exit;
5787 }
5788
Gilles Peskine449bd832023-01-11 14:50:10 +01005789 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5790 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005791 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005793
5794exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005795#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5796 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005797 (void) ssl;
5798#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005799 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005800}
5801#else /* MBEDTLS_USE_PSA_CRYPTO */
5802
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005803#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005804MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005805static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5806 unsigned char *dst,
5807 size_t dst_len,
5808 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005809{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005810 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005811 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005812
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 if (dst_len < 48) {
5814 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5815 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005816
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005817 mbedtls_md_init(&sha384);
5818 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005819 if (ret != 0) {
5820 goto exit;
5821 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005822 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005823 if (ret != 0) {
5824 goto exit;
5825 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005826
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005827 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005828 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005829 goto exit;
5830 }
5831
5832 *olen = 48;
5833
5834exit:
5835
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005836 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005838}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005839#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005840
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005841#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005842MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005843static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5844 unsigned char *dst,
5845 size_t dst_len,
5846 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005847{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005848 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005849 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005850
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 if (dst_len < 32) {
5852 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5853 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005854
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005855 mbedtls_md_init(&sha256);
5856 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5857 if (ret != 0) {
5858 goto exit;
5859 }
5860 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5861 if (ret != 0) {
5862 goto exit;
5863 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005864
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005865 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5866 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005867 goto exit;
5868 }
5869
5870 *olen = 32;
5871
5872exit:
5873
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005874 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005875 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005876}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005877#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005878
Gilles Peskine449bd832023-01-11 14:50:10 +01005879int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5880 const mbedtls_md_type_t md,
5881 unsigned char *dst,
5882 size_t dst_len,
5883 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005884{
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005886
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005887#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 case MBEDTLS_MD_SHA384:
5889 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005890#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005891
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005892#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 case MBEDTLS_MD_SHA256:
5894 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005895#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005896
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005898#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5899 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 (void) ssl;
5901 (void) dst;
5902 (void) dst_len;
5903 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005904#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005905 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005906 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005907 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005908}
XiaokangQian647719a2021-12-07 09:16:29 +00005909
Jerry Yu148165c2021-09-24 23:20:59 +08005910#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005911
Ronald Crone68ab4f2022-10-05 12:46:29 +02005912#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005913/* mbedtls_ssl_parse_sig_alg_ext()
5914 *
5915 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5916 * value (TLS 1.3 RFC8446):
5917 * enum {
5918 * ....
5919 * ecdsa_secp256r1_sha256( 0x0403 ),
5920 * ecdsa_secp384r1_sha384( 0x0503 ),
5921 * ecdsa_secp521r1_sha512( 0x0603 ),
5922 * ....
5923 * } SignatureScheme;
5924 *
5925 * struct {
5926 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5927 * } SignatureSchemeList;
5928 *
5929 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5930 * value (TLS 1.2 RFC5246):
5931 * enum {
5932 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5933 * sha512(6), (255)
5934 * } HashAlgorithm;
5935 *
5936 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5937 * SignatureAlgorithm;
5938 *
5939 * struct {
5940 * HashAlgorithm hash;
5941 * SignatureAlgorithm signature;
5942 * } SignatureAndHashAlgorithm;
5943 *
5944 * SignatureAndHashAlgorithm
5945 * supported_signature_algorithms<2..2^16-2>;
5946 *
5947 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5948 * generalization of the TLS 1.2 signature algorithm extension.
5949 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5950 * `SignatureScheme` field of TLS 1.3
5951 *
5952 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005953int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5954 const unsigned char *buf,
5955 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005956{
5957 const unsigned char *p = buf;
5958 size_t supported_sig_algs_len = 0;
5959 const unsigned char *supported_sig_algs_end;
5960 uint16_t sig_alg;
5961 uint32_t common_idx = 0;
5962
Gilles Peskine449bd832023-01-11 14:50:10 +01005963 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5964 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005965 p += 2;
5966
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 memset(ssl->handshake->received_sig_algs, 0,
5968 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005969
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005971 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 while (p < supported_sig_algs_end) {
5973 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5974 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005975 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5977 sig_alg,
5978 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005979#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5981 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5982 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005983 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005984 }
5985#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005986
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5988 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005989
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005991 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5992 common_idx += 1;
5993 }
5994 }
5995 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 if (p != end) {
5997 MBEDTLS_SSL_DEBUG_MSG(1,
5998 ("Signature algorithms extension length misaligned"));
5999 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6000 MBEDTLS_ERR_SSL_DECODE_ERROR);
6001 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006002 }
6003
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 if (common_idx == 0) {
6005 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6006 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6007 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6008 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006009 }
6010
Gabor Mezei15b95a62022-05-09 16:37:58 +02006011 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006013}
6014
Ronald Crone68ab4f2022-10-05 12:46:29 +02006015#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006016
Jerry Yudc7bd172022-02-17 13:44:15 +08006017#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6018
6019#if defined(MBEDTLS_USE_PSA_CRYPTO)
6020
Gilles Peskine449bd832023-01-11 14:50:10 +01006021static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6022 mbedtls_svc_key_id_t key,
6023 psa_algorithm_t alg,
6024 const unsigned char *raw_psk, size_t raw_psk_length,
6025 const unsigned char *seed, size_t seed_length,
6026 const unsigned char *label, size_t label_length,
6027 const unsigned char *other_secret,
6028 size_t other_secret_length,
6029 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006030{
6031 psa_status_t status;
6032
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 status = psa_key_derivation_setup(derivation, alg);
6034 if (status != PSA_SUCCESS) {
6035 return status;
6036 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006037
Gilles Peskine449bd832023-01-11 14:50:10 +01006038 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6039 status = psa_key_derivation_input_bytes(derivation,
6040 PSA_KEY_DERIVATION_INPUT_SEED,
6041 seed, seed_length);
6042 if (status != PSA_SUCCESS) {
6043 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006044 }
6045
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 if (other_secret != NULL) {
6047 status = psa_key_derivation_input_bytes(derivation,
6048 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6049 other_secret, other_secret_length);
6050 if (status != PSA_SUCCESS) {
6051 return status;
6052 }
6053 }
6054
6055 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006056 status = psa_key_derivation_input_bytes(
6057 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 raw_psk, raw_psk_length);
6059 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006060 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006062 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 if (status != PSA_SUCCESS) {
6064 return status;
6065 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006066
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 status = psa_key_derivation_input_bytes(derivation,
6068 PSA_KEY_DERIVATION_INPUT_LABEL,
6069 label, label_length);
6070 if (status != PSA_SUCCESS) {
6071 return status;
6072 }
6073 } else {
6074 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006075 }
6076
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 status = psa_key_derivation_set_capacity(derivation, capacity);
6078 if (status != PSA_SUCCESS) {
6079 return status;
6080 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006081
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006083}
6084
Andrzej Kurek57d10632022-10-24 10:32:01 -04006085#if defined(PSA_WANT_ALG_SHA_384) || \
6086 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006087MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006088static int tls_prf_generic(mbedtls_md_type_t md_type,
6089 const unsigned char *secret, size_t slen,
6090 const char *label,
6091 const unsigned char *random, size_t rlen,
6092 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006093{
6094 psa_status_t status;
6095 psa_algorithm_t alg;
6096 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6097 psa_key_derivation_operation_t derivation =
6098 PSA_KEY_DERIVATION_OPERATION_INIT;
6099
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006101 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006103 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006104 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006105
6106 /* Normally a "secret" should be long enough to be impossible to
6107 * find by brute force, and in particular should not be empty. But
6108 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6109 * and for this use case it makes sense to have a 0-length "secret".
6110 * Since the key API doesn't allow importing a key of length 0,
6111 * keep master_key=0, which setup_psa_key_derivation() understands
6112 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006114 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6116 psa_set_key_algorithm(&key_attributes, alg);
6117 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006118
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6120 if (status != PSA_SUCCESS) {
6121 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6122 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006123 }
6124
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 status = setup_psa_key_derivation(&derivation,
6126 master_key, alg,
6127 NULL, 0,
6128 random, rlen,
6129 (unsigned char const *) label,
6130 (size_t) strlen(label),
6131 NULL, 0,
6132 dlen);
6133 if (status != PSA_SUCCESS) {
6134 psa_key_derivation_abort(&derivation);
6135 psa_destroy_key(master_key);
6136 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006137 }
6138
Gilles Peskine449bd832023-01-11 14:50:10 +01006139 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6140 if (status != PSA_SUCCESS) {
6141 psa_key_derivation_abort(&derivation);
6142 psa_destroy_key(master_key);
6143 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006144 }
6145
Gilles Peskine449bd832023-01-11 14:50:10 +01006146 status = psa_key_derivation_abort(&derivation);
6147 if (status != PSA_SUCCESS) {
6148 psa_destroy_key(master_key);
6149 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006150 }
6151
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 if (!mbedtls_svc_key_id_is_null(master_key)) {
6153 status = psa_destroy_key(master_key);
6154 }
6155 if (status != PSA_SUCCESS) {
6156 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6157 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006158
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006160}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006161#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006162#else /* MBEDTLS_USE_PSA_CRYPTO */
6163
Andrzej Kurek57d10632022-10-24 10:32:01 -04006164#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006165 (defined(MBEDTLS_MD_CAN_SHA256) || \
6166 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006167MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006168static int tls_prf_generic(mbedtls_md_type_t md_type,
6169 const unsigned char *secret, size_t slen,
6170 const char *label,
6171 const unsigned char *random, size_t rlen,
6172 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006173{
6174 size_t nb;
6175 size_t i, j, k, md_len;
6176 unsigned char *tmp;
6177 size_t tmp_len = 0;
6178 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6179 const mbedtls_md_info_t *md_info;
6180 mbedtls_md_context_t md_ctx;
6181 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6182
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006184
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6186 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6187 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006188
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006190
Gilles Peskine449bd832023-01-11 14:50:10 +01006191 tmp_len = md_len + strlen(label) + rlen;
6192 tmp = mbedtls_calloc(1, tmp_len);
6193 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006194 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6195 goto exit;
6196 }
6197
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 nb = strlen(label);
6199 memcpy(tmp + md_len, label, nb);
6200 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006201 nb += rlen;
6202
6203 /*
6204 * Compute P_<hash>(secret, label + random)[0..dlen]
6205 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006207 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006209
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6211 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006212 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 }
6214 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6215 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006216 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 }
6218 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6219 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006220 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006221 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006222
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 for (i = 0; i < dlen; i += md_len) {
6224 ret = mbedtls_md_hmac_reset(&md_ctx);
6225 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006226 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 }
6228 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6229 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006230 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 }
6232 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6233 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006234 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006236
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 ret = mbedtls_md_hmac_reset(&md_ctx);
6238 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006239 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 }
6241 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6242 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006243 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 }
6245 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6246 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006247 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006249
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006251
Gilles Peskine449bd832023-01-11 14:50:10 +01006252 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006253 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006255 }
6256
6257exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006259
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 if (tmp != NULL) {
6261 mbedtls_platform_zeroize(tmp, tmp_len);
6262 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006263
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006265
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006267
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006269}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006270#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006271#endif /* MBEDTLS_USE_PSA_CRYPTO */
6272
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006273#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006274MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006275static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6276 const char *label,
6277 const unsigned char *random, size_t rlen,
6278 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006279{
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6281 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006282}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006283#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006284
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006285#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006286MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006287static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6288 const char *label,
6289 const unsigned char *random, size_t rlen,
6290 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006291{
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6293 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006294}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006295#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006296
Jerry Yuf009d862022-02-17 14:01:37 +08006297/*
6298 * Set appropriate PRF function and other SSL / TLS1.2 functions
6299 *
6300 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006301 * - hash associated with the ciphersuite (only used by TLS 1.2)
6302 *
6303 * Outputs:
6304 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6305 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006306MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006307static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6308 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006309{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006310#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006312 handshake->tls_prf = tls_prf_sha384;
6313 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6314 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006315 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006316#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006317#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006318 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006319 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006320 handshake->tls_prf = tls_prf_sha256;
6321 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6322 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6323 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006324#else
Jerry Yuf009d862022-02-17 14:01:37 +08006325 {
Jerry Yuf009d862022-02-17 14:01:37 +08006326 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006327 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006329 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006330#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006331
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006333}
Jerry Yud6ab2352022-02-17 14:03:43 +08006334
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006335/*
6336 * Compute master secret if needed
6337 *
6338 * Parameters:
6339 * [in/out] handshake
6340 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6341 * (PSA-PSK) ciphersuite_info, psk_opaque
6342 * [out] premaster (cleared)
6343 * [out] master
6344 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6345 * debug: conf->f_dbg, conf->p_dbg
6346 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006347 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006348 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006349MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006350static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6351 unsigned char *master,
6352 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006353{
6354 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6355
6356 /* cf. RFC 5246, Section 8.1:
6357 * "The master secret is always exactly 48 bytes in length." */
6358 size_t const master_secret_len = 48;
6359
6360#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6361 unsigned char session_hash[48];
6362#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6363
6364 /* The label for the KDF used for key expansion.
6365 * This is either "master secret" or "extended master secret"
6366 * depending on whether the Extended Master Secret extension
6367 * is used. */
6368 char const *lbl = "master secret";
6369
Przemek Stekielae4ed302022-04-05 17:15:55 +02006370 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006371 * - If the Extended Master Secret extension is not used,
6372 * this is ClientHello.Random + ServerHello.Random
6373 * (see Sect. 8.1 in RFC 5246).
6374 * - If the Extended Master Secret extension is used,
6375 * this is the transcript of the handshake so far.
6376 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006377 unsigned char const *seed = handshake->randbytes;
6378 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006379
6380#if !defined(MBEDTLS_DEBUG_C) && \
6381 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6382 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006384 ssl = NULL; /* make sure we don't use it except for those cases */
6385 (void) ssl;
6386#endif
6387
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 if (handshake->resume != 0) {
6389 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6390 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006391 }
6392
6393#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006395 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006396 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006397 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6398 if (ret != 0) {
6399 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6400 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006401
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6403 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006404 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006405#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006406
Przemek Stekiel99114f32022-04-22 11:20:09 +02006407#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006408 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006410 /* Perform PSK-to-MS expansion in a single step. */
6411 psa_status_t status;
6412 psa_algorithm_t alg;
6413 mbedtls_svc_key_id_t psk;
6414 psa_key_derivation_operation_t derivation =
6415 PSA_KEY_DERIVATION_OPERATION_INIT;
6416 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6417
Gilles Peskine449bd832023-01-11 14:50:10 +01006418 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006419
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006421
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006423 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006425 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006427
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006428 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006429 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006430
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006432 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006433 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006434 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006435 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006436 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006437 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006438 other_secret_len = 48;
6439 other_secret = handshake->premaster + 2;
6440 break;
6441 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006442 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006443 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6444 other_secret = handshake->premaster + 2;
6445 break;
6446 default:
6447 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006448 }
6449
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 status = setup_psa_key_derivation(&derivation, psk, alg,
6451 ssl->conf->psk, ssl->conf->psk_len,
6452 seed, seed_len,
6453 (unsigned char const *) lbl,
6454 (size_t) strlen(lbl),
6455 other_secret, other_secret_len,
6456 master_secret_len);
6457 if (status != PSA_SUCCESS) {
6458 psa_key_derivation_abort(&derivation);
6459 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006460 }
6461
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 status = psa_key_derivation_output_bytes(&derivation,
6463 master,
6464 master_secret_len);
6465 if (status != PSA_SUCCESS) {
6466 psa_key_derivation_abort(&derivation);
6467 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006468 }
6469
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 status = psa_key_derivation_abort(&derivation);
6471 if (status != PSA_SUCCESS) {
6472 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6473 }
6474 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006475#endif
6476 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006477#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6479 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006480 psa_status_t status;
6481 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6482 psa_key_derivation_operation_t derivation =
6483 PSA_KEY_DERIVATION_OPERATION_INIT;
6484
Gilles Peskine449bd832023-01-11 14:50:10 +01006485 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006486
6487 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6488
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 status = psa_key_derivation_setup(&derivation, alg);
6490 if (status != PSA_SUCCESS) {
6491 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006492 }
6493
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 status = psa_key_derivation_set_capacity(&derivation,
6495 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6496 if (status != PSA_SUCCESS) {
6497 psa_key_derivation_abort(&derivation);
6498 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006499 }
6500
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6502 &derivation);
6503 if (status != PSA_SUCCESS) {
6504 psa_key_derivation_abort(&derivation);
6505 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006506 }
6507
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 status = psa_key_derivation_output_bytes(&derivation,
6509 handshake->premaster,
6510 handshake->pmslen);
6511 if (status != PSA_SUCCESS) {
6512 psa_key_derivation_abort(&derivation);
6513 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6514 }
6515
6516 status = psa_key_derivation_abort(&derivation);
6517 if (status != PSA_SUCCESS) {
6518 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006519 }
6520 }
6521#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6523 lbl, seed, seed_len,
6524 master,
6525 master_secret_len);
6526 if (ret != 0) {
6527 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6528 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006529 }
6530
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6532 handshake->premaster,
6533 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006534
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 mbedtls_platform_zeroize(handshake->premaster,
6536 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006537 }
6538
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006540}
6541
Gilles Peskine449bd832023-01-11 14:50:10 +01006542int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006543{
6544 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6545 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6546 ssl->handshake->ciphersuite_info;
6547
Gilles Peskine449bd832023-01-11 14:50:10 +01006548 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006549
6550 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006552 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 if (ret != 0) {
6554 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6555 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006556 }
6557
6558 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 ret = ssl_compute_master(ssl->handshake,
6560 ssl->session_negotiate->master,
6561 ssl);
6562 if (ret != 0) {
6563 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6564 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006565 }
6566
6567 /* Swap the client and server random values:
6568 * - MS derivation wanted client+server (RFC 5246 8.1)
6569 * - key derivation wants server+client (RFC 5246 6.3) */
6570 {
6571 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 memcpy(tmp, ssl->handshake->randbytes, 64);
6573 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6574 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6575 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006576 }
6577
6578 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6580 ssl->session_negotiate->ciphersuite,
6581 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006582#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006583 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006584#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 ssl->handshake->tls_prf,
6586 ssl->handshake->randbytes,
6587 ssl->tls_version,
6588 ssl->conf->endpoint,
6589 ssl);
6590 if (ret != 0) {
6591 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6592 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006593 }
6594
6595 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006596 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6597 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006598
Gilles Peskine449bd832023-01-11 14:50:10 +01006599 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006600
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006602}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006603
Gilles Peskine449bd832023-01-11 14:50:10 +01006604int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006605{
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006607#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006608 case MBEDTLS_SSL_HASH_SHA384:
6609 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6610 break;
6611#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006612#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006613 case MBEDTLS_SSL_HASH_SHA256:
6614 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6615 break;
6616#endif
6617 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006618 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006619 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006620#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6621 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006622 (void) ssl;
6623#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006625}
6626
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006627#if defined(MBEDTLS_USE_PSA_CRYPTO)
6628static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6629 const psa_hash_operation_t *hs_op,
6630 size_t buffer_size,
6631 unsigned char *hash,
6632 size_t *hlen)
6633{
6634 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006635 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006636
6637#if !defined(MBEDTLS_DEBUG_C)
6638 (void) ssl;
6639#endif
6640 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006641 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006642 if (status != PSA_SUCCESS) {
6643 goto exit;
6644 }
6645
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006646 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006647 if (status != PSA_SUCCESS) {
6648 goto exit;
6649 }
6650
6651 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6652 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6653
6654exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006655 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006656 return mbedtls_md_error_from_psa(status);
6657}
6658#else
6659static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6660 const mbedtls_md_context_t *hs_ctx,
6661 unsigned char *hash,
6662 size_t *hlen)
6663{
6664 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006665 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006666
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006667 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006668
6669#if !defined(MBEDTLS_DEBUG_C)
6670 (void) ssl;
6671#endif
6672 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6673
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006674 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006675 if (ret != 0) {
6676 goto exit;
6677 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006678 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006679 if (ret != 0) {
6680 goto exit;
6681 }
6682
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006683 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006684 if (ret != 0) {
6685 goto exit;
6686 }
6687
6688 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6689
6690 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6691 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6692
6693exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006694 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006695 return ret;
6696}
6697#endif /* MBEDTLS_USE_PSA_CRYPTO */
6698
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006699#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006700int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6701 unsigned char *hash,
6702 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006703{
6704#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006705 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6706 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006707#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006708 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6709 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006710#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006711}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006712#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006713
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006714#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006715int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6716 unsigned char *hash,
6717 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006718{
6719#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006720 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6721 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006722#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006723 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6724 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006725#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006726}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006727#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006728
Neil Armstrong80f6f322022-05-03 17:56:38 +02006729#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6730 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006731int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006732{
6733 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006734 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006735 const unsigned char *psk = NULL;
6736 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006737 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006738
Gilles Peskine449bd832023-01-11 14:50:10 +01006739 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006740 /*
6741 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006742 * checked before calling this function.
6743 *
6744 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006745 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006746 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006747 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6748 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6749 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006750 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006751 }
6752
6753 /*
6754 * PMS = struct {
6755 * opaque other_secret<0..2^16-1>;
6756 * opaque psk<0..2^16-1>;
6757 * };
6758 * with "other_secret" depending on the particular key exchange
6759 */
6760#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006761 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6762 if (end - p < 2) {
6763 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6764 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006765
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006767 p += 2;
6768
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 if (end < p || (size_t) (end - p) < psk_len) {
6770 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6771 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006772
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006774 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006776#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6777#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006779 /*
6780 * other_secret already set by the ClientKeyExchange message,
6781 * and is 48 bytes long
6782 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 if (end - p < 2) {
6784 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6785 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006786
6787 *p++ = 0;
6788 *p++ = 48;
6789 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006791#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6792#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006794 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6795 size_t len;
6796
6797 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006798 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6799 p + 2, end - (p + 2), &len,
6800 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6801 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6802 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006803 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006805 p += 2 + len;
6806
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6808 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006809#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006810#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006812 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6813 size_t zlen;
6814
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6816 p + 2, end - (p + 2),
6817 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6818 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6819 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006820 }
6821
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006823 p += 2 + zlen;
6824
Gilles Peskine449bd832023-01-11 14:50:10 +01006825 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6826 MBEDTLS_DEBUG_ECDH_Z);
6827 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006828#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006829 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6831 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006832 }
6833
6834 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 if (end - p < 2) {
6836 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6837 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006838
Gilles Peskine449bd832023-01-11 14:50:10 +01006839 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006840 p += 2;
6841
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 if (end < p || (size_t) (end - p) < psk_len) {
6843 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6844 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006845
Gilles Peskine449bd832023-01-11 14:50:10 +01006846 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006847 p += psk_len;
6848
6849 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6850
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006852}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006853#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006854
6855#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006856MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006857static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006858
6859#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006860int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006861{
6862 /* If renegotiation is not enforced, retransmit until we would reach max
6863 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006865 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6866 unsigned char doublings = 1;
6867
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006869 ++doublings;
6870 ratio >>= 1;
6871 }
6872
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 if (++ssl->renego_records_seen > doublings) {
6874 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6875 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006876 }
6877 }
6878
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006880}
6881#endif
6882#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006883
Jerry Yud9526692022-02-17 14:23:47 +08006884/*
6885 * Handshake functions
6886 */
6887#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6888/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006889int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006890{
6891 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6892 ssl->handshake->ciphersuite_info;
6893
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6897 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006898 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006900 }
6901
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6903 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006904}
6905
Gilles Peskine449bd832023-01-11 14:50:10 +01006906int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006907{
6908 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6909 ssl->handshake->ciphersuite_info;
6910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006912
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6914 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006915 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006917 }
6918
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6920 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006921}
6922
6923#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6924/* Some certificate support -> implement write and parse */
6925
Gilles Peskine449bd832023-01-11 14:50:10 +01006926int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006927{
6928 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6929 size_t i, n;
6930 const mbedtls_x509_crt *crt;
6931 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6932 ssl->handshake->ciphersuite_info;
6933
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006935
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6937 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006938 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006939 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006940 }
6941
6942#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006943 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6944 if (ssl->handshake->client_auth == 0) {
6945 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006946 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006947 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006948 }
6949 }
6950#endif /* MBEDTLS_SSL_CLI_C */
6951#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006952 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6953 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006954 /* Should never happen because we shouldn't have picked the
6955 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006957 }
6958 }
6959#endif
6960
Gilles Peskine449bd832023-01-11 14:50:10 +01006961 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006962
6963 /*
6964 * 0 . 0 handshake type
6965 * 1 . 3 handshake length
6966 * 4 . 6 length of all certs
6967 * 7 . 9 length of cert. 1
6968 * 10 . n-1 peer certificate
6969 * n . n+2 length of cert. 2
6970 * n+3 . ... upper level cert, etc.
6971 */
6972 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006974
Gilles Peskine449bd832023-01-11 14:50:10 +01006975 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006976 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6978 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6979 " > %" MBEDTLS_PRINTF_SIZET,
6980 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6981 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006982 }
6983
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6985 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6986 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006987
Gilles Peskine449bd832023-01-11 14:50:10 +01006988 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006989 i += n; crt = crt->next;
6990 }
6991
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6993 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6994 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006995
6996 ssl->out_msglen = i;
6997 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6998 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6999
7000 ssl->state++;
7001
Gilles Peskine449bd832023-01-11 14:50:10 +01007002 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7003 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7004 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007005 }
7006
Gilles Peskine449bd832023-01-11 14:50:10 +01007007 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007008
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007010}
7011
7012#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7013
7014#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007015MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007016static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7017 unsigned char *crt_buf,
7018 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007019{
7020 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7021
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 if (peer_crt == NULL) {
7023 return -1;
7024 }
Jerry Yud9526692022-02-17 14:23:47 +08007025
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 if (peer_crt->raw.len != crt_buf_len) {
7027 return -1;
7028 }
Jerry Yud9526692022-02-17 14:23:47 +08007029
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007031}
7032#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007033MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007034static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7035 unsigned char *crt_buf,
7036 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007037{
7038 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7039 unsigned char const * const peer_cert_digest =
7040 ssl->session->peer_cert_digest;
7041 mbedtls_md_type_t const peer_cert_digest_type =
7042 ssl->session->peer_cert_digest_type;
7043 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007044 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007045 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7046 size_t digest_len;
7047
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 if (peer_cert_digest == NULL || digest_info == NULL) {
7049 return -1;
7050 }
Jerry Yud9526692022-02-17 14:23:47 +08007051
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 digest_len = mbedtls_md_get_size(digest_info);
7053 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7054 return -1;
7055 }
Jerry Yud9526692022-02-17 14:23:47 +08007056
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7058 if (ret != 0) {
7059 return -1;
7060 }
Jerry Yud9526692022-02-17 14:23:47 +08007061
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007063}
7064#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7065#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7066
7067/*
7068 * Once the certificate message is read, parse it into a cert chain and
7069 * perform basic checks, but leave actual verification to the caller
7070 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007071MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007072static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7073 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007074{
7075 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7076#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007078#endif
7079 size_t i, n;
7080 uint8_t alert;
7081
Gilles Peskine449bd832023-01-11 14:50:10 +01007082 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7083 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7084 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7085 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7086 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007087 }
7088
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7090 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7091 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7092 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007093 }
7094
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7096 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7097 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7098 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7099 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007100 }
7101
Gilles Peskine449bd832023-01-11 14:50:10 +01007102 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007103
7104 /*
7105 * Same message structure as in mbedtls_ssl_write_certificate()
7106 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007108
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 if (ssl->in_msg[i] != 0 ||
7110 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7111 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7112 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7113 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7114 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007115 }
7116
7117 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7118 i += 3;
7119
7120 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007121 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007122 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007123 if (i + 3 > ssl->in_hslen) {
7124 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7125 mbedtls_ssl_send_alert_message(ssl,
7126 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7127 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7128 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007129 }
7130 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7131 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 if (ssl->in_msg[i] != 0) {
7133 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7134 mbedtls_ssl_send_alert_message(ssl,
7135 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7136 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7137 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007138 }
7139
7140 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007142 | (unsigned int) ssl->in_msg[i + 2];
7143 i += 3;
7144
Gilles Peskine449bd832023-01-11 14:50:10 +01007145 if (n < 128 || i + n > ssl->in_hslen) {
7146 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7147 mbedtls_ssl_send_alert_message(ssl,
7148 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7149 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7150 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007151 }
7152
7153 /* Check if we're handling the first CRT in the chain. */
7154#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007156 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007158 /* During client-side renegotiation, check that the server's
7159 * end-CRTs hasn't changed compared to the initial handshake,
7160 * mitigating the triple handshake attack. On success, reuse
7161 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7163 if (ssl_check_peer_crt_unchanged(ssl,
7164 &ssl->in_msg[i],
7165 n) != 0) {
7166 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7167 mbedtls_ssl_send_alert_message(ssl,
7168 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7169 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7170 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007171 }
7172
7173 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007175 }
7176#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7177
7178 /* Parse the next certificate in the chain. */
7179#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007181#else
7182 /* If we don't need to store the CRT chain permanently, parse
7183 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007184 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007185#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007186 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007187 case 0: /*ok*/
7188 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7189 /* Ignore certificate with an unknown algorithm: maybe a
7190 prior certificate was already trusted. */
7191 break;
7192
7193 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7194 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7195 goto crt_parse_der_failed;
7196
7197 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7198 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7199 goto crt_parse_der_failed;
7200
7201 default:
7202 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007203crt_parse_der_failed:
7204 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7205 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7206 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007207 }
7208
7209 i += n;
7210 }
7211
Gilles Peskine449bd832023-01-11 14:50:10 +01007212 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7213 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007214}
7215
7216#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007217MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007218static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007219{
Gilles Peskine449bd832023-01-11 14:50:10 +01007220 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7221 return -1;
7222 }
Jerry Yud9526692022-02-17 14:23:47 +08007223
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007225 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7226 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007227 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7228 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7229 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007230 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007231 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007232}
7233#endif /* MBEDTLS_SSL_SRV_C */
7234
7235/* Check if a certificate message is expected.
7236 * Return either
7237 * - SSL_CERTIFICATE_EXPECTED, or
7238 * - SSL_CERTIFICATE_SKIP
7239 * indicating whether a Certificate message is expected or not.
7240 */
7241#define SSL_CERTIFICATE_EXPECTED 0
7242#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007243MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007244static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7245 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007246{
7247 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7248 ssl->handshake->ciphersuite_info;
7249
Gilles Peskine449bd832023-01-11 14:50:10 +01007250 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7251 return SSL_CERTIFICATE_SKIP;
7252 }
Jerry Yud9526692022-02-17 14:23:47 +08007253
7254#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7256 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7257 return SSL_CERTIFICATE_SKIP;
7258 }
Jerry Yud9526692022-02-17 14:23:47 +08007259
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007261 ssl->session_negotiate->verify_result =
7262 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007264 }
7265 }
7266#else
7267 ((void) authmode);
7268#endif /* MBEDTLS_SSL_SRV_C */
7269
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007271}
7272
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007273MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007274static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7275 int authmode,
7276 mbedtls_x509_crt *chain,
7277 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007278{
7279 int ret = 0;
7280 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7281 ssl->handshake->ciphersuite_info;
7282 int have_ca_chain = 0;
7283
7284 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7285 void *p_vrfy;
7286
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7288 return 0;
7289 }
Jerry Yud9526692022-02-17 14:23:47 +08007290
Gilles Peskine449bd832023-01-11 14:50:10 +01007291 if (ssl->f_vrfy != NULL) {
7292 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007293 f_vrfy = ssl->f_vrfy;
7294 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007295 } else {
7296 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007297 f_vrfy = ssl->conf->f_vrfy;
7298 p_vrfy = ssl->conf->p_vrfy;
7299 }
7300
7301 /*
7302 * Main check: verify certificate
7303 */
7304#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007305 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007306 ((void) rs_ctx);
7307 have_ca_chain = 1;
7308
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007310 ret = mbedtls_x509_crt_verify_with_ca_cb(
7311 chain,
7312 ssl->conf->f_ca_cb,
7313 ssl->conf->p_ca_cb,
7314 ssl->conf->cert_profile,
7315 ssl->hostname,
7316 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 f_vrfy, p_vrfy);
7318 } else
Jerry Yud9526692022-02-17 14:23:47 +08007319#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7320 {
7321 mbedtls_x509_crt *ca_chain;
7322 mbedtls_x509_crl *ca_crl;
7323
7324#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007326 ca_chain = ssl->handshake->sni_ca_chain;
7327 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 } else
Jerry Yud9526692022-02-17 14:23:47 +08007329#endif
7330 {
7331 ca_chain = ssl->conf->ca_chain;
7332 ca_crl = ssl->conf->ca_crl;
7333 }
7334
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007336 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007337 }
Jerry Yud9526692022-02-17 14:23:47 +08007338
7339 ret = mbedtls_x509_crt_verify_restartable(
7340 chain,
7341 ca_chain, ca_crl,
7342 ssl->conf->cert_profile,
7343 ssl->hostname,
7344 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007345 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007346 }
7347
Gilles Peskine449bd832023-01-11 14:50:10 +01007348 if (ret != 0) {
7349 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007350 }
7351
7352#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7354 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7355 }
Jerry Yud9526692022-02-17 14:23:47 +08007356#endif
7357
7358 /*
7359 * Secondary checks: always done, but change 'ret' only if it was 0
7360 */
7361
Valerio Settiacd32c02023-06-29 18:06:29 +02007362#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007363 {
7364 const mbedtls_pk_context *pk = &chain->pk;
7365
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007366 /* If certificate uses an EC key, make sure the curve is OK.
7367 * This is a public key, so it can't be opaque, so can_do() is a good
7368 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007370 /* and in the unlikely case the above assumption no longer holds
7371 * we are making sure that pk_ec() here does not return a NULL
7372 */
Valerio Settid0405092023-05-24 13:16:40 +02007373 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7374 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7375 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007377 }
Valerio Setti97207782023-05-18 18:59:06 +02007378 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007379 ssl->session_negotiate->verify_result |=
7380 MBEDTLS_X509_BADCERT_BAD_KEY;
7381
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7383 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007384 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007385 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007386 }
Jerry Yud9526692022-02-17 14:23:47 +08007387 }
7388 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007389#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007390
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 if (mbedtls_ssl_check_cert_usage(chain,
7392 ciphersuite_info,
7393 !ssl->conf->endpoint,
7394 &ssl->session_negotiate->verify_result) != 0) {
7395 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7396 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007397 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 }
Jerry Yud9526692022-02-17 14:23:47 +08007399 }
7400
7401 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7402 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7403 * with details encoded in the verification flags. All other kinds
7404 * of error codes, including those from the user provided f_vrfy
7405 * functions, are treated as fatal and lead to a failure of
7406 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007407 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7408 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7409 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007410 ret = 0;
7411 }
7412
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7414 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007415 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7416 }
7417
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007419 uint8_t alert;
7420
7421 /* The certificate may have been rejected for several reasons.
7422 Pick one and send the corresponding alert. Which alert to send
7423 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007425 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007427 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007429 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007431 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007433 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007435 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007437 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007439 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007441 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007443 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007445 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 }
7447 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7448 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007449 }
7450
7451#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 if (ssl->session_negotiate->verify_result != 0) {
7453 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7454 (unsigned int) ssl->session_negotiate->verify_result));
7455 } else {
7456 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007457 }
7458#endif /* MBEDTLS_DEBUG_C */
7459
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007461}
7462
7463#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007464MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007465static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7466 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007467{
7468 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7469 /* Remember digest of the peer's end-CRT. */
7470 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7472 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7473 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7474 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7475 mbedtls_ssl_send_alert_message(ssl,
7476 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7477 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007478
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007480 }
7481
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 ret = mbedtls_md(mbedtls_md_info_from_type(
7483 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7484 start, len,
7485 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007486
7487 ssl->session_negotiate->peer_cert_digest_type =
7488 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7489 ssl->session_negotiate->peer_cert_digest_len =
7490 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7491
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007493}
7494
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007495MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007496static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7497 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007498{
7499 unsigned char *end = start + len;
7500 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7501
7502 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7504 ret = mbedtls_pk_parse_subpubkey(&start, end,
7505 &ssl->handshake->peer_pubkey);
7506 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007507 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007509 }
7510
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007512}
7513#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7514
Gilles Peskine449bd832023-01-11 14:50:10 +01007515int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007516{
7517 int ret = 0;
7518 int crt_expected;
7519#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7520 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7521 ? ssl->handshake->sni_authmode
7522 : ssl->conf->authmode;
7523#else
7524 const int authmode = ssl->conf->authmode;
7525#endif
7526 void *rs_ctx = NULL;
7527 mbedtls_x509_crt *chain = NULL;
7528
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007530
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7532 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7533 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007534 goto exit;
7535 }
7536
7537#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 if (ssl->handshake->ecrs_enabled &&
7539 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007540 chain = ssl->handshake->ecrs_peer_cert;
7541 ssl->handshake->ecrs_peer_cert = NULL;
7542 goto crt_verify;
7543 }
7544#endif
7545
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007547 /* mbedtls_ssl_read_record may have sent an alert already. We
7548 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007550 goto exit;
7551 }
7552
7553#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007555 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7556
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007558 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 }
Jerry Yud9526692022-02-17 14:23:47 +08007560
7561 goto exit;
7562 }
7563#endif /* MBEDTLS_SSL_SRV_C */
7564
7565 /* Clear existing peer CRT structure in case we tried to
7566 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007567 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007568
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7570 if (chain == NULL) {
7571 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7572 sizeof(mbedtls_x509_crt)));
7573 mbedtls_ssl_send_alert_message(ssl,
7574 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7575 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007576
7577 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7578 goto exit;
7579 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007581
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 ret = ssl_parse_certificate_chain(ssl, chain);
7583 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007584 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 }
Jerry Yud9526692022-02-17 14:23:47 +08007586
7587#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007589 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 }
Jerry Yud9526692022-02-17 14:23:47 +08007591
7592crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007594 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007595 }
Jerry Yud9526692022-02-17 14:23:47 +08007596#endif
7597
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 ret = ssl_parse_certificate_verify(ssl, authmode,
7599 chain, rs_ctx);
7600 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007601 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 }
Jerry Yud9526692022-02-17 14:23:47 +08007603
7604#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7605 {
7606 unsigned char *crt_start, *pk_start;
7607 size_t crt_len, pk_len;
7608
7609 /* We parse the CRT chain without copying, so
7610 * these pointers point into the input buffer,
7611 * and are hence still valid after freeing the
7612 * CRT chain. */
7613
7614 crt_start = chain->raw.p;
7615 crt_len = chain->raw.len;
7616
7617 pk_start = chain->pk_raw.p;
7618 pk_len = chain->pk_raw.len;
7619
7620 /* Free the CRT structures before computing
7621 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 mbedtls_x509_crt_free(chain);
7623 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007624 chain = NULL;
7625
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7627 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007628 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 }
Jerry Yud9526692022-02-17 14:23:47 +08007630
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7632 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007633 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 }
Jerry Yud9526692022-02-17 14:23:47 +08007635 }
7636#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7637 /* Pass ownership to session structure. */
7638 ssl->session_negotiate->peer_cert = chain;
7639 chain = NULL;
7640#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7641
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007643
7644exit:
7645
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007647 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 }
Jerry Yud9526692022-02-17 14:23:47 +08007649
7650#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007652 ssl->handshake->ecrs_peer_cert = chain;
7653 chain = NULL;
7654 }
7655#endif
7656
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 if (chain != NULL) {
7658 mbedtls_x509_crt_free(chain);
7659 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007660 }
7661
Gilles Peskine449bd832023-01-11 14:50:10 +01007662 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007663}
7664#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7665
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007666static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7667 unsigned char *padbuf, size_t hlen,
7668 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007669{
7670 int len = 12;
7671 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007672#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007673 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007674 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007675 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007676 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007677#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007678 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007679 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007680 mbedtls_md_context_t cloned_ctx;
7681 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007682#endif
7683
7684 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007686 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007687 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007688
Gilles Peskine449bd832023-01-11 14:50:10 +01007689 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007690 ? "client finished"
7691 : "server finished";
7692
7693#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007694 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007695
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007696 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007698 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007699 }
7700
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007701 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007702 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007703 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007704 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007705 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007706#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007707 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007708
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007709 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007710 if (ret != 0) {
7711 goto exit;
7712 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007713 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007714 if (ret != 0) {
7715 goto exit;
7716 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007717
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007718 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007719 if (ret != 0) {
7720 goto exit;
7721 }
7722#endif /* MBEDTLS_USE_PSA_CRYPTO */
7723
7724 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7725
Jerry Yu615bd6f2022-02-17 14:25:15 +08007726 /*
7727 * TLSv1.2:
7728 * hash = PRF( master, finished_label,
7729 * Hash( handshake ) )[0.11]
7730 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007732 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007733
Gilles Peskine449bd832023-01-11 14:50:10 +01007734 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007735
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007737
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007738 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007739
7740exit:
7741#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007742 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007743 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007744#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007745 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007746 return ret;
7747#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007748}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007749
7750#if defined(MBEDTLS_MD_CAN_SHA256)
7751static int ssl_calc_finished_tls_sha256(
7752 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7753{
7754 unsigned char padbuf[32];
7755 return ssl_calc_finished_tls_generic(ssl,
7756#if defined(MBEDTLS_USE_PSA_CRYPTO)
7757 &ssl->handshake->fin_sha256_psa,
7758#else
7759 &ssl->handshake->fin_sha256,
7760#endif
7761 padbuf, sizeof(padbuf),
7762 buf, from);
7763}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007764#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007765
Jerry Yub7ba49e2022-02-17 14:25:53 +08007766
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007767#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007768static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007769 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007770{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007771 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007772 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007773#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007774 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007775#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007776 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007777#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007778 padbuf, sizeof(padbuf),
7779 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007780}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007781#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007782
Gilles Peskine449bd832023-01-11 14:50:10 +01007783void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007784{
Gilles Peskine449bd832023-01-11 14:50:10 +01007785 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007786
7787 /*
7788 * Free our handshake params
7789 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 mbedtls_ssl_handshake_free(ssl);
7791 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007792 ssl->handshake = NULL;
7793
7794 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007795 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007796 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007797 if (ssl->transform) {
7798 mbedtls_ssl_transform_free(ssl->transform);
7799 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007800 }
7801 ssl->transform = ssl->transform_negotiate;
7802 ssl->transform_negotiate = NULL;
7803
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007805}
7806
Gilles Peskine449bd832023-01-11 14:50:10 +01007807void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007808{
7809 int resume = ssl->handshake->resume;
7810
Gilles Peskine449bd832023-01-11 14:50:10 +01007811 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007812
7813#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007815 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7816 ssl->renego_records_seen = 0;
7817 }
7818#endif
7819
7820 /*
7821 * Free the previous session and switch in the current one
7822 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007823 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007824#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7825 /* RFC 7366 3.1: keep the EtM state */
7826 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007827 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007828#endif
7829
Gilles Peskine449bd832023-01-11 14:50:10 +01007830 mbedtls_ssl_session_free(ssl->session);
7831 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007832 }
7833 ssl->session = ssl->session_negotiate;
7834 ssl->session_negotiate = NULL;
7835
7836 /*
7837 * Add cache entry
7838 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007839 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007840 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007841 resume == 0) {
7842 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7843 ssl->session->id,
7844 ssl->session->id_len,
7845 ssl->session) != 0) {
7846 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7847 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007848 }
7849
7850#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007851 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7852 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007853 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007854 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007855
7856 /* Keep last flight around in case we need to resend it:
7857 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007858 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7859 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007860#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007861 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007862
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007863 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007864
Gilles Peskine449bd832023-01-11 14:50:10 +01007865 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007866}
7867
Gilles Peskine449bd832023-01-11 14:50:10 +01007868int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007869{
7870 int ret, hash_len;
7871
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007873
Gilles Peskine449bd832023-01-11 14:50:10 +01007874 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007875
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007876 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7877 if (ret != 0) {
7878 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7879 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007880
7881 /*
7882 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7883 * may define some other value. Currently (early 2016), no defined
7884 * ciphersuite does this (and this is unlikely to change as activity has
7885 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7886 */
7887 hash_len = 12;
7888
7889#if defined(MBEDTLS_SSL_RENEGOTIATION)
7890 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007891 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007892#endif
7893
7894 ssl->out_msglen = 4 + hash_len;
7895 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7896 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7897
7898 /*
7899 * In case of session resuming, invert the client and server
7900 * ChangeCipherSpec messages order.
7901 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007902 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007903#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007904 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007905 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007907#endif
7908#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007910 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007911 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007912#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007914 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007915 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007916
7917 /*
7918 * Switch to our negotiated transform and session parameters for outbound
7919 * data.
7920 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007922
7923#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007925 unsigned char i;
7926
7927 /* Remember current epoch settings for resending */
7928 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7930 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007931
7932 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007934
7935
7936 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 for (i = 2; i > 0; i--) {
7938 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007939 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007940 }
7941 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007942
7943 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 if (i == 0) {
7945 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7946 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007947 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007948 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007949#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007950 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007951
7952 ssl->transform_out = ssl->transform_negotiate;
7953 ssl->session_out = ssl->session_negotiate;
7954
7955#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007956 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7957 mbedtls_ssl_send_flight_completed(ssl);
7958 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007959#endif
7960
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7962 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7963 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007964 }
7965
7966#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007967 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7968 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7969 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7970 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007971 }
7972#endif
7973
Gilles Peskine449bd832023-01-11 14:50:10 +01007974 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007975
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007977}
7978
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007979#define SSL_MAX_HASH_LEN 12
7980
Gilles Peskine449bd832023-01-11 14:50:10 +01007981int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007982{
7983 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7984 unsigned int hash_len = 12;
7985 unsigned char buf[SSL_MAX_HASH_LEN];
7986
Gilles Peskine449bd832023-01-11 14:50:10 +01007987 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007988
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007989 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7990 if (ret != 0) {
7991 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7992 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007993
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7995 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007996 goto exit;
7997 }
7998
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
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_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008003 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8004 goto exit;
8005 }
8006
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8008 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8009 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008010 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8011 goto exit;
8012 }
8013
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8015 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8016 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8017 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008018 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8019 goto exit;
8020 }
8021
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8023 buf, hash_len) != 0) {
8024 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8025 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8026 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008027 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8028 goto exit;
8029 }
8030
8031#if defined(MBEDTLS_SSL_RENEGOTIATION)
8032 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008034#endif
8035
Gilles Peskine449bd832023-01-11 14:50:10 +01008036 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008037#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008039 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008040 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008041#endif
8042#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008043 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008044 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008045 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008046#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008048 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008049 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008050
8051#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008052 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8053 mbedtls_ssl_recv_flight_completed(ssl);
8054 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008055#endif
8056
Gilles Peskine449bd832023-01-11 14:50:10 +01008057 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008058
8059exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008060 mbedtls_platform_zeroize(buf, hash_len);
8061 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008062}
8063
Jerry Yu392112c2022-02-17 14:34:10 +08008064#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8065/*
8066 * Helper to get TLS 1.2 PRF from ciphersuite
8067 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8068 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008069static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008070{
Jerry Yu392112c2022-02-17 14:34:10 +08008071 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
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 (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8075 return tls_prf_sha384;
8076 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008077#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008078#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008079 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8081 return tls_prf_sha256;
8082 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008083 }
8084#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008085#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8086 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008087 (void) ciphersuite_info;
8088#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008089
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008091}
8092#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008093
Gilles Peskine449bd832023-01-11 14:50:10 +01008094static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008095{
8096 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008097#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 if (tls_prf == tls_prf_sha384) {
8099 return MBEDTLS_SSL_TLS_PRF_SHA384;
8100 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008101#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008102#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 if (tls_prf == tls_prf_sha256) {
8104 return MBEDTLS_SSL_TLS_PRF_SHA256;
8105 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008106#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008107 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008108}
8109
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008110/*
8111 * Populate a transform structure with session keys and all the other
8112 * necessary information.
8113 *
8114 * Parameters:
8115 * - [in/out]: transform: structure to populate
8116 * [in] must be just initialised with mbedtls_ssl_transform_init()
8117 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8118 * - [in] ciphersuite
8119 * - [in] master
8120 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008121 * - [in] tls_prf: pointer to PRF to use for key derivation
8122 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008123 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008124 * - [in] endpoint: client or server
8125 * - [in] ssl: used for:
8126 * - ssl->conf->{f,p}_export_keys
8127 * [in] optionally used for:
8128 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8129 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008130MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008131static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8132 int ciphersuite,
8133 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008134#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008135 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008136#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008137 ssl_tls_prf_t tls_prf,
8138 const unsigned char randbytes[64],
8139 mbedtls_ssl_protocol_version tls_version,
8140 unsigned endpoint,
8141 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008142{
8143 int ret = 0;
8144 unsigned char keyblk[256];
8145 unsigned char *key1;
8146 unsigned char *key2;
8147 unsigned char *mac_enc;
8148 unsigned char *mac_dec;
8149 size_t mac_key_len = 0;
8150 size_t iv_copy_len;
8151 size_t keylen;
8152 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008153 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008154#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008155 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008156 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008157#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008158
8159#if defined(MBEDTLS_USE_PSA_CRYPTO)
8160 psa_key_type_t key_type;
8161 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8162 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008163 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008164 size_t key_bits;
8165 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8166#endif
8167
8168#if !defined(MBEDTLS_DEBUG_C) && \
8169 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008170 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008171 ssl = NULL; /* make sure we don't use it except for these cases */
8172 (void) ssl;
8173 }
8174#endif
8175
8176 /*
8177 * Some data just needs copying into the structure
8178 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008179#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008180 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008181#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008182 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008183
8184#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008185 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008186#endif
8187
8188#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008189 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008190 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8191 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008193 }
8194#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8195
8196 /*
8197 * Get various info structures
8198 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008199 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8200 if (ciphersuite_info == NULL) {
8201 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8202 ciphersuite));
8203 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008204 }
8205
Neil Armstrongab555e02022-04-04 11:07:59 +02008206 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008207#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008208 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008209#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008211
Gilles Peskine449bd832023-01-11 14:50:10 +01008212 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008213 transform->taglen =
8214 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008215 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008216
8217#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008218 if ((status = mbedtls_ssl_cipher_to_psa(ciphersuite_info->cipher,
8219 transform->taglen,
8220 &alg,
8221 &key_type,
8222 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008223 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008224 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008225 goto end;
8226 }
8227#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008228 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008229 if (cipher_info == NULL) {
8230 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8231 ciphersuite_info->cipher));
8232 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008233 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008234#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008235
Neil Armstronge4512952022-03-08 09:08:22 +01008236#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008237 mac_alg = mbedtls_md_psa_alg_from_type(ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008239 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008240 (unsigned) ciphersuite_info->mac));
8241 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008242 }
8243#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008244 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008245 if (md_info == NULL) {
8246 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8247 (unsigned) ciphersuite_info->mac));
8248 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008249 }
Neil Armstronge4512952022-03-08 09:08:22 +01008250#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008251
8252#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8253 /* Copy own and peer's CID if the use of the CID
8254 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008255 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8256 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008257
8258 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008259 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8260 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8261 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008262
8263 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008264 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8265 ssl->handshake->peer_cid_len);
8266 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8267 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008268 }
8269#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8270
8271 /*
8272 * Compute key block using the PRF
8273 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008274 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8275 if (ret != 0) {
8276 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8277 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008278 }
8279
Gilles Peskine449bd832023-01-11 14:50:10 +01008280 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8281 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8282 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8283 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8284 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008285
8286 /*
8287 * Determine the appropriate key, IV and MAC length.
8288 */
8289
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008290#if defined(MBEDTLS_USE_PSA_CRYPTO)
8291 keylen = PSA_BITS_TO_BYTES(key_bits);
8292#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008293 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008294#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008295
8296#if defined(MBEDTLS_GCM_C) || \
8297 defined(MBEDTLS_CCM_C) || \
8298 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008299 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008300 size_t explicit_ivlen;
8301
8302 transform->maclen = 0;
8303 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008304
8305 /* All modes haves 96-bit IVs, but the length of the static parts vary
8306 * with mode and version:
8307 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8308 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8309 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8310 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8311 * sequence number).
8312 */
8313 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008314
8315 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008316#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008317 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008318#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008319 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8320 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008321#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008322
Gilles Peskine449bd832023-01-11 14:50:10 +01008323 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008324 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008325 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008326 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008328
8329 /* Minimum length of encrypted record */
8330 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8331 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008332 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008333#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8334#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008335 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008336 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008337 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008338#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008339 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008340#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008341 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008342#endif /* MBEDTLS_USE_PSA_CRYPTO */
8343
8344#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008345 /* Get MAC length */
8346 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8347#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008348 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008349 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8350 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8351 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008352 goto end;
8353 }
8354
8355 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008356 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008357#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008358 transform->maclen = mac_key_len;
8359
8360 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008361#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008362 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008363#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008364 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008365#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008366
8367 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008368 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008369 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008370 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008371 /*
8372 * GenericBlockCipher:
8373 * 1. if EtM is in use: one block plus MAC
8374 * otherwise: * first multiple of blocklen greater than maclen
8375 * 2. IV
8376 */
8377#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008378 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008379 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008380 + block_size;
8381 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008382#endif
8383 {
8384 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008385 + block_size
8386 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008387 }
8388
Gilles Peskine449bd832023-01-11 14:50:10 +01008389 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008390 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008391 } else {
8392 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008393 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8394 goto end;
8395 }
8396 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008397 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008398#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8399 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008400 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8401 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008402 }
8403
Gilles Peskine449bd832023-01-11 14:50:10 +01008404 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8405 (unsigned) keylen,
8406 (unsigned) transform->minlen,
8407 (unsigned) transform->ivlen,
8408 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008409
8410 /*
8411 * Finally setup the cipher contexts, IVs and MAC secrets.
8412 */
8413#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008414 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008415 key1 = keyblk + mac_key_len * 2;
8416 key2 = keyblk + mac_key_len * 2 + keylen;
8417
8418 mac_enc = keyblk;
8419 mac_dec = keyblk + mac_key_len;
8420
Gilles Peskine449bd832023-01-11 14:50:10 +01008421 iv_copy_len = (transform->fixed_ivlen) ?
8422 transform->fixed_ivlen : transform->ivlen;
8423 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8424 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8425 iv_copy_len);
8426 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008427#endif /* MBEDTLS_SSL_CLI_C */
8428#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008429 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008430 key1 = keyblk + mac_key_len * 2 + keylen;
8431 key2 = keyblk + mac_key_len * 2;
8432
8433 mac_enc = keyblk + mac_key_len;
8434 mac_dec = keyblk;
8435
Gilles Peskine449bd832023-01-11 14:50:10 +01008436 iv_copy_len = (transform->fixed_ivlen) ?
8437 transform->fixed_ivlen : transform->ivlen;
8438 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8439 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8440 iv_copy_len);
8441 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008442#endif /* MBEDTLS_SSL_SRV_C */
8443 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008444 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008445 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8446 goto end;
8447 }
8448
Gilles Peskine449bd832023-01-11 14:50:10 +01008449 if (ssl != NULL && ssl->f_export_keys != NULL) {
8450 ssl->f_export_keys(ssl->p_export_keys,
8451 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8452 master, 48,
8453 randbytes + 32,
8454 randbytes,
8455 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008456 }
8457
8458#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008459 transform->psa_alg = alg;
8460
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8462 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8463 psa_set_key_algorithm(&attributes, alg);
8464 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008465
Gilles Peskine449bd832023-01-11 14:50:10 +01008466 if ((status = psa_import_key(&attributes,
8467 key1,
8468 PSA_BITS_TO_BYTES(key_bits),
8469 &transform->psa_key_enc)) != PSA_SUCCESS) {
8470 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008471 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008472 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008473 goto end;
8474 }
8475
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008477
Gilles Peskine449bd832023-01-11 14:50:10 +01008478 if ((status = psa_import_key(&attributes,
8479 key2,
8480 PSA_BITS_TO_BYTES(key_bits),
8481 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008482 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008484 goto end;
8485 }
8486 }
8487#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008488 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8489 cipher_info)) != 0) {
8490 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008491 goto end;
8492 }
8493
Gilles Peskine449bd832023-01-11 14:50:10 +01008494 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8495 cipher_info)) != 0) {
8496 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008497 goto end;
8498 }
8499
Gilles Peskine449bd832023-01-11 14:50:10 +01008500 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8501 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8502 MBEDTLS_ENCRYPT)) != 0) {
8503 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008504 goto end;
8505 }
8506
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8508 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8509 MBEDTLS_DECRYPT)) != 0) {
8510 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008511 goto end;
8512 }
8513
8514#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008515 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8516 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8517 MBEDTLS_PADDING_NONE)) != 0) {
8518 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008519 goto end;
8520 }
8521
Gilles Peskine449bd832023-01-11 14:50:10 +01008522 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8523 MBEDTLS_PADDING_NONE)) != 0) {
8524 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008525 goto end;
8526 }
8527 }
8528#endif /* MBEDTLS_CIPHER_MODE_CBC */
8529#endif /* MBEDTLS_USE_PSA_CRYPTO */
8530
Neil Armstrong29c0c042022-03-17 17:47:28 +01008531#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8532 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8533 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008534 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008535#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008536 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008537
Gilles Peskine449bd832023-01-11 14:50:10 +01008538 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8539 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8540 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008541
Gilles Peskine449bd832023-01-11 14:50:10 +01008542 if ((status = psa_import_key(&attributes,
8543 mac_enc, mac_key_len,
8544 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008545 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008547 goto end;
8548 }
8549
Gilles Peskine449bd832023-01-11 14:50:10 +01008550 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8551 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008552#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008553 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008554#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008556 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008557 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8558 PSA_KEY_USAGE_VERIFY_HASH);
8559 } else {
8560 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8561 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008562
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 if ((status = psa_import_key(&attributes,
8564 mac_dec, mac_key_len,
8565 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008566 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008567 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008568 goto end;
8569 }
8570#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8572 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008573 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008574 }
8575 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8576 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008577 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008578 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008579#endif /* MBEDTLS_USE_PSA_CRYPTO */
8580 }
8581#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8582
8583 ((void) mac_dec);
8584 ((void) mac_enc);
8585
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008586end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008587 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8588 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008589}
8590
Valerio Settia08b1a42022-11-17 15:10:02 +01008591#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8592 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008593int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 psa_pake_operation_t *pake_ctx,
8595 const unsigned char *buf,
8596 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008597{
8598 psa_status_t status;
8599 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008600 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008601 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8602 * At round two perform a single cycle
8603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008605
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 for (; remaining_steps > 0; remaining_steps--) {
8607 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008608 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008609 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008610 /* Length is stored at the first byte */
8611 size_t length = buf[input_offset];
8612 input_offset += 1;
8613
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008615 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8616 }
8617
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 status = psa_pake_input(pake_ctx, step,
8619 buf + input_offset, length);
8620 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008621 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008622 }
8623
8624 input_offset += length;
8625 }
8626 }
8627
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008629 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008630 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008631
Gilles Peskine449bd832023-01-11 14:50:10 +01008632 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008633}
8634
Valerio Setti6b3dab02022-11-17 17:14:54 +01008635int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008636 psa_pake_operation_t *pake_ctx,
8637 unsigned char *buf,
8638 size_t len, size_t *olen,
8639 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008640{
8641 psa_status_t status;
8642 size_t output_offset = 0;
8643 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008644 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008645 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8646 * At round two perform a single cycle
8647 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008648 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008649
Gilles Peskine449bd832023-01-11 14:50:10 +01008650 for (; remaining_steps > 0; remaining_steps--) {
8651 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8652 step <= PSA_PAKE_STEP_ZK_PROOF;
8653 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008654 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008655 * For each step, prepend 1 byte with the length of the data as
8656 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008657 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008658 status = psa_pake_output(pake_ctx, step,
8659 buf + output_offset + 1,
8660 len - output_offset - 1,
8661 &output_len);
8662 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008663 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008664 }
8665
Valerio Setti99d88c12022-11-22 16:03:43 +01008666 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008667
8668 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008669 }
8670 }
8671
8672 *olen = output_offset;
8673
Gilles Peskine449bd832023-01-11 14:50:10 +01008674 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008675}
Valerio Settia08b1a42022-11-17 15:10:02 +01008676#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8677
Jerry Yuee40f9d2022-02-17 14:55:16 +08008678#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008679int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8680 unsigned char *hash, size_t *hashlen,
8681 unsigned char *data, size_t data_len,
8682 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008683{
8684 psa_status_t status;
8685 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008686 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008687
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008689
Gilles Peskine449bd832023-01-11 14:50:10 +01008690 if ((status = psa_hash_setup(&hash_operation,
8691 hash_alg)) != PSA_SUCCESS) {
8692 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008693 goto exit;
8694 }
8695
Gilles Peskine449bd832023-01-11 14:50:10 +01008696 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8697 64)) != PSA_SUCCESS) {
8698 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008699 goto exit;
8700 }
8701
Gilles Peskine449bd832023-01-11 14:50:10 +01008702 if ((status = psa_hash_update(&hash_operation,
8703 data, data_len)) != PSA_SUCCESS) {
8704 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008705 goto exit;
8706 }
8707
Gilles Peskine449bd832023-01-11 14:50:10 +01008708 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8709 hashlen)) != PSA_SUCCESS) {
8710 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8711 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008712 }
8713
8714exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008715 if (status != PSA_SUCCESS) {
8716 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8717 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8718 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008719 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008720 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008721 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8722 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008723 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008724 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008725 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008726 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008727 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008728 }
8729 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008730 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008731}
8732
8733#else
8734
Gilles Peskine449bd832023-01-11 14:50:10 +01008735int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8736 unsigned char *hash, size_t *hashlen,
8737 unsigned char *data, size_t data_len,
8738 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008739{
8740 int ret = 0;
8741 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008742 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8743 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008744
Gilles Peskine449bd832023-01-11 14:50:10 +01008745 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008746
Gilles Peskine449bd832023-01-11 14:50:10 +01008747 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008748
8749 /*
8750 * digitally-signed struct {
8751 * opaque client_random[32];
8752 * opaque server_random[32];
8753 * ServerDHParams params;
8754 * };
8755 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008756 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8757 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008758 goto exit;
8759 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008760 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8761 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008762 goto exit;
8763 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008764 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8765 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008766 goto exit;
8767 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008768 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8769 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008770 goto exit;
8771 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008772 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8773 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008774 goto exit;
8775 }
8776
8777exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008778 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008779
Gilles Peskine449bd832023-01-11 14:50:10 +01008780 if (ret != 0) {
8781 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8782 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8783 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008784
Gilles Peskine449bd832023-01-11 14:50:10 +01008785 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008786}
8787#endif /* MBEDTLS_USE_PSA_CRYPTO */
8788
Jerry Yud9d91da2022-02-17 14:57:06 +08008789#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8790
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008791/* Find the preferred hash for a given signature algorithm. */
8792unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008793 mbedtls_ssl_context *ssl,
8794 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008795{
Gabor Mezei078e8032022-04-27 21:17:56 +02008796 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008797 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008798
Gilles Peskine449bd832023-01-11 14:50:10 +01008799 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8800 return MBEDTLS_SSL_HASH_NONE;
8801 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008802
Gilles Peskine449bd832023-01-11 14:50:10 +01008803 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008804 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008805 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8806 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008807 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008808 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8809 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008810
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008811 mbedtls_md_type_t md_alg =
8812 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8813 if (md_alg == MBEDTLS_MD_NONE) {
8814 continue;
8815 }
8816
Gilles Peskine449bd832023-01-11 14:50:10 +01008817 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008818#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008819 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008820 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008821 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008822
Gilles Peskine449bd832023-01-11 14:50:10 +01008823 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8824 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8825 PSA_ALG_ECDSA(psa_hash_alg),
8826 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008827 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008828 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008829
Gilles Peskine449bd832023-01-11 14:50:10 +01008830 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8831 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8832 PSA_ALG_RSA_PKCS1V15_SIGN(
8833 psa_hash_alg),
8834 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008835 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008836 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008837 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008838#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008839
Gilles Peskine449bd832023-01-11 14:50:10 +01008840 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008841 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008842 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008843
Gilles Peskine449bd832023-01-11 14:50:10 +01008844 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008845}
8846
8847#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8848
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008849/* Serialization of TLS 1.2 sessions:
8850 *
8851 * struct {
8852 * uint64 start_time;
8853 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008854 * uint8 session_id_len; // at most 32
8855 * opaque session_id[32];
8856 * opaque master[48]; // fixed length in the standard
8857 * uint32 verify_result;
8858 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8859 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8860 * uint32 ticket_lifetime;
8861 * uint8 mfl_code; // up to 255 according to standard
8862 * uint8 encrypt_then_mac; // 0 or 1
8863 * } serialized_session_tls12;
8864 *
8865 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008866static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8867 unsigned char *buf,
8868 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008869{
8870 unsigned char *p = buf;
8871 size_t used = 0;
8872
8873#if defined(MBEDTLS_HAVE_TIME)
8874 uint64_t start;
8875#endif
8876#if defined(MBEDTLS_X509_CRT_PARSE_C)
8877#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8878 size_t cert_len;
8879#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8880#endif /* MBEDTLS_X509_CRT_PARSE_C */
8881
8882 /*
8883 * Time
8884 */
8885#if defined(MBEDTLS_HAVE_TIME)
8886 used += 8;
8887
Gilles Peskine449bd832023-01-11 14:50:10 +01008888 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008889 start = (uint64_t) session->start;
8890
Gilles Peskine449bd832023-01-11 14:50:10 +01008891 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008892 p += 8;
8893 }
8894#endif /* MBEDTLS_HAVE_TIME */
8895
8896 /*
8897 * Basic mandatory fields
8898 */
8899 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008900 + 1 /* id_len */
8901 + sizeof(session->id)
8902 + sizeof(session->master)
8903 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008904
Gilles Peskine449bd832023-01-11 14:50:10 +01008905 if (used <= buf_len) {
8906 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008907 p += 2;
8908
Gilles Peskine449bd832023-01-11 14:50:10 +01008909 *p++ = MBEDTLS_BYTE_0(session->id_len);
8910 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008911 p += 32;
8912
Gilles Peskine449bd832023-01-11 14:50:10 +01008913 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008914 p += 48;
8915
Gilles Peskine449bd832023-01-11 14:50:10 +01008916 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008917 p += 4;
8918 }
8919
8920 /*
8921 * Peer's end-entity certificate
8922 */
8923#if defined(MBEDTLS_X509_CRT_PARSE_C)
8924#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008925 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008926 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008927 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008928 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008929 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008930
8931 used += 3 + cert_len;
8932
Gilles Peskine449bd832023-01-11 14:50:10 +01008933 if (used <= buf_len) {
8934 *p++ = MBEDTLS_BYTE_2(cert_len);
8935 *p++ = MBEDTLS_BYTE_1(cert_len);
8936 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008937
Gilles Peskine449bd832023-01-11 14:50:10 +01008938 if (session->peer_cert != NULL) {
8939 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008940 p += cert_len;
8941 }
8942 }
8943#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008944 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008945 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008946 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008947 *p++ = (unsigned char) session->peer_cert_digest_type;
8948 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008949 memcpy(p, session->peer_cert_digest,
8950 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008951 p += session->peer_cert_digest_len;
8952 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008953 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008954 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008955 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008956 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8957 *p++ = 0;
8958 }
8959 }
8960#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8961#endif /* MBEDTLS_X509_CRT_PARSE_C */
8962
8963 /*
8964 * Session ticket if any, plus associated data
8965 */
8966#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8967 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8968
Gilles Peskine449bd832023-01-11 14:50:10 +01008969 if (used <= buf_len) {
8970 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
8971 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
8972 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008973
Gilles Peskine449bd832023-01-11 14:50:10 +01008974 if (session->ticket != NULL) {
8975 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008976 p += session->ticket_len;
8977 }
8978
Gilles Peskine449bd832023-01-11 14:50:10 +01008979 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008980 p += 4;
8981 }
8982#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8983
8984 /*
8985 * Misc extension-related info
8986 */
8987#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8988 used += 1;
8989
Gilles Peskine449bd832023-01-11 14:50:10 +01008990 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008991 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01008992 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008993#endif
8994
8995#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8996 used += 1;
8997
Gilles Peskine449bd832023-01-11 14:50:10 +01008998 if (used <= buf_len) {
8999 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9000 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009001#endif
9002
Gilles Peskine449bd832023-01-11 14:50:10 +01009003 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009004}
9005
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009006MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009007static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9008 const unsigned char *buf,
9009 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009010{
9011#if defined(MBEDTLS_HAVE_TIME)
9012 uint64_t start;
9013#endif
9014#if defined(MBEDTLS_X509_CRT_PARSE_C)
9015#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9016 size_t cert_len;
9017#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9018#endif /* MBEDTLS_X509_CRT_PARSE_C */
9019
9020 const unsigned char *p = buf;
9021 const unsigned char * const end = buf + len;
9022
9023 /*
9024 * Time
9025 */
9026#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009027 if (8 > (size_t) (end - p)) {
9028 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9029 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009030
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009031 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009032 p += 8;
9033
9034 session->start = (time_t) start;
9035#endif /* MBEDTLS_HAVE_TIME */
9036
9037 /*
9038 * Basic mandatory fields
9039 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009040 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9041 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9042 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009043
Gilles Peskine449bd832023-01-11 14:50:10 +01009044 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009045 p += 2;
9046
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009047 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009048 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009049 p += 32;
9050
Gilles Peskine449bd832023-01-11 14:50:10 +01009051 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009052 p += 48;
9053
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009054 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009055 p += 4;
9056
9057 /* Immediately clear invalid pointer values that have been read, in case
9058 * we exit early before we replaced them with valid ones. */
9059#if defined(MBEDTLS_X509_CRT_PARSE_C)
9060#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9061 session->peer_cert = NULL;
9062#else
9063 session->peer_cert_digest = NULL;
9064#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9065#endif /* MBEDTLS_X509_CRT_PARSE_C */
9066#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9067 session->ticket = NULL;
9068#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9069
9070 /*
9071 * Peer certificate
9072 */
9073#if defined(MBEDTLS_X509_CRT_PARSE_C)
9074#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9075 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009076 if (3 > (size_t) (end - p)) {
9077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9078 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009079
Gilles Peskine449bd832023-01-11 14:50:10 +01009080 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009081 p += 3;
9082
Gilles Peskine449bd832023-01-11 14:50:10 +01009083 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009084 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9085
Gilles Peskine449bd832023-01-11 14:50:10 +01009086 if (cert_len > (size_t) (end - p)) {
9087 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9088 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009089
Gilles Peskine449bd832023-01-11 14:50:10 +01009090 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009091
Gilles Peskine449bd832023-01-11 14:50:10 +01009092 if (session->peer_cert == NULL) {
9093 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9094 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009095
Gilles Peskine449bd832023-01-11 14:50:10 +01009096 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009097
Gilles Peskine449bd832023-01-11 14:50:10 +01009098 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9099 p, cert_len)) != 0) {
9100 mbedtls_x509_crt_free(session->peer_cert);
9101 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009102 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009103 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009104 }
9105
9106 p += cert_len;
9107 }
9108#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9109 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009110 if (2 > (size_t) (end - p)) {
9111 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9112 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009113
9114 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9115 session->peer_cert_digest_len = (size_t) *p++;
9116
Gilles Peskine449bd832023-01-11 14:50:10 +01009117 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009118 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009119 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9120 if (md_info == NULL) {
9121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9122 }
9123 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9124 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9125 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009126
Gilles Peskine449bd832023-01-11 14:50:10 +01009127 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9128 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9129 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009130
9131 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009132 mbedtls_calloc(1, session->peer_cert_digest_len);
9133 if (session->peer_cert_digest == NULL) {
9134 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9135 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009136
Gilles Peskine449bd832023-01-11 14:50:10 +01009137 memcpy(session->peer_cert_digest, p,
9138 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009139 p += session->peer_cert_digest_len;
9140 }
9141#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9142#endif /* MBEDTLS_X509_CRT_PARSE_C */
9143
9144 /*
9145 * Session ticket and associated data
9146 */
9147#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009148 if (3 > (size_t) (end - p)) {
9149 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9150 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009151
Gilles Peskine449bd832023-01-11 14:50:10 +01009152 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009153 p += 3;
9154
Gilles Peskine449bd832023-01-11 14:50:10 +01009155 if (session->ticket_len != 0) {
9156 if (session->ticket_len > (size_t) (end - p)) {
9157 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9158 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009159
Gilles Peskine449bd832023-01-11 14:50:10 +01009160 session->ticket = mbedtls_calloc(1, session->ticket_len);
9161 if (session->ticket == NULL) {
9162 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9163 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009164
Gilles Peskine449bd832023-01-11 14:50:10 +01009165 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009166 p += session->ticket_len;
9167 }
9168
Gilles Peskine449bd832023-01-11 14:50:10 +01009169 if (4 > (size_t) (end - p)) {
9170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9171 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009172
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009173 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009174 p += 4;
9175#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9176
9177 /*
9178 * Misc extension-related info
9179 */
9180#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009181 if (1 > (size_t) (end - p)) {
9182 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9183 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009184
9185 session->mfl_code = *p++;
9186#endif
9187
9188#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009189 if (1 > (size_t) (end - p)) {
9190 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9191 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009192
9193 session->encrypt_then_mac = *p++;
9194#endif
9195
9196 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009197 if (p != end) {
9198 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9199 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009200
Gilles Peskine449bd832023-01-11 14:50:10 +01009201 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009202}
Jerry Yudc7bd172022-02-17 13:44:15 +08009203#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9204
XiaokangQian75d40ef2022-04-20 11:05:24 +00009205int mbedtls_ssl_validate_ciphersuite(
9206 const mbedtls_ssl_context *ssl,
9207 const mbedtls_ssl_ciphersuite_t *suite_info,
9208 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009209 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009210{
9211 (void) ssl;
9212
Gilles Peskine449bd832023-01-11 14:50:10 +01009213 if (suite_info == NULL) {
9214 return -1;
9215 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009216
Gilles Peskine449bd832023-01-11 14:50:10 +01009217 if ((suite_info->min_tls_version > max_tls_version) ||
9218 (suite_info->max_tls_version < min_tls_version)) {
9219 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009220 }
9221
XiaokangQian060d8672022-04-21 09:24:56 +00009222#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009223#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009224#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009225 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9226 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009227#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009228 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9229 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009230#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009231 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009232 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009233 }
9234#endif
9235
9236 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9237#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009238 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9239 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9240 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009241 }
9242#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9243#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9244
Gilles Peskine449bd832023-01-11 14:50:10 +01009245 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009246}
9247
Ronald Crone68ab4f2022-10-05 12:46:29 +02009248#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009249/*
9250 * Function for writing a signature algorithm extension.
9251 *
9252 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9253 * value (TLS 1.3 RFC8446):
9254 * enum {
9255 * ....
9256 * ecdsa_secp256r1_sha256( 0x0403 ),
9257 * ecdsa_secp384r1_sha384( 0x0503 ),
9258 * ecdsa_secp521r1_sha512( 0x0603 ),
9259 * ....
9260 * } SignatureScheme;
9261 *
9262 * struct {
9263 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9264 * } SignatureSchemeList;
9265 *
9266 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9267 * value (TLS 1.2 RFC5246):
9268 * enum {
9269 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9270 * sha512(6), (255)
9271 * } HashAlgorithm;
9272 *
9273 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9274 * SignatureAlgorithm;
9275 *
9276 * struct {
9277 * HashAlgorithm hash;
9278 * SignatureAlgorithm signature;
9279 * } SignatureAndHashAlgorithm;
9280 *
9281 * SignatureAndHashAlgorithm
9282 * supported_signature_algorithms<2..2^16-2>;
9283 *
9284 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9285 * generalization of the TLS 1.2 signature algorithm extension.
9286 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9287 * `SignatureScheme` field of TLS 1.3
9288 *
9289 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009290int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9291 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009292{
9293 unsigned char *p = buf;
9294 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9295 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9296
9297 *out_len = 0;
9298
Gilles Peskine449bd832023-01-11 14:50:10 +01009299 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009300
9301 /* Check if we have space for header and length field:
9302 * - extension_type (2 bytes)
9303 * - extension_data_length (2 bytes)
9304 * - supported_signature_algorithms_length (2 bytes)
9305 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009306 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009307 p += 6;
9308
9309 /*
9310 * Write supported_signature_algorithms
9311 */
9312 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009313 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9314 if (sig_alg == NULL) {
9315 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9316 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009317
Gilles Peskine449bd832023-01-11 14:50:10 +01009318 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9319 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9320 *sig_alg,
9321 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9322 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009323 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009324 }
9325 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9326 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009327 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009328 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9329 *sig_alg,
9330 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009331 }
9332
9333 /* Length of supported_signature_algorithms */
9334 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009335 if (supported_sig_alg_len == 0) {
9336 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9337 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009338 }
9339
Gilles Peskine449bd832023-01-11 14:50:10 +01009340 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9341 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9342 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009343
XiaokangQianeaf36512022-04-24 09:07:44 +00009344 *out_len = p - buf;
9345
9346#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009347 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009348#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009349
Gilles Peskine449bd832023-01-11 14:50:10 +01009350 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009351}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009352#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009353
XiaokangQian40a35232022-05-07 09:02:40 +00009354#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009355/*
9356 * mbedtls_ssl_parse_server_name_ext
9357 *
9358 * Structure of server_name extension:
9359 *
9360 * enum {
9361 * host_name(0), (255)
9362 * } NameType;
9363 * opaque HostName<1..2^16-1>;
9364 *
9365 * struct {
9366 * NameType name_type;
9367 * select (name_type) {
9368 * case host_name: HostName;
9369 * } name;
9370 * } ServerName;
9371 * struct {
9372 * ServerName server_name_list<1..2^16-1>
9373 * } ServerNameList;
9374 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009375MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009376int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9377 const unsigned char *buf,
9378 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009379{
9380 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9381 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009382 size_t server_name_list_len, hostname_len;
9383 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009384
Gilles Peskine449bd832023-01-11 14:50:10 +01009385 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009386
Gilles Peskine449bd832023-01-11 14:50:10 +01009387 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9388 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009389 p += 2;
9390
Gilles Peskine449bd832023-01-11 14:50:10 +01009391 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009392 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009393 while (p < server_name_list_end) {
9394 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9395 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9396 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9397 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009398
Gilles Peskine449bd832023-01-11 14:50:10 +01009399 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009400 /* sni_name is intended to be used only during the parsing of the
9401 * ClientHello message (it is reset to NULL before the end of
9402 * the message parsing). Thus it is ok to just point to the
9403 * reception buffer and not make a copy of it.
9404 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009405 ssl->handshake->sni_name = p + 3;
9406 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009407 if (ssl->conf->f_sni == NULL) {
9408 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009409 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009410 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9411 ssl, p + 3, hostname_len);
9412 if (ret != 0) {
9413 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9414 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9415 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9416 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9417 }
9418 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009419 }
9420
9421 p += hostname_len + 3;
9422 }
9423
Gilles Peskine449bd832023-01-11 14:50:10 +01009424 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009425}
9426#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9427
XiaokangQianacb39922022-06-17 10:18:48 +00009428#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009429MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009430int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9431 const unsigned char *buf,
9432 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009433{
9434 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009435 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009436 const unsigned char *protocol_name_list;
9437 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009438 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009439
9440 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009441 if (ssl->conf->alpn_list == NULL) {
9442 return 0;
9443 }
XiaokangQianacb39922022-06-17 10:18:48 +00009444
9445 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009446 * RFC7301, section 3.1
9447 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009448 *
XiaokangQianc7403452022-06-23 03:24:12 +00009449 * struct {
9450 * ProtocolName protocol_name_list<2..2^16-1>
9451 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009452 */
9453
XiaokangQianc7403452022-06-23 03:24:12 +00009454 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009455 * protocol_name_list_len 2 bytes
9456 * protocol_name_len 1 bytes
9457 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009459 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009460
Gilles Peskine449bd832023-01-11 14:50:10 +01009461 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009462 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009463 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009464 protocol_name_list = p;
9465 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009466
9467 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009468 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009469 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009470 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9471 protocol_name_len);
9472 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009473 MBEDTLS_SSL_PEND_FATAL_ALERT(
9474 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009475 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9476 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009477 }
9478
9479 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009480 }
9481
9482 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009483 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9484 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009485 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009486 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009487 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009488 if (protocol_name_len == alpn_len &&
9489 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009490 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009491 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009492 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009493
9494 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009495 }
9496 }
9497
XiaokangQian95d5f542022-06-24 02:29:26 +00009498 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009499 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009500 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9501 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9502 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009503}
9504
Gilles Peskine449bd832023-01-11 14:50:10 +01009505int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9506 unsigned char *buf,
9507 unsigned char *end,
9508 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009509{
9510 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009511 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009512 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009513
Gilles Peskine449bd832023-01-11 14:50:10 +01009514 if (ssl->alpn_chosen == NULL) {
9515 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009516 }
9517
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 protocol_name_len = strlen(ssl->alpn_chosen);
9519 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009520
Gilles Peskine449bd832023-01-11 14:50:10 +01009521 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009522 /*
9523 * 0 . 1 ext identifier
9524 * 2 . 3 ext length
9525 * 4 . 5 protocol list length
9526 * 6 . 6 protocol name length
9527 * 7 . 7+n protocol name
9528 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009529 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009530
XiaokangQian95d5f542022-06-24 02:29:26 +00009531 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009532
Gilles Peskine449bd832023-01-11 14:50:10 +01009533 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9534 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009535 /* Note: the length of the chosen protocol has been checked to be less
9536 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9537 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009538 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009539
Gilles Peskine449bd832023-01-11 14:50:10 +01009540 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009541
9542#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009543 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009544#endif
9545
Gilles Peskine449bd832023-01-11 14:50:10 +01009546 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009547}
9548#endif /* MBEDTLS_SSL_ALPN */
9549
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009550#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009551 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009552 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009553 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009554int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9555 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009556{
9557 /* Initialize to suppress unnecessary compiler warning */
9558 size_t hostname_len = 0;
9559
9560 /* Check if new hostname is valid before
9561 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009562 if (hostname != NULL) {
9563 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009564
Gilles Peskine449bd832023-01-11 14:50:10 +01009565 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9566 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9567 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009568 }
9569
9570 /* Now it's clear that we will overwrite the old hostname,
9571 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009572 if (session->hostname != NULL) {
9573 mbedtls_platform_zeroize(session->hostname,
9574 strlen(session->hostname));
9575 mbedtls_free(session->hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009576 }
9577
9578 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009579 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009580 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009581 } else {
9582 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9583 if (session->hostname == NULL) {
9584 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9585 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009586
Gilles Peskine449bd832023-01-11 14:50:10 +01009587 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009588 }
9589
Gilles Peskine449bd832023-01-11 14:50:10 +01009590 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009591}
Xiaokang Qian03409292022-10-12 02:49:52 +00009592#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9593 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009594 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009595 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009596
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009597#endif /* MBEDTLS_SSL_TLS_C */