blob: 7a1f85531f72ba57efa0d3573183b423e517d3b3 [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);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100330 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500331
332 *buffer = resized_buffer;
333 *len_old = len_new;
334
335 return 0;
336}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200337
Gilles Peskine449bd832023-01-11 14:50:10 +0100338static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
339 size_t in_buf_new_len,
340 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200341{
342 int modified = 0;
343 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
344 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200346 written_in = ssl->in_msg - ssl->in_buf;
347 iv_offset_in = ssl->in_iv - ssl->in_buf;
348 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200350 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 ssl->in_buf_len < in_buf_new_len) {
352 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
353 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
354 } else {
355 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
356 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200357 modified = 1;
358 }
359 }
360 }
361
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200363 written_out = ssl->out_msg - ssl->out_buf;
364 iv_offset_out = ssl->out_iv - ssl->out_buf;
365 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 ssl->out_buf_len < out_buf_new_len) {
369 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
370 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
371 } else {
372 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
373 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200374 modified = 1;
375 }
376 }
377 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200379 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100380 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200381 /* Fields below might not be properly updated with record
382 * splitting or with CID, so they are manually updated here. */
383 ssl->out_msg = ssl->out_buf + written_out;
384 ssl->out_len = ssl->out_buf + len_offset_out;
385 ssl->out_iv = ssl->out_buf + iv_offset_out;
386
387 ssl->in_msg = ssl->in_buf + written_in;
388 ssl->in_len = ssl->in_buf + len_offset_in;
389 ssl->in_iv = ssl->in_buf + iv_offset_in;
390 }
391}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500392#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
393
Jerry Yudb8c48a2022-01-27 14:54:54 +0800394#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800395
396#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100397typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
398 const char *label,
399 const unsigned char *random, size_t rlen,
400 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800401
Gilles Peskine449bd832023-01-11 14:50:10 +0100402static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800403
404#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
405
406/* Type for the TLS PRF */
407typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
408 const unsigned char *, size_t,
409 unsigned char *, size_t);
410
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200411MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100412static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
413 int ciphersuite,
414 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200415#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200417#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 ssl_tls_prf_t tls_prf,
419 const unsigned char randbytes[64],
420 mbedtls_ssl_protocol_version tls_version,
421 unsigned endpoint,
422 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800423
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100424#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200425MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100426static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300427 const char *label,
428 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100429 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100430static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
431static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100432
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100433#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100434
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100435#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100436MBEDTLS_CHECK_RETURN_CRITICAL
437static int tls_prf_sha384(const unsigned char *secret, size_t slen,
438 const char *label,
439 const unsigned char *random, size_t rlen,
440 unsigned char *dstbuf, size_t dlen);
441
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100442static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
443static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100444#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100445
446static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
447 unsigned char *buf,
448 size_t buf_len);
449
450MBEDTLS_CHECK_RETURN_CRITICAL
451static int ssl_tls12_session_load(mbedtls_ssl_session *session,
452 const unsigned char *buf,
453 size_t len);
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
455
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100456static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100457
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100458#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100459static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100460#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100461
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100462#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100463static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100464#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100465
466int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
467 const unsigned char *secret, size_t slen,
468 const char *label,
469 const unsigned char *random, size_t rlen,
470 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300471{
472 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
473
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300475#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100476#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 case MBEDTLS_SSL_TLS_PRF_SHA384:
478 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100480#endif /* MBEDTLS_MD_CAN_SHA384*/
481#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300482 case MBEDTLS_SSL_TLS_PRF_SHA256:
483 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100485#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300486#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 default:
488 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300489 }
490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300492}
493
Jerry Yuc73c6182022-02-08 20:29:25 +0800494#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100495static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800496{
497#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 if (session->peer_cert != NULL) {
499 mbedtls_x509_crt_free(session->peer_cert);
500 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800501 session->peer_cert = NULL;
502 }
503#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800505 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800507 session->peer_cert_digest = NULL;
508 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
509 session->peer_cert_digest_len = 0;
510 }
511#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
512}
513#endif /* MBEDTLS_X509_CRT_PARSE_C */
514
Gilles Peskine449bd832023-01-11 14:50:10 +0100515uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800516{
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800518 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
584 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800592
593 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800595
Jan Bruckner151f6422023-02-10 12:45:19 +0100596 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
597 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
598
Jerry Yu7a485c12022-10-31 13:08:18 +0800599 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800601
602 }
603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800605}
606
Gilles Peskine449bd832023-01-11 14:50:10 +0100607uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800608{
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800610}
611
Jerry Yud25cab02022-10-31 12:48:30 +0800612#if defined(MBEDTLS_DEBUG_C)
613static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800614 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800615 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
616 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
617 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
618 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
619 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
620 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
621 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
622 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
623 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
624 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
625 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
626 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
627 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
628 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
629 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
630 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
631 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
632 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
633 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
634 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
635 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
636 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
637 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
639 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
640 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100641 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
642 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800643};
644
Gilles Peskine449bd832023-01-11 14:50:10 +0100645static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800646 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
647 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
648 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
649 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
650 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
651 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
652 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
653 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
654 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
655 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
656 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
657 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
658 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
659 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
660 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
661 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
662 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
663 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
664 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
665 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
666 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
667 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
668 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
669 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
670 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
671 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
672 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100673 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
674 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800675};
676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800678{
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return extension_name_table[
680 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800681}
682
Gilles Peskine449bd832023-01-11 14:50:10 +0100683static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800684{
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800690 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800692 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800694 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800696 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800698 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800700 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800702}
703
Gilles Peskine449bd832023-01-11 14:50:10 +0100704void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
705 int level, const char *file, int line,
706 int hs_msg_type, unsigned int extension_type,
707 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800708{
709 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
713 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 ssl_tls13_get_hs_msg_name(hs_msg_type),
715 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800716 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800718 return;
719 }
720
721 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800723 mbedtls_debug_print_msg(
724 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
726 mbedtls_ssl_get_extension_name(extension_type), extension_type,
727 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800728 return;
729 }
730
731 mbedtls_debug_print_msg(
732 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
734 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800735}
736
Gilles Peskine449bd832023-01-11 14:50:10 +0100737void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
738 int level, const char *file, int line,
739 int hs_msg_type, uint32_t extensions_mask,
740 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800741{
742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 for (unsigned i = 0;
744 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
745 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800746 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800747 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800749 }
750}
751
Pengyu Lvee455c02023-01-12 14:37:24 +0800752#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800753static const char *ticket_flag_name_table[] =
754{
755 [0] = "ALLOW_PSK_RESUMPTION",
756 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
757 [3] = "ALLOW_EARLY_DATA",
758};
759
Pengyu Lv4938a562023-01-16 11:28:49 +0800760void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
761 int level, const char *file, int line,
762 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800763{
764 size_t i;
765
766 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 "print ticket_flags (0x%02x)", flags);
768
769 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800770
771 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800772 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800773 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
774 ticket_flag_name_table[i]);
775 }
776 }
777}
778#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
779
Jerry Yud25cab02022-10-31 12:48:30 +0800780#endif /* MBEDTLS_DEBUG_C */
781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
783 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800784{
785 ((void) ciphersuite_info);
786
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100787#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800789 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100792#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800796#endif
797 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800799 return;
800 }
801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100806{
807 unsigned char hs_hdr[4];
808
809 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
811 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
812 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
813 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100815 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100816}
817
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100819 unsigned hs_type,
820 unsigned char const *msg,
821 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100822{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 int ret;
824 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100825 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100826 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100827 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100828 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100829}
830
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100831int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100833#if defined(MBEDTLS_MD_CAN_SHA256) || \
834 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835#if defined(MBEDTLS_USE_PSA_CRYPTO)
836 psa_status_t status;
837#else
838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
839#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100840#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800841 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100842#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100843#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800844#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100845 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
846 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200847 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 }
849 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
850 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200851 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100852 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800853#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100854 mbedtls_md_free(&ssl->handshake->fin_sha256);
855 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100856 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
857 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
858 0);
859 if (ret != 0) {
860 return ret;
861 }
862 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100863 if (ret != 0) {
864 return ret;
865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#endif
867#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100868#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800869#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100870 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
871 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200872 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100873 }
874 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
875 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200876 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100879 mbedtls_md_free(&ssl->handshake->fin_sha384);
880 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100881 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
882 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
883 if (ret != 0) {
884 return ret;
885 }
886 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100887 if (ret != 0) {
888 return ret;
889 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800890#endif
891#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100892 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800893}
894
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100895static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100896 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800897{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256) || \
899 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900#if defined(MBEDTLS_USE_PSA_CRYPTO)
901 psa_status_t status;
902#else
903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
904#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100905#else /* SHA-256 or SHA-384 */
906 ((void) ssl);
907 (void) buf;
908 (void) len;
909#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100910#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800911#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100912 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
913 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200914 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100915 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800916#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100917 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100918 if (ret != 0) {
919 return ret;
920 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800921#endif
922#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100923#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800924#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100925 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
926 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200927 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100928 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800929#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100930 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100931 if (ret != 0) {
932 return ret;
933 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#endif
935#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100936 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800937}
938
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100939#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100940static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100941 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800942{
943#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200944 return mbedtls_md_error_from_psa(psa_hash_update(
945 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800946#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100947 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800948#endif
949}
950#endif
951
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100952#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100953static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100954 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800955{
956#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200957 return mbedtls_md_error_from_psa(psa_hash_update(
958 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800959#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100960 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800961#endif
962}
963#endif
964
Gilles Peskine449bd832023-01-11 14:50:10 +0100965static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200966{
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200968
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100969#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#if defined(MBEDTLS_USE_PSA_CRYPTO)
971 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500972#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100973 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200974#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500975#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100976#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500977#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500978 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500979#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100980 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200981#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500982#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200983
984 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200988#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200989#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200990 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200992#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200993#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200994#if defined(MBEDTLS_USE_PSA_CRYPTO)
995 handshake->psa_pake_ctx = psa_pake_operation_init();
996 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
997#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200999#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02001000#if defined(MBEDTLS_SSL_CLI_C)
1001 handshake->ecjpake_cache = NULL;
1002 handshake->ecjpake_cache_len = 0;
1003#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001004#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001005
Gilles Peskineeccd8882020-03-10 12:19:08 +01001006#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001008#endif
1009
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001010#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1011 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1012#endif
Hanno Becker75173122019-02-06 16:18:31 +00001013
1014#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1015 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001017#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001018}
1019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001021{
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001023
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001024#if defined(MBEDTLS_USE_PSA_CRYPTO)
1025 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1026 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001027#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1029 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001030#endif
1031
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001032#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001033#if defined(MBEDTLS_USE_PSA_CRYPTO)
1034 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1035 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001036#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 mbedtls_md_init(&transform->md_ctx_enc);
1038 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001039#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001040#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041}
1042
Gilles Peskine449bd832023-01-11 14:50:10 +01001043void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001044{
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001046}
1047
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001048MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001049static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001050{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1052
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (ssl->transform_negotiate) {
1056 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1057 }
Jerry Yu2e199812022-12-01 18:57:19 +08001058#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->session_negotiate) {
1060 mbedtls_ssl_session_free(ssl->session_negotiate);
1061 }
1062 if (ssl->handshake) {
1063 mbedtls_ssl_handshake_free(ssl);
1064 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001065
Jerry Yu2e199812022-12-01 18:57:19 +08001066#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001067 /*
1068 * Either the pointers are now NULL or cleared properly and can be freed.
1069 * Now allocate missing structures.
1070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 if (ssl->transform_negotiate == NULL) {
1072 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001073 }
Jerry Yu2e199812022-12-01 18:57:19 +08001074#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001075
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (ssl->session_negotiate == NULL) {
1077 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001078 }
Paul Bakker48916f92012-09-16 19:57:18 +00001079
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 if (ssl->handshake == NULL) {
1081 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001082 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001083#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1084 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1087 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001088#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001089
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001090 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001092#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001093 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001094#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 ssl->session_negotiate == NULL) {
1096 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001097
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001099 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001100
1101#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001103 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001104#endif
1105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001107 ssl->session_negotiate = NULL;
1108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001110 }
1111
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001112 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001113 mbedtls_ssl_session_init(ssl->session_negotiate);
1114 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001115
Jerry Yu2e199812022-12-01 18:57:19 +08001116#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001118#endif
1119
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001120 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001121 ret = mbedtls_ssl_reset_checksum(ssl);
1122 if (ret != 0) {
1123 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1124 return ret;
1125 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001126
Jerry Yud0766ec2022-09-22 10:46:57 +08001127#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1128 defined(MBEDTLS_SSL_SRV_C) && \
1129 defined(MBEDTLS_SSL_SESSION_TICKETS)
1130 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001132#endif
1133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001136 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001137
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001139 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001141 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001143
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001145 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001146#endif
1147
Brett Warrene0edc842021-08-17 09:53:13 +01001148/*
1149 * curve_list is translated to IANA TLS group identifiers here because
1150 * mbedtls_ssl_conf_curves returns void and so can't return
1151 * any error codes.
1152 */
Valerio Setti6f0441d2023-07-03 12:11:36 +02001153#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01001154#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1155 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001157 size_t length;
1158 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1159
Thomas Daubney850a0792023-05-22 12:05:03 +01001160 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 }
Brett Warrene0edc842021-08-17 09:53:13 +01001162
1163 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1165 if (group_list == NULL) {
1166 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1167 }
Brett Warrene0edc842021-08-17 09:53:13 +01001168
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001170 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 curve_list[i]);
1172 if (tls_id == 0) {
1173 mbedtls_free(group_list);
1174 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001175 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001176 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001177 }
1178
1179 group_list[length] = 0;
1180
1181 ssl->handshake->group_list = group_list;
1182 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001184 ssl->handshake->group_list = ssl->conf->group_list;
1185 ssl->handshake->group_list_heap_allocated = 0;
1186 }
1187#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02001188#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01001189
Ronald Crone68ab4f2022-10-05 12:46:29 +02001190#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001191#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001192#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001193 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1194 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1196 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001197 const int *md;
1198 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001199 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001200 uint16_t *p;
1201
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001202 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1203 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1204 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001205
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1207 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001208 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 }
Valerio Setti75fba322023-02-23 17:35:09 +01001210#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001212#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001213
Jerry Yub476a442022-01-21 18:14:45 +08001214#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001216#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1218 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1219 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001220 }
1221
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1223 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1224 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1227 sizeof(uint16_t));
1228 if (ssl->handshake->sig_algs == NULL) {
1229 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1230 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 p = (uint16_t *) ssl->handshake->sig_algs;
1233 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1234 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1235 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001236 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 }
Valerio Setti75fba322023-02-23 17:35:09 +01001238#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001239 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001241#endif
1242#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001244 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001245#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001247 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001248 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001250#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001251 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001252 ssl->handshake->sig_algs_heap_allocated = 0;
1253 }
Jerry Yucc539102022-06-27 16:27:35 +08001254#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001255#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001256 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001257}
1258
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001259#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001260/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001261MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001262static int ssl_cookie_write_dummy(void *ctx,
1263 unsigned char **p, unsigned char *end,
1264 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001265{
1266 ((void) ctx);
1267 ((void) p);
1268 ((void) end);
1269 ((void) cli_id);
1270 ((void) cli_id_len);
1271
Gilles Peskine449bd832023-01-11 14:50:10 +01001272 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001273}
1274
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001275MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001276static int ssl_cookie_check_dummy(void *ctx,
1277 const unsigned char *cookie, size_t cookie_len,
1278 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001279{
1280 ((void) ctx);
1281 ((void) cookie);
1282 ((void) cookie_len);
1283 ((void) cli_id);
1284 ((void) cli_id_len);
1285
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001287}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001288#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001289
Paul Bakker5121ce52009-01-03 21:22:43 +00001290/*
1291 * Initialize an SSL context
1292 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001293void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001294{
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001296}
1297
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001298MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001299static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001300{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001301 const mbedtls_ssl_config *conf = ssl->conf;
1302
Ronald Cron6f135e12021-12-08 16:57:54 +01001303#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1305 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1306 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1307 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001308 }
1309
Gilles Peskine449bd832023-01-11 14:50:10 +01001310 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1311 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001312 }
1313#endif
1314
1315#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1317 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1318 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001319 }
1320#endif
1321
Ronald Cron6f135e12021-12-08 16:57:54 +01001322#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1324 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1325 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1326 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001327 }
1328
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1330 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001331 }
1332#endif
1333
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1335 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001336}
1337
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001338MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001339static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1340{
1341 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 ret = ssl_conf_version_check(ssl);
1343 if (ret != 0) {
1344 return ret;
1345 }
Jerry Yu60835a82021-08-04 10:13:52 +08001346
Jerry Yudef7ae42022-10-30 14:13:19 +08001347#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1348 /* RFC 8446 section 4.4.3
1349 *
1350 * If the verification fails, the receiver MUST terminate the handshake with
1351 * a "decrypt_error" alert.
1352 *
1353 * If the client is configured as TLS 1.3 only with optional verify, return
1354 * bad config.
1355 *
1356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1358 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001359 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1360 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1361 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001363 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 1, ("Optional verify auth mode "
1365 "is not available for TLS 1.3 client"));
1366 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001367 }
1368#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1369
Jerry Yu60835a82021-08-04 10:13:52 +08001370 /* Space for further checks */
1371
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001373}
1374
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001375/*
1376 * Setup an SSL context
1377 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001378
Gilles Peskine449bd832023-01-11 14:50:10 +01001379int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1380 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001381{
Janos Follath865b3eb2019-12-16 11:46:15 +00001382 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001383 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1384 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001385
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001386 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001387
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 if ((ret = ssl_conf_check(ssl)) != 0) {
1389 return ret;
1390 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001391 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001392
Paul Bakker62f2dee2012-09-28 07:31:51 +00001393 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001394 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001395 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001396
1397 /* Set to NULL in case of an error condition */
1398 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001399
Darryl Greenb33cc762019-11-28 14:29:44 +00001400#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1401 ssl->in_buf_len = in_buf_len;
1402#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1404 if (ssl->in_buf == NULL) {
1405 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001406 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001407 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001408 }
1409
Darryl Greenb33cc762019-11-28 14:29:44 +00001410#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1411 ssl->out_buf_len = out_buf_len;
1412#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1414 if (ssl->out_buf == NULL) {
1415 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001416 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001417 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001418 }
1419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001421
Johan Pascalb62bb512015-12-03 21:56:45 +01001422#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001424#endif
1425
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001427 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001431
1432error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 mbedtls_free(ssl->in_buf);
1434 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001435
1436 ssl->conf = NULL;
1437
Darryl Greenb33cc762019-11-28 14:29:44 +00001438#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1439 ssl->in_buf_len = 0;
1440 ssl->out_buf_len = 0;
1441#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001442 ssl->in_buf = NULL;
1443 ssl->out_buf = NULL;
1444
1445 ssl->in_hdr = NULL;
1446 ssl->in_ctr = NULL;
1447 ssl->in_len = NULL;
1448 ssl->in_iv = NULL;
1449 ssl->in_msg = NULL;
1450
1451 ssl->out_hdr = NULL;
1452 ssl->out_ctr = NULL;
1453 ssl->out_len = NULL;
1454 ssl->out_iv = NULL;
1455 ssl->out_msg = NULL;
1456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001458}
1459
1460/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001461 * Reset an initialized and used SSL context for re-use while retaining
1462 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001463 *
1464 * If partial is non-zero, keep data in the input buffer and client ID.
1465 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001466 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001467void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1468 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001469{
Darryl Greenb33cc762019-11-28 14:29:44 +00001470#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1471 size_t in_buf_len = ssl->in_buf_len;
1472 size_t out_buf_len = ssl->out_buf_len;
1473#else
1474 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1475 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1476#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001477
Hanno Beckerb0302c42021-08-03 09:39:42 +01001478#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1479 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001480#endif
1481
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001482 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001484
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001486
1487 /* Reset incoming message parsing */
1488 ssl->in_offt = NULL;
1489 ssl->nb_zero = 0;
1490 ssl->in_msgtype = 0;
1491 ssl->in_msglen = 0;
1492 ssl->in_hslen = 0;
1493 ssl->keep_current_message = 0;
1494 ssl->transform_in = NULL;
1495
1496#if defined(MBEDTLS_SSL_PROTO_DTLS)
1497 ssl->next_record_offset = 0;
1498 ssl->in_epoch = 0;
1499#endif
1500
1501 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001505 }
1506
Ronald Cronad8c17b2022-06-10 17:18:09 +02001507 ssl->send_alert = 0;
1508
Hanno Beckerb0302c42021-08-03 09:39:42 +01001509 /* Reset outgoing message writing */
1510 ssl->out_msgtype = 0;
1511 ssl->out_msglen = 0;
1512 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 memset(ssl->out_buf, 0, out_buf_len);
1514 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001515 ssl->transform_out = NULL;
1516
1517#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001519#endif
1520
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 if (ssl->transform) {
1523 mbedtls_ssl_transform_free(ssl->transform);
1524 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001525 ssl->transform = NULL;
1526 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001527#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1528
XiaokangQian2b01dc32022-01-21 02:53:13 +00001529#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 mbedtls_ssl_transform_free(ssl->transform_application);
1531 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532 ssl->transform_application = NULL;
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001535#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1537 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001538 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001539#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1542 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001543 ssl->handshake->transform_handshake = NULL;
1544 }
1545
XiaokangQian2b01dc32022-01-21 02:53:13 +00001546#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001547}
1548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001550{
1551 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1552
1553 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1554
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001556
1557 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558#if defined(MBEDTLS_SSL_RENEGOTIATION)
1559 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001560 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001561
1562 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1564 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001565#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001567
Hanno Beckerb0302c42021-08-03 09:39:42 +01001568 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001569 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 if (ssl->session) {
1571 mbedtls_ssl_session_free(ssl->session);
1572 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001573 ssl->session = NULL;
1574 }
1575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001577 ssl->alpn_chosen = NULL;
1578#endif
1579
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001580#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001581 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001582#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001584#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 if (free_cli_id) {
1586 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001587 ssl->cli_id = NULL;
1588 ssl->cli_id_len = 0;
1589 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001590#endif
1591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 if ((ret = ssl_handshake_init(ssl)) != 0) {
1593 return ret;
1594 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001597}
1598
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001599/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001600 * Reset an initialized and used SSL context for re-use while retaining
1601 * all application-set variables, function pointers and data.
1602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001603int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001604{
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001606}
1607
1608/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001609 * SSL set accessors
1610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001611void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001612{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001613 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001614}
1615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001619}
1620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001622void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001623{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001624 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001625}
1626#endif
1627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001629{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001630 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001631}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001633#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001634
Gilles Peskine449bd832023-01-11 14:50:10 +01001635void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1636 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001637{
1638 ssl->disable_datagram_packing = !allow_packing;
1639}
1640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1642 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001643{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001644 conf->hs_timeout_min = min;
1645 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001646}
1647#endif
1648
Gilles Peskine449bd832023-01-11 14:50:10 +01001649void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001650{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001651 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001652}
1653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001655void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1656 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1657 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001658{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001659 conf->f_vrfy = f_vrfy;
1660 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001661}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001663
Gilles Peskine449bd832023-01-11 14:50:10 +01001664void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1665 int (*f_rng)(void *, unsigned char *, size_t),
1666 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001667{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001668 conf->f_rng = f_rng;
1669 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001670}
1671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1673 void (*f_dbg)(void *, int, const char *, int, const char *),
1674 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001675{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001676 conf->f_dbg = f_dbg;
1677 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001678}
1679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1681 void *p_bio,
1682 mbedtls_ssl_send_t *f_send,
1683 mbedtls_ssl_recv_t *f_recv,
1684 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001685{
1686 ssl->p_bio = p_bio;
1687 ssl->f_send = f_send;
1688 ssl->f_recv = f_recv;
1689 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001690}
1691
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001692#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001693void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001694{
1695 ssl->mtu = mtu;
1696}
1697#endif
1698
Gilles Peskine449bd832023-01-11 14:50:10 +01001699void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001700{
1701 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001702}
1703
Gilles Peskine449bd832023-01-11 14:50:10 +01001704void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1705 void *p_timer,
1706 mbedtls_ssl_set_timer_t *f_set_timer,
1707 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001708{
1709 ssl->p_timer = p_timer;
1710 ssl->f_set_timer = f_set_timer;
1711 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001712
1713 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001715}
1716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001718void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1719 void *p_cache,
1720 mbedtls_ssl_cache_get_t *f_get_cache,
1721 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001722{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001723 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001724 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001725 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001726}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001730int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001731{
Janos Follath865b3eb2019-12-16 11:46:15 +00001732 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001735 session == NULL ||
1736 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1738 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001739 }
1740
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 if (ssl->handshake->resume == 1) {
1742 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1743 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001744
Jerry Yu21092062022-10-10 21:21:31 +08001745#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001747 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001751 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1753 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1754 session->ciphersuite));
1755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001756 }
Jerry Yu40afab62022-10-08 10:42:13 +08001757 }
Jerry Yu21092062022-10-10 21:21:31 +08001758#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1761 session)) != 0) {
1762 return ret;
1763 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001764
Paul Bakker0a597072012-09-25 21:55:46 +00001765 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001768}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1772 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001773{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001774 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001775}
1776
Ronald Cron6f135e12021-12-08 16:57:54 +01001777#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001778void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1779 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001780{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001781 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001782}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001783
1784#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001785void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
1786 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787{
1788 conf->early_data_enabled = early_data_enabled;
1789}
Jerry Yucc4e0072022-11-22 17:22:22 +08001790
1791#if defined(MBEDTLS_SSL_SRV_C)
1792void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001794{
Jerry Yu39da9852022-12-06 16:58:36 +08001795 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001796}
1797#endif /* MBEDTLS_SSL_SRV_C */
1798
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001799#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001800#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001803void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1804 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001805{
1806 conf->cert_profile = profile;
1807}
1808
Gilles Peskine449bd832023-01-11 14:50:10 +01001809static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001810{
1811 mbedtls_ssl_key_cert *cur = key_cert, *next;
1812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001814 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001816 cur = next;
1817 }
1818}
1819
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001820/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001821MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001822static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1823 mbedtls_x509_crt *cert,
1824 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001825{
niisato8ee24222018-06-25 19:05:48 +09001826 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001829 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001831 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001833 }
1834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1836 if (new_cert == NULL) {
1837 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1838 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001839
niisato8ee24222018-06-25 19:05:48 +09001840 new_cert->cert = cert;
1841 new_cert->key = key;
1842 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001843
Glenn Strauss36872db2022-01-22 05:06:31 -05001844 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001846 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001848 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 }
niisato8ee24222018-06-25 19:05:48 +09001852 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001853 }
1854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001856}
1857
Gilles Peskine449bd832023-01-11 14:50:10 +01001858int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001859 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001861{
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001863}
1864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001866 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001868{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001869 conf->ca_chain = ca_chain;
1870 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001871
1872#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1873 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1874 * cannot be used together. */
1875 conf->f_ca_cb = NULL;
1876 conf->p_ca_cb = NULL;
1877#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001878}
Hanno Becker5adaad92019-03-27 16:54:37 +00001879
1880#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001881void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1882 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1883 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001884{
1885 conf->f_ca_cb = f_ca_cb;
1886 conf->p_ca_cb = p_ca_cb;
1887
1888 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1889 * cannot be used together. */
1890 conf->ca_chain = NULL;
1891 conf->ca_crl = NULL;
1892}
1893#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001895
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001896#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001897const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1898 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001899{
1900 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001902}
1903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1905 mbedtls_x509_crt *own_cert,
1906 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001907{
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1909 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001910}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1913 mbedtls_x509_crt *ca_chain,
1914 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001915{
1916 ssl->handshake->sni_ca_chain = ca_chain;
1917 ssl->handshake->sni_ca_crl = ca_crl;
1918}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001919
Glenn Strauss999ef702022-03-11 01:37:23 -05001920#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001921void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1922 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001923{
1924 ssl->handshake->dn_hints = crt;
1925}
1926#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1927
Gilles Peskine449bd832023-01-11 14:50:10 +01001928void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1929 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001930{
1931 ssl->handshake->sni_authmode = authmode;
1932}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001933#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1934
Hanno Becker8927c832019-04-03 12:52:50 +01001935#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001936void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1937 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1938 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001939{
1940 ssl->f_vrfy = f_vrfy;
1941 ssl->p_vrfy = p_vrfy;
1942}
1943#endif
1944
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001945#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001946
Valerio Setti016f6822022-12-09 14:17:50 +01001947#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001948static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1949static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1950
Valerio Setti016f6822022-12-09 14:17:50 +01001951static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 mbedtls_ssl_context *ssl,
1953 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001954{
1955 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001956 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001957 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001958 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001959 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001960 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1962 psa_pake_cs_set_primitive(&cipher_suite,
1963 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1964 PSA_ECC_FAMILY_SECP_R1,
1965 256));
1966 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1969 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001970 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001972
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001974 user = jpake_server_id;
1975 user_len = sizeof(jpake_server_id);
1976 peer = jpake_client_id;
1977 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001979 user = jpake_client_id;
1980 user_len = sizeof(jpake_client_id);
1981 peer = jpake_server_id;
1982 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001984
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001985 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1986 if (status != PSA_SUCCESS) {
1987 return status;
1988 }
1989
1990 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001992 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 }
Valerio Setti016f6822022-12-09 14:17:50 +01001994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1996 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001997 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 }
Valerio Setti016f6822022-12-09 14:17:50 +01001999
2000 ssl->handshake->psa_pake_ctx_is_ok = 1;
2001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002003}
2004
Gilles Peskine449bd832023-01-11 14:50:10 +01002005int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2006 const unsigned char *pw,
2007 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002008{
2009 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2010 psa_status_t status;
2011
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 if (ssl->handshake == NULL || ssl->conf == NULL) {
2013 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002014 }
2015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 /* Empty password is not valid */
2017 if ((pw == NULL) || (pw_len == 0)) {
2018 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2019 }
2020
2021 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2022 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2023 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2024
2025 status = psa_import_key(&attributes, pw, pw_len,
2026 &ssl->handshake->psa_pake_password);
2027 if (status != PSA_SUCCESS) {
2028 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2029 }
2030
2031 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2032 ssl->handshake->psa_pake_password);
2033 if (status != PSA_SUCCESS) {
2034 psa_destroy_key(ssl->handshake->psa_pake_password);
2035 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2036 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2037 }
2038
2039 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002040}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2043 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002044{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002045 psa_status_t status;
2046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 if (ssl->handshake == NULL || ssl->conf == NULL) {
2048 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002049 }
2050
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 if (mbedtls_svc_key_id_is_null(pwd)) {
2052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2053 }
2054
2055 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2056 if (status != PSA_SUCCESS) {
2057 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2058 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2059 }
2060
2061 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002062}
2063#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002064int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2065 const unsigned char *pw,
2066 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002067{
2068 mbedtls_ecjpake_role role;
2069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 if (ssl->handshake == NULL || ssl->conf == NULL) {
2071 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2072 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002073
Valerio Settic689ed82022-12-07 14:40:38 +01002074 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 if ((pw == NULL) || (pw_len == 0)) {
2076 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2077 }
Valerio Settic689ed82022-12-07 14:40:38 +01002078
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002080 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002082 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2086 role,
2087 MBEDTLS_MD_SHA256,
2088 MBEDTLS_ECP_DP_SECP256R1,
2089 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002090}
Valerio Setti02c25b52022-11-15 14:08:42 +01002091#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002092#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002093
Ronald Cron73fe8df2022-10-05 14:31:43 +02002094#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002095int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002096{
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (conf->psk_identity == NULL ||
2098 conf->psk_identity_len == 0) {
2099 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002100 }
2101
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002102#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2104 return 1;
2105 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002106#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (conf->psk != NULL && conf->psk_len != 0) {
2109 return 1;
2110 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002113}
2114
Gilles Peskine449bd832023-01-11 14:50:10 +01002115static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002116{
2117 /* Remove reference to existing PSK, if any. */
2118#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002120 /* The maintenance of the PSK key slot is the
2121 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002122 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002123 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002124#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002126 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002127 conf->psk = NULL;
2128 conf->psk_len = 0;
2129 }
2130
2131 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 if (conf->psk_identity != NULL) {
2133 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002134 conf->psk_identity = NULL;
2135 conf->psk_identity_len = 0;
2136 }
2137}
2138
Hanno Becker7390c712018-11-15 13:33:04 +00002139/* This function assumes that PSK identity in the SSL config is unset.
2140 * It checks that the provided identity is well-formed and attempts
2141 * to make a copy of it in the SSL config.
2142 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002143MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002144static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2145 unsigned char const *psk_identity,
2146 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002147{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002148 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002150 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 (psk_identity_len >> 16) != 0 ||
2152 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2153 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002154 }
2155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2157 if (conf->psk_identity == NULL) {
2158 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2159 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002160
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002161 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002163
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002165}
2166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2168 const unsigned char *psk, size_t psk_len,
2169 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002170{
Janos Follath865b3eb2019-12-16 11:46:15 +00002171 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002172
2173 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2175 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2176 }
Hanno Becker7390c712018-11-15 13:33:04 +00002177
2178 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 if (psk == NULL) {
2180 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2181 }
2182 if (psk_len == 0) {
2183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2184 }
2185 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2186 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2187 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2190 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2191 }
Hanno Becker7390c712018-11-15 13:33:04 +00002192 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002194
2195 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2197 if (ret != 0) {
2198 ssl_conf_remove_psk(conf);
2199 }
Hanno Becker7390c712018-11-15 13:33:04 +00002200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002202}
2203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002205{
2206#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002208 /* The maintenance of the external PSK key slot is the
2209 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 if (ssl->handshake->psk_opaque_is_internal) {
2211 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002212 ssl->handshake->psk_opaque_is_internal = 0;
2213 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002214 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002215 }
Neil Armstronge952a302022-05-03 10:22:14 +02002216#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002218 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002220 ssl->handshake->psk_len = 0;
2221 }
Neil Armstronge952a302022-05-03 10:22:14 +02002222#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002223}
2224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2226 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002227{
Neil Armstrong501c9322022-05-03 09:35:09 +02002228#if defined(MBEDTLS_USE_PSA_CRYPTO)
2229 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002230 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002231 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002232 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002233#endif /* MBEDTLS_USE_PSA_CRYPTO */
2234
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (psk == NULL || ssl->handshake == NULL) {
2236 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2237 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
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 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002244
Neil Armstrong501c9322022-05-03 09:35:09 +02002245#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002246#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2248 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2249 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2250 } else {
2251 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2252 }
2253 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002254 }
2255#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002256
Jerry Yu568ec252022-07-22 21:27:34 +08002257#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2259 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2260 psa_set_key_usage_flags(&key_attributes,
2261 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002262 }
2263#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 psa_set_key_algorithm(&key_attributes, alg);
2266 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2269 if (status != PSA_SUCCESS) {
2270 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2271 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002272
2273 /* Allow calling psa_destroy_key() on psk remove */
2274 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002276#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2278 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2279 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002280
2281 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002285#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002286}
2287
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002288#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002289int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2290 mbedtls_svc_key_id_t psk,
2291 const unsigned char *psk_identity,
2292 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002293{
Janos Follath865b3eb2019-12-16 11:46:15 +00002294 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002295
2296 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2298 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2299 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002300
Hanno Becker7390c712018-11-15 13:33:04 +00002301 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 if (mbedtls_svc_key_id_is_null(psk)) {
2303 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2304 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002305 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002306
2307 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2309 psk_identity_len);
2310 if (ret != 0) {
2311 ssl_conf_remove_psk(conf);
2312 }
Hanno Becker7390c712018-11-15 13:33:04 +00002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002315}
2316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2318 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002319{
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 if ((mbedtls_svc_key_id_is_null(psk)) ||
2321 (ssl->handshake == NULL)) {
2322 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2323 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002326 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002328}
2329#endif /* MBEDTLS_USE_PSA_CRYPTO */
2330
Jerry Yu8897c072022-08-12 13:56:53 +08002331#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002332void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2333 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2334 size_t),
2335 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002336{
2337 conf->f_psk = f_psk;
2338 conf->p_psk = p_psk;
2339}
Jerry Yu8897c072022-08-12 13:56:53 +08002340#endif /* MBEDTLS_SSL_SRV_C */
2341
Ronald Cron73fe8df2022-10-05 14:31:43 +02002342#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002343
2344#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002345static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002347{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002348#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 if (alg == PSA_ALG_CBC_NO_PADDING) {
2350 return MBEDTLS_SSL_MODE_CBC;
2351 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002352#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (PSA_ALG_IS_AEAD(alg)) {
2354 return MBEDTLS_SSL_MODE_AEAD;
2355 }
2356 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002357}
2358
2359#else /* MBEDTLS_USE_PSA_CRYPTO */
2360
2361static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002363{
2364#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 if (mode == MBEDTLS_MODE_CBC) {
2366 return MBEDTLS_SSL_MODE_CBC;
2367 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002368#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2369
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002370#if defined(MBEDTLS_GCM_C) || \
2371 defined(MBEDTLS_CCM_C) || \
2372 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002374 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 mode == MBEDTLS_MODE_CHACHAPOLY) {
2376 return MBEDTLS_SSL_MODE_AEAD;
2377 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002378#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002379
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381}
Gilles Peskine301711e2022-04-26 16:57:05 +02002382#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002383
Gilles Peskinee108d982022-04-26 16:50:40 +02002384static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2385 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002387{
2388#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2390 base_mode == MBEDTLS_SSL_MODE_CBC) {
2391 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002392 }
2393#else
2394 (void) encrypt_then_mac;
2395#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002397}
2398
Neil Armstrongab555e02022-04-04 11:07:59 +02002399mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002401{
Gilles Peskinee108d982022-04-26 16:50:40 +02002402 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002405#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002407#endif
2408 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002409
Gilles Peskinee108d982022-04-26 16:50:40 +02002410 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002411#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002412 encrypt_then_mac = transform->encrypt_then_mac;
2413#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002415}
2416
Neil Armstrongab555e02022-04-04 11:07:59 +02002417mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002418#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002420#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002422{
Gilles Peskinee108d982022-04-26 16:50:40 +02002423 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2424
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002425#if defined(MBEDTLS_USE_PSA_CRYPTO)
2426 psa_status_t status;
2427 psa_algorithm_t alg;
2428 psa_key_type_t type;
2429 size_t size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 status = mbedtls_ssl_cipher_to_psa(suite->cipher, 0, &alg, &type, &size);
2431 if (status == PSA_SUCCESS) {
2432 base_mode = mbedtls_ssl_get_base_mode(alg);
2433 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002434#else
2435 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002436 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002438 base_mode =
2439 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002441 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002442#endif /* MBEDTLS_USE_PSA_CRYPTO */
2443
Gilles Peskinee108d982022-04-26 16:50:40 +02002444#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2445 int encrypt_then_mac = 0;
2446#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002448}
2449
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002450#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002451
2452#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002453/* Serialization of TLS 1.3 sessions:
2454 *
2455 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002456 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002457 * uint64 ticket_received;
2458 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002459 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002460 * } ClientOnlyData;
2461 *
2462 * struct {
2463 * uint8 endpoint;
2464 * uint8 ciphersuite[2];
2465 * uint32 ticket_age_add;
2466 * uint8 ticket_flags;
2467 * opaque resumption_key<0..255>;
2468 * select ( endpoint ) {
2469 * case client: ClientOnlyData;
2470 * case server: uint64 start_time;
2471 * };
2472 * } serialized_session_tls13;
2473 *
2474 */
2475#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002476MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002477static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2478 unsigned char *buf,
2479 size_t buf_len,
2480 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002481{
2482 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002483#if defined(MBEDTLS_SSL_CLI_C) && \
2484 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 size_t hostname_len = (session->hostname == NULL) ?
2486 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002487#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002488 size_t needed = 1 /* endpoint */
2489 + 2 /* ciphersuite */
2490 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002491 + 1 /* ticket_flags */
2492 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002493 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002494
Gilles Peskine449bd832023-01-11 14:50:10 +01002495 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2496 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2497 }
Jerry Yu34191072022-08-18 10:32:09 +08002498 needed += session->resumption_key_len; /* resumption_key */
2499
Jerry Yu438ddd82022-07-07 06:55:50 +00002500#if defined(MBEDTLS_HAVE_TIME)
2501 needed += 8; /* start_time or ticket_received */
2502#endif
2503
2504#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002506#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002507 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002509#endif
2510
Jerry Yu438ddd82022-07-07 06:55:50 +00002511 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002512 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002513
2514 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 if (session->ticket_len > SIZE_MAX - needed) {
2516 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2517 }
Jerry Yu34191072022-08-18 10:32:09 +08002518
Jerry Yue28d9742022-08-18 15:44:03 +08002519 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002520 }
2521#endif /* MBEDTLS_SSL_CLI_C */
2522
Jerry Yue36fdd62022-08-17 21:31:36 +08002523 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 if (needed > buf_len) {
2525 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2526 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002527
2528 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2530 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002531 p[7] = session->ticket_flags;
2532
2533 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002534 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002535 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002537 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002538
2539#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2541 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002542 p += 8;
2543 }
2544#endif /* MBEDTLS_HAVE_TIME */
2545
2546#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002548#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002550 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002552 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002554 p += hostname_len;
2555 }
2556#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2557
Jerry Yu438ddd82022-07-07 06:55:50 +00002558#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002560 p += 8;
2561#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002563 p += 4;
2564
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002566 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 if (session->ticket != NULL && session->ticket_len > 0) {
2569 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002570 p += session->ticket_len;
2571 }
2572 }
2573#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002575}
2576
2577MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002578static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2579 const unsigned char *buf,
2580 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002581{
2582 const unsigned char *p = buf;
2583 const unsigned char *end = buf + len;
2584
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 if (end - p < 9) {
2586 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2587 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002588 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2590 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002591 session->ticket_flags = p[7];
2592
2593 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002594 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002595 p += 9;
2596
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 if (end - p < session->resumption_key_len) {
2598 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2599 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2602 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2603 }
2604 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002605 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002606
2607#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2609 if (end - p < 8) {
2610 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2611 }
2612 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002613 p += 8;
2614 }
2615#endif /* MBEDTLS_HAVE_TIME */
2616
2617#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002619#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002620 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002621 size_t hostname_len;
2622 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 if (end - p < 2) {
2624 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2625 }
2626 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002627 p += 2;
2628
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 if (end - p < (long int) hostname_len) {
2630 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2631 }
2632 if (hostname_len > 0) {
2633 session->hostname = mbedtls_calloc(1, hostname_len);
2634 if (session->hostname == NULL) {
2635 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2636 }
2637 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002638 p += hostname_len;
2639 }
2640#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2641 MBEDTLS_SSL_SESSION_TICKETS */
2642
Jerry Yu438ddd82022-07-07 06:55:50 +00002643#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 if (end - p < 8) {
2645 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2646 }
2647 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002648 p += 8;
2649#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 if (end - p < 4) {
2651 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2652 }
2653 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002654 p += 4;
2655
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 if (end - p < 2) {
2657 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2658 }
2659 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002660 p += 2;
2661
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 if (end - p < (long int) session->ticket_len) {
2663 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2664 }
2665 if (session->ticket_len > 0) {
2666 session->ticket = mbedtls_calloc(1, session->ticket_len);
2667 if (session->ticket == NULL) {
2668 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2669 }
2670 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002671 p += session->ticket_len;
2672 }
2673 }
2674#endif /* MBEDTLS_SSL_CLI_C */
2675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002677
2678}
2679#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002680MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002681static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2682 unsigned char *buf,
2683 size_t buf_len,
2684 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002685{
2686 ((void) session);
2687 ((void) buf);
2688 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002689 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002691}
Jerry Yu438ddd82022-07-07 06:55:50 +00002692
Gilles Peskine449bd832023-01-11 14:50:10 +01002693static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2694 unsigned char *buf,
2695 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002696{
2697 ((void) session);
2698 ((void) buf);
2699 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002701}
2702#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002703#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2706 size_t taglen,
2707 psa_algorithm_t *alg,
2708 psa_key_type_t *key_type,
2709 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002710{
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002712 case MBEDTLS_CIPHER_AES_128_CBC:
2713 *alg = PSA_ALG_CBC_NO_PADDING;
2714 *key_type = PSA_KEY_TYPE_AES;
2715 *key_size = 128;
2716 break;
2717 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002719 *key_type = PSA_KEY_TYPE_AES;
2720 *key_size = 128;
2721 break;
2722 case MBEDTLS_CIPHER_AES_128_GCM:
2723 *alg = PSA_ALG_GCM;
2724 *key_type = PSA_KEY_TYPE_AES;
2725 *key_size = 128;
2726 break;
2727 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002729 *key_type = PSA_KEY_TYPE_AES;
2730 *key_size = 192;
2731 break;
2732 case MBEDTLS_CIPHER_AES_192_GCM:
2733 *alg = PSA_ALG_GCM;
2734 *key_type = PSA_KEY_TYPE_AES;
2735 *key_size = 192;
2736 break;
2737 case MBEDTLS_CIPHER_AES_256_CBC:
2738 *alg = PSA_ALG_CBC_NO_PADDING;
2739 *key_type = PSA_KEY_TYPE_AES;
2740 *key_size = 256;
2741 break;
2742 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002744 *key_type = PSA_KEY_TYPE_AES;
2745 *key_size = 256;
2746 break;
2747 case MBEDTLS_CIPHER_AES_256_GCM:
2748 *alg = PSA_ALG_GCM;
2749 *key_type = PSA_KEY_TYPE_AES;
2750 *key_size = 256;
2751 break;
2752 case MBEDTLS_CIPHER_ARIA_128_CBC:
2753 *alg = PSA_ALG_CBC_NO_PADDING;
2754 *key_type = PSA_KEY_TYPE_ARIA;
2755 *key_size = 128;
2756 break;
2757 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002759 *key_type = PSA_KEY_TYPE_ARIA;
2760 *key_size = 128;
2761 break;
2762 case MBEDTLS_CIPHER_ARIA_128_GCM:
2763 *alg = PSA_ALG_GCM;
2764 *key_type = PSA_KEY_TYPE_ARIA;
2765 *key_size = 128;
2766 break;
2767 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002768 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002769 *key_type = PSA_KEY_TYPE_ARIA;
2770 *key_size = 192;
2771 break;
2772 case MBEDTLS_CIPHER_ARIA_192_GCM:
2773 *alg = PSA_ALG_GCM;
2774 *key_type = PSA_KEY_TYPE_ARIA;
2775 *key_size = 192;
2776 break;
2777 case MBEDTLS_CIPHER_ARIA_256_CBC:
2778 *alg = PSA_ALG_CBC_NO_PADDING;
2779 *key_type = PSA_KEY_TYPE_ARIA;
2780 *key_size = 256;
2781 break;
2782 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002784 *key_type = PSA_KEY_TYPE_ARIA;
2785 *key_size = 256;
2786 break;
2787 case MBEDTLS_CIPHER_ARIA_256_GCM:
2788 *alg = PSA_ALG_GCM;
2789 *key_type = PSA_KEY_TYPE_ARIA;
2790 *key_size = 256;
2791 break;
2792 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2793 *alg = PSA_ALG_CBC_NO_PADDING;
2794 *key_type = PSA_KEY_TYPE_CAMELLIA;
2795 *key_size = 128;
2796 break;
2797 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002799 *key_type = PSA_KEY_TYPE_CAMELLIA;
2800 *key_size = 128;
2801 break;
2802 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2803 *alg = PSA_ALG_GCM;
2804 *key_type = PSA_KEY_TYPE_CAMELLIA;
2805 *key_size = 128;
2806 break;
2807 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002809 *key_type = PSA_KEY_TYPE_CAMELLIA;
2810 *key_size = 192;
2811 break;
2812 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2813 *alg = PSA_ALG_GCM;
2814 *key_type = PSA_KEY_TYPE_CAMELLIA;
2815 *key_size = 192;
2816 break;
2817 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2818 *alg = PSA_ALG_CBC_NO_PADDING;
2819 *key_type = PSA_KEY_TYPE_CAMELLIA;
2820 *key_size = 256;
2821 break;
2822 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002824 *key_type = PSA_KEY_TYPE_CAMELLIA;
2825 *key_size = 256;
2826 break;
2827 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2828 *alg = PSA_ALG_GCM;
2829 *key_type = PSA_KEY_TYPE_CAMELLIA;
2830 *key_size = 256;
2831 break;
2832 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2833 *alg = PSA_ALG_CHACHA20_POLY1305;
2834 *key_type = PSA_KEY_TYPE_CHACHA20;
2835 *key_size = 256;
2836 break;
2837 case MBEDTLS_CIPHER_NULL:
2838 *alg = MBEDTLS_SSL_NULL_CIPHER;
2839 *key_type = 0;
2840 *key_size = 0;
2841 break;
2842 default:
2843 return PSA_ERROR_NOT_SUPPORTED;
2844 }
2845
2846 return PSA_SUCCESS;
2847}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002848#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002849
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002850#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002851int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2852 const unsigned char *dhm_P, size_t P_len,
2853 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002854{
Janos Follath865b3eb2019-12-16 11:46:15 +00002855 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002856
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 mbedtls_mpi_free(&conf->dhm_P);
2858 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2861 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2862 mbedtls_mpi_free(&conf->dhm_P);
2863 mbedtls_mpi_free(&conf->dhm_G);
2864 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002865 }
2866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002868}
Paul Bakker5121ce52009-01-03 21:22:43 +00002869
Gilles Peskine449bd832023-01-11 14:50:10 +01002870int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002871{
Janos Follath865b3eb2019-12-16 11:46:15 +00002872 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 mbedtls_mpi_free(&conf->dhm_P);
2875 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2878 &conf->dhm_P)) != 0 ||
2879 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2880 &conf->dhm_G)) != 0) {
2881 mbedtls_mpi_free(&conf->dhm_P);
2882 mbedtls_mpi_free(&conf->dhm_G);
2883 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002884 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002885
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002887}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002888#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002889
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002890#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2891/*
2892 * Set the minimum length for Diffie-Hellman parameters
2893 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002894void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2895 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002896{
2897 conf->dhm_min_bitlen = bitlen;
2898}
2899#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2900
Ronald Crone68ab4f2022-10-05 12:46:29 +02002901#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002902#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002903/*
2904 * Set allowed/preferred hashes for handshake signatures
2905 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002906void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2907 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002908{
2909 conf->sig_hashes = hashes;
2910}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002911#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002912
Jerry Yuf017ee42022-01-12 15:49:48 +08002913/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002914void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2915 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002916{
Jerry Yuf017ee42022-01-12 15:49:48 +08002917#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2918 conf->sig_hashes = NULL;
2919#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2920 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002921}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002922#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002923
Valerio Setti6f0441d2023-07-03 12:11:36 +02002924#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01002925#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002926/*
2927 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002928 *
2929 * mbedtls_ssl_setup() takes the provided list
2930 * and translates it to a list of IANA TLS group identifiers,
2931 * stored in ssl->handshake->group_list.
2932 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002933 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002934void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2935 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002936{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002937 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002938 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002939}
Brett Warrene0edc842021-08-17 09:53:13 +01002940#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02002941#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002942
Brett Warrene0edc842021-08-17 09:53:13 +01002943/*
2944 * Set the allowed groups
2945 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002946void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2947 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002948{
Valerio Setti6f0441d2023-07-03 12:11:36 +02002949#if defined(MBEDTLS_PK_HAVE_ECC_KEYS) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002950 conf->curve_list = NULL;
2951#endif
2952 conf->group_list = group_list;
2953}
2954
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002955#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002956int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002957{
Hanno Becker947194e2017-04-07 13:25:49 +01002958 /* Initialize to suppress unnecessary compiler warning */
2959 size_t hostname_len = 0;
2960
2961 /* Check if new hostname is valid before
2962 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 if (hostname != NULL) {
2964 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002965
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2967 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2968 }
Hanno Becker947194e2017-04-07 13:25:49 +01002969 }
2970
2971 /* Now it's clear that we will overwrite the old hostname,
2972 * so we can free it safely */
2973
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002975 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002976 }
2977
2978 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002979
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002981 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 } else {
2983 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2984 if (ssl->hostname == NULL) {
2985 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2986 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002987
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002989
Hanno Becker947194e2017-04-07 13:25:49 +01002990 ssl->hostname[hostname_len] = '\0';
2991 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002992
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002994}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002995#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002996
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002997#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002998void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2999 int (*f_sni)(void *, mbedtls_ssl_context *,
3000 const unsigned char *, size_t),
3001 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003002{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003003 conf->f_sni = f_sni;
3004 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003005}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003006#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003007
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003009int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003010{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003011 size_t cur_len, tot_len;
3012 const char **p;
3013
3014 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003015 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3016 * MUST NOT be truncated."
3017 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003018 */
3019 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 for (p = protos; *p != NULL; p++) {
3021 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003022 tot_len += cur_len;
3023
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 if ((cur_len == 0) ||
3025 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3026 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3027 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3028 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003029 }
3030
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003031 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003032
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003034}
3035
Gilles Peskine449bd832023-01-11 14:50:10 +01003036const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003037{
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003039}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003041
Johan Pascalb62bb512015-12-03 21:56:45 +01003042#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003043void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3044 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003045{
3046 conf->dtls_srtp_mki_support = support_mki_value;
3047}
3048
Gilles Peskine449bd832023-01-11 14:50:10 +01003049int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3050 unsigned char *mki_value,
3051 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003052{
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003055 }
Ron Eldor591f1622018-01-22 12:30:04 +02003056
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3058 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003059 }
Ron Eldor591f1622018-01-22 12:30:04 +02003060
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003062 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003064}
3065
Gilles Peskine449bd832023-01-11 14:50:10 +01003066int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3067 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003068{
Johan Pascal253d0262020-09-22 13:04:45 +02003069 const mbedtls_ssl_srtp_profile *p;
3070 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003071
Johan Pascal253d0262020-09-22 13:04:45 +02003072 /* check the profiles list: all entry must be valid,
3073 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3075 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3076 p++) {
3077 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003078 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003080 /* unsupported value, stop parsing and set the size to an error value */
3081 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003082 }
3083 }
3084
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3086 conf->dtls_srtp_profile_list = NULL;
3087 conf->dtls_srtp_profile_list_len = 0;
3088 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003089 }
3090
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003091 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003092 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003093
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003095}
3096
Gilles Peskine449bd832023-01-11 14:50:10 +01003097void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3098 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003099{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003100 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3101 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003103 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003105 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3107 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003108 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003109}
Johan Pascalb62bb512015-12-03 21:56:45 +01003110#endif /* MBEDTLS_SSL_DTLS_SRTP */
3111
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303112#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003113void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003114{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003115 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003116}
3117
Gilles Peskine449bd832023-01-11 14:50:10 +01003118void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003119{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003120 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003121}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303122#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003123
Janos Follath088ce432017-04-10 12:42:31 +01003124#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003125void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3126 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003127{
3128 conf->cert_req_ca_list = cert_req_ca_list;
3129}
3130#endif
3131
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003132#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003133void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003134{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003135 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003136}
3137#endif
3138
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003140void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003141{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003142 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003143}
3144#endif
3145
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003146#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003147int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003148{
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3150 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3151 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003152 }
3153
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003154 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003155
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003157}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003159
Gilles Peskine449bd832023-01-11 14:50:10 +01003160void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003161{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003162 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003163}
3164
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003166void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003167{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003168 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003169}
3170
Gilles Peskine449bd832023-01-11 14:50:10 +01003171void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003172{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003173 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003174}
3175
Gilles Peskine449bd832023-01-11 14:50:10 +01003176void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3177 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003178{
Gilles Peskine449bd832023-01-11 14:50:10 +01003179 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003180}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003181#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003184#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003185void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003186{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003187 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003188}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003189#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003190
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003191#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003192
Jerry Yud0766ec2022-09-22 10:46:57 +08003193#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003194void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3195 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003196{
Jerry Yud0766ec2022-09-22 10:46:57 +08003197 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003198}
3199#endif
3200
Gilles Peskine449bd832023-01-11 14:50:10 +01003201void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3202 mbedtls_ssl_ticket_write_t *f_ticket_write,
3203 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3204 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003205{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003206 conf->f_ticket_write = f_ticket_write;
3207 conf->f_ticket_parse = f_ticket_parse;
3208 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003209}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003210#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003211#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003212
Gilles Peskine449bd832023-01-11 14:50:10 +01003213void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3214 mbedtls_ssl_export_keys_t *f_export_keys,
3215 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003216{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003217 ssl->f_export_keys = f_export_keys;
3218 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003219}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003220
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003221#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003222void mbedtls_ssl_conf_async_private_cb(
3223 mbedtls_ssl_config *conf,
3224 mbedtls_ssl_async_sign_t *f_async_sign,
3225 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3226 mbedtls_ssl_async_resume_t *f_async_resume,
3227 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003229{
3230 conf->f_async_sign_start = f_async_sign;
3231 conf->f_async_decrypt_start = f_async_decrypt;
3232 conf->f_async_resume = f_async_resume;
3233 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003234 conf->p_async_config_data = async_config_data;
3235}
3236
Gilles Peskine449bd832023-01-11 14:50:10 +01003237void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003238{
Gilles Peskine449bd832023-01-11 14:50:10 +01003239 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003240}
3241
Gilles Peskine449bd832023-01-11 14:50:10 +01003242void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003243{
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 if (ssl->handshake == NULL) {
3245 return NULL;
3246 } else {
3247 return ssl->handshake->user_async_ctx;
3248 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003249}
3250
Gilles Peskine449bd832023-01-11 14:50:10 +01003251void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3252 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003253{
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003255 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003257}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003258#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003259
Paul Bakker5121ce52009-01-03 21:22:43 +00003260/*
3261 * SSL get accessors
3262 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003263uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003264{
Gilles Peskine449bd832023-01-11 14:50:10 +01003265 if (ssl->session != NULL) {
3266 return ssl->session->verify_result;
3267 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003268
Gilles Peskine449bd832023-01-11 14:50:10 +01003269 if (ssl->session_negotiate != NULL) {
3270 return ssl->session_negotiate->verify_result;
3271 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003272
Gilles Peskine449bd832023-01-11 14:50:10 +01003273 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003274}
3275
Gilles Peskine449bd832023-01-11 14:50:10 +01003276int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003277{
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 if (ssl == NULL || ssl->session == NULL) {
3279 return 0;
3280 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003281
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003283}
3284
Gilles Peskine449bd832023-01-11 14:50:10 +01003285const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003286{
Gilles Peskine449bd832023-01-11 14:50:10 +01003287 if (ssl == NULL || ssl->session == NULL) {
3288 return NULL;
3289 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003290
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003292}
3293
Gilles Peskine449bd832023-01-11 14:50:10 +01003294const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003295{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003296#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3298 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003299 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003300 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003301 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003302 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003303 }
3304 }
3305#endif
3306
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003308 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003310 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003311 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003312 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003313 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003314 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003315}
3316
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003317#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003318size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003319{
David Horstmann95d516f2021-05-04 18:36:56 +01003320 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003321 size_t read_mfl;
3322
Jerry Yuddda0502022-12-01 19:43:12 +08003323#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003324 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003325 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3326 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3327 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003328 }
Jerry Yuddda0502022-12-01 19:43:12 +08003329#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003330
3331 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 if (ssl->session_out != NULL) {
3333 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3334 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003335 max_len = read_mfl;
3336 }
3337 }
3338
Jerry Yuddda0502022-12-01 19:43:12 +08003339 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 if (ssl->session_negotiate != NULL) {
3341 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3342 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003343 max_len = read_mfl;
3344 }
3345 }
3346
Gilles Peskine449bd832023-01-11 14:50:10 +01003347 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003348}
3349
Gilles Peskine449bd832023-01-11 14:50:10 +01003350size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003351{
3352 size_t max_len;
3353
3354 /*
3355 * Assume mfl_code is correct since it was checked when set
3356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003357 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003358
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003359 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 if (ssl->session_out != NULL &&
3361 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3362 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003363 }
3364
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003365 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003366 if (ssl->session_negotiate != NULL &&
3367 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3368 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003369 }
3370
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003372}
3373#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3374
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003375#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003376size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003377{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003378 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003379 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3380 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3381 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3382 return 0;
3383 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003384
Gilles Peskine449bd832023-01-11 14:50:10 +01003385 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3386 return ssl->mtu;
3387 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003388
Gilles Peskine449bd832023-01-11 14:50:10 +01003389 if (ssl->mtu == 0) {
3390 return ssl->handshake->mtu;
3391 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003392
Gilles Peskine449bd832023-01-11 14:50:10 +01003393 return ssl->mtu < ssl->handshake->mtu ?
3394 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003395}
3396#endif /* MBEDTLS_SSL_PROTO_DTLS */
3397
Gilles Peskine449bd832023-01-11 14:50:10 +01003398int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003399{
3400 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3401
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003402#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3403 !defined(MBEDTLS_SSL_PROTO_DTLS)
3404 (void) ssl;
3405#endif
3406
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003407#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003408 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003409
Gilles Peskine449bd832023-01-11 14:50:10 +01003410 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003411 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003412 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003413#endif
3414
3415#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003416 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3417 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3418 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003419 const size_t overhead = (size_t) ret;
3420
Gilles Peskine449bd832023-01-11 14:50:10 +01003421 if (ret < 0) {
3422 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003423 }
3424
Gilles Peskine449bd832023-01-11 14:50:10 +01003425 if (mtu <= overhead) {
3426 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3427 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3428 }
3429
3430 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003431 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003432 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003433 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003434#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003435
Hanno Becker0defedb2018-08-10 12:35:02 +01003436#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3437 !defined(MBEDTLS_SSL_PROTO_DTLS)
3438 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003439#endif
3440
Gilles Peskine449bd832023-01-11 14:50:10 +01003441 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003442}
3443
Gilles Peskine449bd832023-01-11 14:50:10 +01003444int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003445{
3446 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3447
3448#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3449 (void) ssl;
3450#endif
3451
3452#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003453 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003454
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003456 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003457 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003458#endif
3459
Gilles Peskine449bd832023-01-11 14:50:10 +01003460 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003461}
3462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003463#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003464const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003465{
Gilles Peskine449bd832023-01-11 14:50:10 +01003466 if (ssl == NULL || ssl->session == NULL) {
3467 return NULL;
3468 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003469
Hanno Beckere6824572019-02-07 13:18:46 +00003470#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003471 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003472#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003473 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003474#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003475}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003476#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003477
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003478#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003479int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3480 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003481{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003482 int ret;
3483
Gilles Peskine449bd832023-01-11 14:50:10 +01003484 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003485 dst == NULL ||
3486 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003487 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3488 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003489 }
3490
Hanno Beckere810bbc2021-05-14 16:01:05 +01003491 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3492 * idempotent: Each session can only be exported once.
3493 *
3494 * (This is in preparation for TLS 1.3 support where we will
3495 * need the ability to export multiple sessions (aka tickets),
3496 * which will be achieved by calling mbedtls_ssl_get_session()
3497 * multiple times until it fails.)
3498 *
3499 * Check whether we have already exported the current session,
3500 * and fail if so.
3501 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003502 if (ssl->session->exported == 1) {
3503 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3504 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003505
Gilles Peskine449bd832023-01-11 14:50:10 +01003506 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3507 if (ret != 0) {
3508 return ret;
3509 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003510
3511 /* Remember that we've exported the session. */
3512 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003513 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003514}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003515#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003516
Paul Bakker5121ce52009-01-03 21:22:43 +00003517/*
Hanno Beckera835da52019-05-16 12:39:07 +01003518 * Define ticket header determining Mbed TLS version
3519 * and structure of the ticket.
3520 */
3521
Hanno Becker94ef3b32019-05-16 12:50:45 +01003522/*
Hanno Becker50b59662019-05-28 14:30:45 +01003523 * Define bitflag determining compile-time settings influencing
3524 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003525 */
3526
Hanno Becker50b59662019-05-28 14:30:45 +01003527#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003528#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003529#else
Hanno Becker3e088662019-05-29 11:10:18 +01003530#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003531#endif /* MBEDTLS_HAVE_TIME */
3532
3533#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003534#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003535#else
Hanno Becker3e088662019-05-29 11:10:18 +01003536#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003537#endif /* MBEDTLS_X509_CRT_PARSE_C */
3538
3539#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003540#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003541#else
Hanno Becker3e088662019-05-29 11:10:18 +01003542#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003543#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3544
3545#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003546#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003547#else
Hanno Becker3e088662019-05-29 11:10:18 +01003548#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003549#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3550
Hanno Becker94ef3b32019-05-16 12:50:45 +01003551#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003552#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003553#else
Hanno Becker3e088662019-05-29 11:10:18 +01003554#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003555#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3556
Hanno Becker94ef3b32019-05-16 12:50:45 +01003557#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3558#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3559#else
3560#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3561#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3562
Hanno Becker3e088662019-05-29 11:10:18 +01003563#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3564#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3565#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3566#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003567#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3568#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003569
Hanno Becker50b59662019-05-28 14:30:45 +01003570#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003571 ((uint16_t) ( \
3572 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3573 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3574 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3575 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3576 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3577 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3578 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003579
Hanno Beckerf8787072019-05-16 12:41:07 +01003580static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003581 MBEDTLS_VERSION_MAJOR,
3582 MBEDTLS_VERSION_MINOR,
3583 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003584 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3585 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003586};
Hanno Beckera835da52019-05-16 12:39:07 +01003587
3588/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003589 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003590 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003591 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003592 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003593 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003594 * opaque mbedtls_version[3]; // library version: major, minor, patch
3595 * opaque session_format[2]; // library-version specific 16-bit field
3596 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003597 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003598 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003599 * Note: When updating the format, remember to keep
3600 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003601 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003602 * // In this version, `session_format` determines
3603 * // the setting of those compile-time
3604 * // configuration options which influence
3605 * // the structure of mbedtls_ssl_session.
3606 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003607 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003608 * // - TLS 1.2 (0x0303)
3609 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003610 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003611 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003612 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003613 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003614 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003615 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003616 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003617 *
3618 * };
3619 *
3620 * } serialized_session;
3621 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003622 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003623
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003624MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003625static int ssl_session_save(const mbedtls_ssl_session *session,
3626 unsigned char omit_header,
3627 unsigned char *buf,
3628 size_t buf_len,
3629 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003630{
3631 unsigned char *p = buf;
3632 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003633 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003634#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3635 size_t out_len;
3636 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3637#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003638 if (session == NULL) {
3639 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3640 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003641
Gilles Peskine449bd832023-01-11 14:50:10 +01003642 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003643 /*
3644 * Add Mbed TLS version identifier
3645 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003646 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003647
Gilles Peskine449bd832023-01-11 14:50:10 +01003648 if (used <= buf_len) {
3649 memcpy(p, ssl_serialized_session_header,
3650 sizeof(ssl_serialized_session_header));
3651 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003652 }
3653 }
3654
3655 /*
3656 * TLS version identifier
3657 */
3658 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003659 if (used <= buf_len) {
3660 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003661 }
3662
3663 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003664 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003665 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003666#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003667 case MBEDTLS_SSL_VERSION_TLS1_2:
3668 used += ssl_tls12_session_save(session, p, remaining_len);
3669 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003670#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3671
Jerry Yu251a12e2022-07-13 15:15:48 +08003672#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003673 case MBEDTLS_SSL_VERSION_TLS1_3:
3674 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3675 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3676 return ret;
3677 }
3678 used += out_len;
3679 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003680#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3681
Gilles Peskine449bd832023-01-11 14:50:10 +01003682 default:
3683 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003684 }
3685
3686 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003687 if (used > buf_len) {
3688 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3689 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003690
Gilles Peskine449bd832023-01-11 14:50:10 +01003691 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003692}
3693
3694/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003695 * Public wrapper for ssl_session_save()
3696 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003697int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3698 unsigned char *buf,
3699 size_t buf_len,
3700 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003701{
Gilles Peskine449bd832023-01-11 14:50:10 +01003702 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003703}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003704
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003705/*
3706 * Deserialize session, see mbedtls_ssl_session_save() for format.
3707 *
3708 * This internal version is wrapped by a public function that cleans up in
3709 * case of error, and has an extra option omit_header.
3710 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003711MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003712static int ssl_session_load(mbedtls_ssl_session *session,
3713 unsigned char omit_header,
3714 const unsigned char *buf,
3715 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003716{
3717 const unsigned char *p = buf;
3718 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003719 size_t remaining_len;
3720
3721
Gilles Peskine449bd832023-01-11 14:50:10 +01003722 if (session == NULL) {
3723 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3724 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003725
Gilles Peskine449bd832023-01-11 14:50:10 +01003726 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003727 /*
3728 * Check Mbed TLS version identifier
3729 */
3730
Gilles Peskine449bd832023-01-11 14:50:10 +01003731 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3732 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003733 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003734
3735 if (memcmp(p, ssl_serialized_session_header,
3736 sizeof(ssl_serialized_session_header)) != 0) {
3737 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3738 }
3739 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003740 }
3741
3742 /*
3743 * TLS version identifier
3744 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003745 if (1 > (size_t) (end - p)) {
3746 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3747 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003748 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003749
3750 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003751 remaining_len = (end - p);
3752 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003753#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003754 case MBEDTLS_SSL_VERSION_TLS1_2:
3755 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003756#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3757
Jerry Yu438ddd82022-07-07 06:55:50 +00003758#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003759 case MBEDTLS_SSL_VERSION_TLS1_3:
3760 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003761#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3762
Gilles Peskine449bd832023-01-11 14:50:10 +01003763 default:
3764 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003765 }
3766}
3767
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003768/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003769 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003771int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3772 const unsigned char *buf,
3773 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003774{
Gilles Peskine449bd832023-01-11 14:50:10 +01003775 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003776
Gilles Peskine449bd832023-01-11 14:50:10 +01003777 if (ret != 0) {
3778 mbedtls_ssl_session_free(session);
3779 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003780
Gilles Peskine449bd832023-01-11 14:50:10 +01003781 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003782}
3783
3784/*
Paul Bakker1961b702013-01-25 14:49:24 +01003785 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003786 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003787MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003788static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003789{
3790 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3791
Ronald Cron66dbf912022-02-02 15:33:46 +01003792 /*
3793 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003794 * that were written into the output buffer by the previous handshake step,
3795 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003796 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3797 * We proceed to the next handshake step only when all data from the
3798 * previous one have been sent to the peer, thus we make sure that this is
3799 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3800 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3801 * we have to wait before to go ahead.
3802 * In the case of TLS 1.3, handshake step handlers do not send data to the
3803 * peer. Data are only sent here and through
3804 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003805 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003806 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003807 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3808 return ret;
3809 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003810
3811#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003812 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3813 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3814 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3815 return ret;
3816 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003817 }
3818#endif /* MBEDTLS_SSL_PROTO_DTLS */
3819
Gilles Peskine449bd832023-01-11 14:50:10 +01003820 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003821}
3822
Gilles Peskine449bd832023-01-11 14:50:10 +01003823int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003824{
Hanno Becker41934dd2021-08-07 19:13:43 +01003825 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003826
Gilles Peskine449bd832023-01-11 14:50:10 +01003827 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003828 ssl->conf == NULL ||
3829 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003830 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3831 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003832 }
3833
Gilles Peskine449bd832023-01-11 14:50:10 +01003834 ret = ssl_prepare_handshake_step(ssl);
3835 if (ret != 0) {
3836 return ret;
3837 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003838
Gilles Peskine449bd832023-01-11 14:50:10 +01003839 ret = mbedtls_ssl_handle_pending_alert(ssl);
3840 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003841 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003842 }
Jerry Yue7047812021-09-13 19:26:39 +08003843
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003844 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3845 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3846 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3847
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003848#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003849 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3850 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003851 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003852
Gilles Peskine449bd832023-01-11 14:50:10 +01003853 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003854 case MBEDTLS_SSL_HELLO_REQUEST:
3855 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003856 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003857 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003858
Ronald Cron9f0fba32022-02-10 16:45:15 +01003859 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003860 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003861 break;
3862
3863 default:
3864#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003865 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3866 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3867 } else {
3868 ret = mbedtls_ssl_handshake_client_step(ssl);
3869 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003870#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003871 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003872#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003873 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003874#endif
3875 }
Jerry Yub9930e72021-08-06 17:11:51 +08003876 }
Ronald Cron6291b232023-03-08 15:51:25 +01003877#endif /* MBEDTLS_SSL_CLI_C */
3878
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003879#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003880 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003881#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3882 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003883 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003884 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003885 ret = mbedtls_ssl_handshake_server_step(ssl);
3886 }
Ronald Cron6291b232023-03-08 15:51:25 +01003887#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3888 ret = mbedtls_ssl_handshake_server_step(ssl);
3889#else
3890 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003891#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003892 }
3893#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003894
Gilles Peskine449bd832023-01-11 14:50:10 +01003895 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003896 /* handshake_step return error. And it is same
3897 * with alert_reason.
3898 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003899 if (ssl->send_alert) {
3900 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003901 goto cleanup;
3902 }
3903 }
3904
3905cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003906 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003907}
3908
3909/*
3910 * Perform the SSL handshake
3911 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003912int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003913{
3914 int ret = 0;
3915
Hanno Beckera817ea42020-10-20 15:20:23 +01003916 /* Sanity checks */
3917
Gilles Peskine449bd832023-01-11 14:50:10 +01003918 if (ssl == NULL || ssl->conf == NULL) {
3919 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3920 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003921
Hanno Beckera817ea42020-10-20 15:20:23 +01003922#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003923 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3924 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3925 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3926 "mbedtls_ssl_set_timer_cb() for DTLS"));
3927 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003928 }
3929#endif /* MBEDTLS_SSL_PROTO_DTLS */
3930
Gilles Peskine449bd832023-01-11 14:50:10 +01003931 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003932
Hanno Beckera817ea42020-10-20 15:20:23 +01003933 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003934 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3935 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003936
Gilles Peskine449bd832023-01-11 14:50:10 +01003937 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003938 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003939 }
Paul Bakker1961b702013-01-25 14:49:24 +01003940 }
3941
Gilles Peskine449bd832023-01-11 14:50:10 +01003942 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003943
Gilles Peskine449bd832023-01-11 14:50:10 +01003944 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003945}
3946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003947#if defined(MBEDTLS_SSL_RENEGOTIATION)
3948#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003949/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003950 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003951 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003952MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003953static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003954{
Janos Follath865b3eb2019-12-16 11:46:15 +00003955 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003956
Gilles Peskine449bd832023-01-11 14:50:10 +01003957 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003958
3959 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003960 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3961 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003962
Gilles Peskine449bd832023-01-11 14:50:10 +01003963 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3964 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3965 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003966 }
3967
Gilles Peskine449bd832023-01-11 14:50:10 +01003968 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003969
Gilles Peskine449bd832023-01-11 14:50:10 +01003970 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003971}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003972#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003973
3974/*
3975 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003976 * - any side: calling mbedtls_ssl_renegotiate(),
3977 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3978 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003979 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003980 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003981 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003982 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003983int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003984{
Janos Follath865b3eb2019-12-16 11:46:15 +00003985 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003986
Gilles Peskine449bd832023-01-11 14:50:10 +01003987 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00003988
Gilles Peskine449bd832023-01-11 14:50:10 +01003989 if ((ret = ssl_handshake_init(ssl)) != 0) {
3990 return ret;
3991 }
Paul Bakker48916f92012-09-16 19:57:18 +00003992
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003993 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3994 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003995#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3997 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
3998 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003999 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004000 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004001 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004003 }
4004#endif
4005
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004006 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4007 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004008
Gilles Peskine449bd832023-01-11 14:50:10 +01004009 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4010 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4011 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004012 }
4013
Gilles Peskine449bd832023-01-11 14:50:10 +01004014 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004015
Gilles Peskine449bd832023-01-11 14:50:10 +01004016 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004017}
4018
4019/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004020 * Renegotiate current connection on client,
4021 * or request renegotiation on server
4022 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004023int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004024{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004025 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004026
Gilles Peskine449bd832023-01-11 14:50:10 +01004027 if (ssl == NULL || ssl->conf == NULL) {
4028 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4029 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004031#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004032 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4034 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4035 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4036 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004038 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004039
4040 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004041 if (ssl->out_left != 0) {
4042 return mbedtls_ssl_flush_output(ssl);
4043 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004044
Gilles Peskine449bd832023-01-11 14:50:10 +01004045 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004046 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004047#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004048
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004049#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004050 /*
4051 * On client, either start the renegotiation process or,
4052 * if already in progress, continue the handshake
4053 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004054 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4055 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004057 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004058
4059 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4060 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4061 return ret;
4062 }
4063 } else {
4064 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4065 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4066 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004067 }
4068 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004069#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004070
Gilles Peskine449bd832023-01-11 14:50:10 +01004071 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004072}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004073#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004074
Gilles Peskine449bd832023-01-11 14:50:10 +01004075void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004076{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004077 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4078
Gilles Peskine449bd832023-01-11 14:50:10 +01004079 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004080 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004082
Valerio Setti6f0441d2023-07-03 12:11:36 +02004083#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004084#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 if (ssl->handshake->group_list_heap_allocated) {
4086 mbedtls_free((void *) handshake->group_list);
4087 }
Brett Warrene0edc842021-08-17 09:53:13 +01004088 handshake->group_list = NULL;
4089#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004090#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004091
Ronald Crone68ab4f2022-10-05 12:46:29 +02004092#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004093#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004094 if (ssl->handshake->sig_algs_heap_allocated) {
4095 mbedtls_free((void *) handshake->sig_algs);
4096 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004097 handshake->sig_algs = NULL;
4098#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004099#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004100 if (ssl->handshake->certificate_request_context) {
4101 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004102 }
4103#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004104#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004105
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004106#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004107 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4108 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004109 handshake->async_in_progress = 0;
4110 }
4111#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4112
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004113#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004114#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004115 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004116#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004117 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004118#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004119#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004120#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004121#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004123#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004124 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004125#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004126#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004127
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004128#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004130#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004131#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004132 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004134#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004135
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004136#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004137#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004139 /*
4140 * Opaque keys are not stored in the handshake's data and it's the user
4141 * responsibility to destroy them. Clear ones, instead, are created by
4142 * the TLS library and should be destroyed at the same level
4143 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4145 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004146 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004147 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4148#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004150#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004151#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004153 handshake->ecjpake_cache = NULL;
4154 handshake->ecjpake_cache_len = 0;
4155#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004156#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004157
Valerio Setti7aeec542023-07-05 18:57:21 +02004158#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
4159 defined(MBEDTLS_PK_CAN_ECDSA_SOME) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004160 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004161 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004162 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004163#endif
4164
Ronald Cron73fe8df2022-10-05 14:31:43 +02004165#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004166#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004168 /* The maintenance of the external PSK key slot is the
4169 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 if (ssl->handshake->psk_opaque_is_internal) {
4171 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004172 ssl->handshake->psk_opaque_is_internal = 0;
4173 }
4174 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4175 }
Neil Armstronge952a302022-05-03 10:22:14 +02004176#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004177 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004178 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004179 }
Neil Armstronge952a302022-05-03 10:22:14 +02004180#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004181#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004183#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4184 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004185 /*
4186 * Free only the linked list wrapper, not the keys themselves
4187 * since the belong to the SNI callback
4188 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004190#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004191
Gilles Peskineeccd8882020-03-10 12:19:08 +01004192#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4194 if (handshake->ecrs_peer_cert != NULL) {
4195 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4196 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004197 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004198#endif
4199
Hanno Becker75173122019-02-06 16:18:31 +00004200#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4201 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004202 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004203#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4204
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004205#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004206 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4207 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004208#endif /* MBEDTLS_SSL_CLI_C &&
4209 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004210
4211#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 mbedtls_ssl_flight_free(handshake->flight);
4213 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004214#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004215
Valerio Settiea59c432023-07-25 11:14:03 +02004216#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004217 if (handshake->xxdh_psa_privkey_is_external == 0) {
4218 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 }
Valerio Settiea59c432023-07-25 11:14:03 +02004220#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004221
Ronald Cron6f135e12021-12-08 16:57:54 +01004222#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 mbedtls_ssl_transform_free(handshake->transform_handshake);
4224 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004225#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4227 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004228#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004229#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004230
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004231
4232#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4233 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4234 * processes datagrams and the fact that a datagram is allowed to have
4235 * several records in it, it is possible that the I/O buffers are not
4236 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004237 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4238 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004239#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004240
Jerry Yuba9c7272021-10-30 11:54:10 +08004241 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 mbedtls_platform_zeroize(handshake,
4243 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004244}
4245
Gilles Peskine449bd832023-01-11 14:50:10 +01004246void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004247{
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004249 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004250 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004251
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004252#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004254#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004255
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004256#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004257#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4258 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004259 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004260#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004262#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004263
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004265}
4266
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004267#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004268
4269#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4270#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4271#else
4272#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4273#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4274
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004275#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004276
4277#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4278#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4279#else
4280#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4281#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4282
4283#if defined(MBEDTLS_SSL_ALPN)
4284#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4285#else
4286#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4287#endif /* MBEDTLS_SSL_ALPN */
4288
4289#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4290#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4291#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4292#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4293
4294#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 ((uint32_t) ( \
4296 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4297 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4298 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4299 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4300 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4301 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4302 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4303 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004304
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004305static unsigned char ssl_serialized_context_header[] = {
4306 MBEDTLS_VERSION_MAJOR,
4307 MBEDTLS_VERSION_MINOR,
4308 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004309 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4310 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4311 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4312 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4313 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004314};
4315
Paul Bakker5121ce52009-01-03 21:22:43 +00004316/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004317 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004318 *
4319 * The format of the serialized data is:
4320 * (in the presentation language of TLS, RFC 8446 section 3)
4321 *
4322 * // header
4323 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004324 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004325 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004326 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004327 * Note: When updating the format, remember to keep these
4328 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004329 *
4330 * // session sub-structure
4331 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4332 * // transform sub-structure
4333 * uint8 random[64]; // ServerHello.random+ClientHello.random
4334 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4335 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4336 * // fields from ssl_context
4337 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4338 * uint64 in_window_top; // DTLS: last validated record seq_num
4339 * uint64 in_window; // DTLS: bitmask for replay protection
4340 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4341 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4342 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4343 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4344 *
4345 * Note that many fields of the ssl_context or sub-structures are not
4346 * serialized, as they fall in one of the following categories:
4347 *
4348 * 1. forced value (eg in_left must be 0)
4349 * 2. pointer to dynamically-allocated memory (eg session, transform)
4350 * 3. value can be re-derived from other data (eg session keys from MS)
4351 * 4. value was temporary (eg content of input buffer)
4352 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004354int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4355 unsigned char *buf,
4356 size_t buf_len,
4357 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004358{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004359 unsigned char *p = buf;
4360 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004361 size_t session_len;
4362 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004363
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004364 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004365 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4366 * this function's documentation.
4367 *
4368 * These are due to assumptions/limitations in the implementation. Some of
4369 * them are likely to stay (no handshake in progress) some might go away
4370 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004371 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004372 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4374 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4375 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004376 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 if (ssl->handshake != NULL) {
4378 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4379 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004380 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004381 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if (ssl->transform == NULL || ssl->session == NULL) {
4383 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4384 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004385 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004386 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 if (mbedtls_ssl_check_pending(ssl) != 0) {
4388 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4389 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004390 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 if (ssl->out_left != 0) {
4392 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4393 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004394 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004395 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4397 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4398 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004399 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004400 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4402 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4403 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004404 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004405 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4407 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4408 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004409 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004410 /* Renegotiation must not be enabled */
4411#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4413 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
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#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004417
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004418 /*
4419 * Version and format identifier
4420 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004422
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 if (used <= buf_len) {
4424 memcpy(p, ssl_serialized_context_header,
4425 sizeof(ssl_serialized_context_header));
4426 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004427 }
4428
4429 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004430 * Session (length + data)
4431 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4433 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4434 return ret;
4435 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004436
4437 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 if (used <= buf_len) {
4439 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004440 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 ret = ssl_session_save(ssl->session, 1,
4443 p, session_len, &session_len);
4444 if (ret != 0) {
4445 return ret;
4446 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004447
4448 p += session_len;
4449 }
4450
4451 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004452 * Transform
4453 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 used += sizeof(ssl->transform->randbytes);
4455 if (used <= buf_len) {
4456 memcpy(p, ssl->transform->randbytes,
4457 sizeof(ssl->transform->randbytes));
4458 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004459 }
4460
4461#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4462 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004463 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004464 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004466 p += ssl->transform->in_cid_len;
4467
4468 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004470 p += ssl->transform->out_cid_len;
4471 }
4472#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4473
4474 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004475 * Saved fields from top-level ssl_context structure
4476 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004477 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 if (used <= buf_len) {
4479 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004480 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004481 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004482
4483#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4484 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 if (used <= buf_len) {
4486 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004487 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004488
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004490 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004491 }
4492#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4493
4494#if defined(MBEDTLS_SSL_PROTO_DTLS)
4495 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004497 *p++ = ssl->disable_datagram_packing;
4498 }
4499#endif /* MBEDTLS_SSL_PROTO_DTLS */
4500
Jerry Yuae0b2e22021-10-08 15:21:19 +08004501 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 if (used <= buf_len) {
4503 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004504 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004505 }
4506
4507#if defined(MBEDTLS_SSL_PROTO_DTLS)
4508 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 if (used <= buf_len) {
4510 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004511 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004512 }
4513#endif /* MBEDTLS_SSL_PROTO_DTLS */
4514
4515#if defined(MBEDTLS_SSL_ALPN)
4516 {
4517 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004519 : 0;
4520
4521 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004523 *p++ = alpn_len;
4524
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 if (ssl->alpn_chosen != NULL) {
4526 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004527 p += alpn_len;
4528 }
4529 }
4530 }
4531#endif /* MBEDTLS_SSL_ALPN */
4532
4533 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004534 * Done
4535 */
4536 *olen = used;
4537
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 if (used > buf_len) {
4539 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4540 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004541
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004543
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004545}
4546
4547/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004548 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004549 *
4550 * This internal version is wrapped by a public function that cleans up in
4551 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004552 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004553MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004554static int ssl_context_load(mbedtls_ssl_context *ssl,
4555 const unsigned char *buf,
4556 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004557{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004558 const unsigned char *p = buf;
4559 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004560 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004561 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004562#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004563 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004564#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004565
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004566 /*
4567 * The context should have been freshly setup or reset.
4568 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004569 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004570 * renegotiating, or if the user mistakenly loaded a session first.)
4571 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4573 ssl->session != NULL) {
4574 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004575 }
4576
4577 /*
4578 * We can't check that the config matches the initial one, but we can at
4579 * least check it matches the requirements for serializing.
4580 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004582 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4583 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004584#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004585 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004586#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 0) {
4588 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004589 }
4590
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004592
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004593 /*
4594 * Check version identifier
4595 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4597 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004598 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004599
4600 if (memcmp(p, ssl_serialized_context_header,
4601 sizeof(ssl_serialized_context_header)) != 0) {
4602 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4603 }
4604 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004605
4606 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004607 * Session
4608 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 if ((size_t) (end - p) < 4) {
4610 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4611 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004612
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004613 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004614 p += 4;
4615
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004616 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004617 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004618 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004619 ssl->session_in = ssl->session;
4620 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004621 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004622
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 if ((size_t) (end - p) < session_len) {
4624 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4625 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 ret = ssl_session_load(ssl->session, 1, p, session_len);
4628 if (ret != 0) {
4629 mbedtls_ssl_session_free(ssl->session);
4630 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004631 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004632
4633 p += session_len;
4634
4635 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004636 * Transform
4637 */
4638
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004639 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004640 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004641#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004642 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004643 ssl->transform_in = ssl->transform;
4644 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004645 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004646#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004647
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004648#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4650 if (prf_func == NULL) {
4651 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4652 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004653
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004654 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4656 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4657 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004658
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 ret = ssl_tls12_populate_transform(ssl->transform,
4660 ssl->session->ciphersuite,
4661 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004662#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004664#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 prf_func,
4666 p, /* currently pointing to randbytes */
4667 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4668 ssl->conf->endpoint,
4669 ssl);
4670 if (ret != 0) {
4671 return ret;
4672 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004673#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004675
4676#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4677 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 if ((size_t) (end - p) < 1) {
4679 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4680 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004681
4682 ssl->transform->in_cid_len = *p++;
4683
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4685 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4686 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004687
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004689 p += ssl->transform->in_cid_len;
4690
4691 ssl->transform->out_cid_len = *p++;
4692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4694 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4695 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004696
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004698 p += ssl->transform->out_cid_len;
4699#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4700
4701 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004702 * Saved fields from top-level ssl_context structure
4703 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 if ((size_t) (end - p) < 4) {
4705 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4706 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004707
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004708 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004709 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004710
4711#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 if ((size_t) (end - p) < 16) {
4713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4714 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004715
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004716 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004717 p += 8;
4718
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004719 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004720 p += 8;
4721#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4722
4723#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 if ((size_t) (end - p) < 1) {
4725 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4726 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004727
4728 ssl->disable_datagram_packing = *p++;
4729#endif /* MBEDTLS_SSL_PROTO_DTLS */
4730
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4732 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4733 }
4734 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4735 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004736
4737#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 if ((size_t) (end - p) < 2) {
4739 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4740 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004741
Gilles Peskine449bd832023-01-11 14:50:10 +01004742 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004743 p += 2;
4744#endif /* MBEDTLS_SSL_PROTO_DTLS */
4745
4746#if defined(MBEDTLS_SSL_ALPN)
4747 {
4748 uint8_t alpn_len;
4749 const char **cur;
4750
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if ((size_t) (end - p) < 1) {
4752 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4753 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004754
4755 alpn_len = *p++;
4756
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004758 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4760 if (strlen(*cur) == alpn_len &&
4761 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004762 ssl->alpn_chosen = *cur;
4763 break;
4764 }
4765 }
4766 }
4767
4768 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4770 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4771 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004772
4773 p += alpn_len;
4774 }
4775#endif /* MBEDTLS_SSL_ALPN */
4776
4777 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004778 * Forced fields from top-level ssl_context structure
4779 *
4780 * Most of them already set to the correct value by mbedtls_ssl_init() and
4781 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4782 */
4783 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004784 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004785
Hanno Becker361b10d2019-08-30 10:42:49 +01004786 /* Adjust pointers for header fields of outgoing records to
4787 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004789
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004790#if defined(MBEDTLS_SSL_PROTO_DTLS)
4791 ssl->in_epoch = 1;
4792#endif
4793
4794 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4795 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004796 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4797 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 if (ssl->handshake != NULL) {
4799 mbedtls_ssl_handshake_free(ssl);
4800 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004801 ssl->handshake = NULL;
4802 }
4803
4804 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004805 * Done - should have consumed entire buffer
4806 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 if (p != end) {
4808 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4809 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004810
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004812}
4813
4814/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004815 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004816 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004817int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4818 const unsigned char *buf,
4819 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004820{
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004822
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 if (ret != 0) {
4824 mbedtls_ssl_free(context);
4825 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004826
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004828}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004829#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004830
4831/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004832 * Free an SSL context
4833 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004834void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004835{
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004837 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004839
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004841
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004843#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4844 size_t out_buf_len = ssl->out_buf_len;
4845#else
4846 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4847#endif
4848
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004849 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004850 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004851 }
4852
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004854#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4855 size_t in_buf_len = ssl->in_buf_len;
4856#else
4857 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4858#endif
4859
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004860 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004861 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004862 }
4863
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 if (ssl->transform) {
4865 mbedtls_ssl_transform_free(ssl->transform);
4866 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004867 }
4868
Gilles Peskine449bd832023-01-11 14:50:10 +01004869 if (ssl->handshake) {
4870 mbedtls_ssl_handshake_free(ssl);
4871 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004872
4873#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4875 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004876#endif
4877
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 mbedtls_ssl_session_free(ssl->session_negotiate);
4879 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004880 }
4881
Ronald Cron6f135e12021-12-08 16:57:54 +01004882#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 mbedtls_ssl_transform_free(ssl->transform_application);
4884 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004885#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004886
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 if (ssl->session) {
4888 mbedtls_ssl_session_free(ssl->session);
4889 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004890 }
4891
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004892#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004894 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00004895 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004896#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004897
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004898#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004900#endif
4901
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004903
Paul Bakker86f04f42013-02-14 11:20:09 +01004904 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004906}
4907
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004908/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004909 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004910 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004911void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004912{
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004914}
4915
Gilles Peskineae270bf2021-06-02 00:05:29 +02004916/* The selection should be the same as mbedtls_x509_crt_profile_default in
4917 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004918 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004919 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004920 * about this list.
4921 */
Brett Warrene0edc842021-08-17 09:53:13 +01004922static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004923#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004924 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004925#endif
4926#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004927 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004928#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004929#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004930 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004931#endif
4932#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004933 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004934#endif
4935#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004936 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004937#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004938#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004939 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004940#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004941#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004942 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004943#endif
4944#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004945 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004946#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02004947#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01004948 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
4949 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
4950 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
4951 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
4952 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
4953#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004954 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004955};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004956
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03004957static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004958 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4959 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4960 0
4961};
4962
Ronald Crone68ab4f2022-10-05 12:46:29 +02004963#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004964
Jerry Yu909df7b2022-01-22 11:56:27 +08004965/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004966 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004967 * rules SHOULD be upheld.
4968 * - No duplicate entries.
4969 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004970 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004971 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004972 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004973static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004974
Valerio Setti75fba322023-02-23 17:35:09 +01004975#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004976 defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004977 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4978 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004979#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA256 &&
Jerry Yued5e9f42022-01-26 11:21:34 +08004980 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004981
Valerio Setti75fba322023-02-23 17:35:09 +01004982#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004983 defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08004984 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4985 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004986#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004987 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4988
Valerio Setti75fba322023-02-23 17:35:09 +01004989#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004990 defined(MBEDTLS_MD_CAN_SHA512) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004991 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4992 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004993#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yued5e9f42022-01-26 11:21:34 +08004994 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004995
Gilles Peskine449bd832023-01-11 14:50:10 +01004996#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004997 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004998 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01004999#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005000 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005001
Gilles Peskine449bd832023-01-11 14:50:10 +01005002#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005003 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005004 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005005#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005006 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005007
Gilles Peskine449bd832023-01-11 14:50:10 +01005008#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005009 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005010 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005011#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005012 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005013
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005014#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005015 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005016#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005017
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005018#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005019 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005020#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005021
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005022#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005023 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005024#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005025
Gabor Mezei15b95a62022-05-09 16:37:58 +02005026 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005027};
5028
5029/* NOTICE: see above */
5030#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5031static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005032#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Setti75fba322023-02-23 17:35:09 +01005033#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005035#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005036#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5037 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5038#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005039#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005041#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005042#endif /* MBEDTLS_MD_CAN_SHA512*/
5043#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Setti75fba322023-02-23 17:35:09 +01005044#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005046#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005047#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5048 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5049#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005050#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005051 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005052#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005053#endif /* MBEDTLS_MD_CAN_SHA384*/
5054#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Setti75fba322023-02-23 17:35:09 +01005055#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005057#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005058#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5059 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5060#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005061#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005063#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005064#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005065 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005066};
5067#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5068/* NOTICE: see above */
5069static uint16_t ssl_preset_suiteb_sig_algs[] = {
5070
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005071#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08005072 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5073 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005074#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA256&&
Jerry Yu909df7b2022-01-22 11:56:27 +08005075 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
5076
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005077#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu53037892022-01-25 11:02:06 +08005078 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5079 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005080#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu53037892022-01-25 11:02:06 +08005081 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005082
Gilles Peskine449bd832023-01-11 14:50:10 +01005083#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005084 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005085 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005086#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005087 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005088
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005089#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005090 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005091#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005092
Gabor Mezei15b95a62022-05-09 16:37:58 +02005093 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005094};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005095
Jerry Yu909df7b2022-01-22 11:56:27 +08005096/* NOTICE: see above */
5097#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5098static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005099#if defined(MBEDTLS_MD_CAN_SHA256)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005100#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005102#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005103#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005105#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005106#endif /* MBEDTLS_MD_CAN_SHA256*/
5107#if defined(MBEDTLS_MD_CAN_SHA384)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005108#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005110#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005111#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005113#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005114#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005115 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005116};
Jerry Yu909df7b2022-01-22 11:56:27 +08005117#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5118
Ronald Crone68ab4f2022-10-05 12:46:29 +02005119#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005120
Brett Warrene0edc842021-08-17 09:53:13 +01005121static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01005122#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005123 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005124#endif
5125#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005126 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005127#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005128 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005129};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005130
Ronald Crone68ab4f2022-10-05 12:46:29 +02005131#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005132/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005133 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005134MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005135static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005136{
5137 size_t i, j;
5138 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005139
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5141 for (j = 0; j < i; j++) {
5142 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005143 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 }
5145 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5146 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5147 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005148 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005149 }
5150 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005152}
5153
Ronald Crone68ab4f2022-10-05 12:46:29 +02005154#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005155
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005156/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005157 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005158 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005159int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5160 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005161{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005162#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005163 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005164#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005165
Ronald Crone68ab4f2022-10-05 12:46:29 +02005166#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5168 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5169 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005170 }
5171
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5173 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5174 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005175 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005176
5177#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5179 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5180 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005181 }
5182
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5184 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5185 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005186 }
5187#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005188#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005189
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005190 /* Use the functions here so that they are covered in tests,
5191 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 mbedtls_ssl_conf_endpoint(conf, endpoint);
5193 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005194
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005195 /*
5196 * Things that are common to all presets
5197 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005198#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005200 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5201#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5202 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5203#endif
5204 }
5205#endif
5206
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005207#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5208 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5209#endif
5210
5211#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5212 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5213#endif
5214
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005215#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005216 conf->f_cookie_write = ssl_cookie_write_dummy;
5217 conf->f_cookie_check = ssl_cookie_check_dummy;
5218#endif
5219
5220#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5221 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5222#endif
5223
Janos Follath088ce432017-04-10 12:42:31 +01005224#if defined(MBEDTLS_SSL_SRV_C)
5225 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005226 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005227#endif
5228
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005229#if defined(MBEDTLS_SSL_PROTO_DTLS)
5230 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5231 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5232#endif
5233
5234#if defined(MBEDTLS_SSL_RENEGOTIATION)
5235 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 memset(conf->renego_period, 0x00, 2);
5237 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005238#endif
5239
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005240#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005242 const unsigned char dhm_p[] =
5243 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5244 const unsigned char dhm_g[] =
5245 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005246
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5248 dhm_p, sizeof(dhm_p),
5249 dhm_g, sizeof(dhm_g))) != 0) {
5250 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005251 }
5252 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005253#endif
5254
Ronald Cron6f135e12021-12-08 16:57:54 +01005255#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005256
5257#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 mbedtls_ssl_tls13_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005259#if defined(MBEDTLS_SSL_SRV_C)
5260 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005262#endif
5263#endif /* MBEDTLS_SSL_EARLY_DATA */
5264
Jerry Yud0766ec2022-09-22 10:46:57 +08005265#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005266 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005268#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005269 /*
5270 * Allow all TLS 1.3 key exchange modes by default.
5271 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005272 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005273#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005274
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005276#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005277 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005278 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005279#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005281#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005282 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005283#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005284 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5285 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005286#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5287 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5288 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5289#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5290 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5291 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5292#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005293 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005294#endif
5295 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005296
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005297 /*
5298 * Preset-specific defaults
5299 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005301 /*
5302 * NSA Suite B
5303 */
5304 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005305
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005306 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005307
5308#if defined(MBEDTLS_X509_CRT_PARSE_C)
5309 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005310#endif
5311
Ronald Crone68ab4f2022-10-05 12:46:29 +02005312#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005313#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005315 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005317#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005319#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005320
Valerio Setti6f0441d2023-07-03 12:11:36 +02005321#if defined(MBEDTLS_PK_HAVE_ECC_KEYS) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005322 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005323#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005324 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005325 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005326
5327 /*
5328 * Default
5329 */
5330 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005331
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005332 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005333
5334#if defined(MBEDTLS_X509_CRT_PARSE_C)
5335 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5336#endif
5337
Ronald Crone68ab4f2022-10-05 12:46:29 +02005338#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005339#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005341 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005343#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005345#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005346
Valerio Setti6f0441d2023-07-03 12:11:36 +02005347#if defined(MBEDTLS_PK_HAVE_ECC_KEYS) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005348 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005349#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005350 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005351
5352#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5353 conf->dhm_min_bitlen = 1024;
5354#endif
5355 }
5356
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005358}
5359
5360/*
5361 * Free mbedtls_ssl_config
5362 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005363void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005364{
5365#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 mbedtls_mpi_free(&conf->dhm_P);
5367 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005368#endif
5369
Ronald Cron73fe8df2022-10-05 14:31:43 +02005370#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005371#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005372 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005373 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5374 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005375#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005377 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005378 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005379 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005380 }
5381
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005383 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005384 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005385 conf->psk_identity_len = 0;
5386 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005387#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005388
5389#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005391#endif
5392
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005394}
5395
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005396#if defined(MBEDTLS_PK_C) && \
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005397 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_CAN_ECDSA_SOME))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005398/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005399 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005400 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005401unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005402{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005403#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5405 return MBEDTLS_SSL_SIG_RSA;
5406 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005407#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005408#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5410 return MBEDTLS_SSL_SIG_ECDSA;
5411 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005412#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005414}
5415
Gilles Peskine449bd832023-01-11 14:50:10 +01005416unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005417{
Gilles Peskine449bd832023-01-11 14:50:10 +01005418 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005419 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005421 case MBEDTLS_PK_ECDSA:
5422 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005424 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005425 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005426 }
5427}
5428
Gilles Peskine449bd832023-01-11 14:50:10 +01005429mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005430{
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005432#if defined(MBEDTLS_RSA_C)
5433 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005435#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005436#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005437 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005439#endif
5440 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005442 }
5443}
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005444#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_PK_CAN_ECDSA_SOME ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005445
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005446/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005447 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005448 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005449mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005450{
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005452#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005453 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005455#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005456#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005457 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005459#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005460#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005461 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005463#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005464#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005465 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005467#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005468#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005469 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005471#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005472#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005473 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005475#endif
5476 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005478 }
5479}
5480
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005481/*
5482 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5483 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005484unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005485{
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005487#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005488 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005490#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005491#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005492 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005494#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005495#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005496 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005498#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005499#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005500 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005502#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005503#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005504 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005506#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005507#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005508 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005510#endif
5511 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005513 }
5514}
5515
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005516/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005517 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005518 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005519 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005520int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005521{
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005523
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 if (group_list == NULL) {
5525 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005526 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005527
Gilles Peskine449bd832023-01-11 14:50:10 +01005528 for (; *group_list != 0; group_list++) {
5529 if (*group_list == tls_id) {
5530 return 0;
5531 }
5532 }
5533
5534 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005535}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005536
Valerio Setti49e69072023-06-27 17:27:51 +02005537#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005538/*
5539 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5540 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005541int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005542{
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005544
Gilles Peskine449bd832023-01-11 14:50:10 +01005545 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005546 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005548
Gilles Peskine449bd832023-01-11 14:50:10 +01005549 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005550}
Valerio Setti49e69072023-06-27 17:27:51 +02005551#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005552
Valerio Setti18c9fed2022-12-30 17:44:24 +01005553static const struct {
5554 uint16_t tls_id;
5555 mbedtls_ecp_group_id ecp_group_id;
5556 psa_ecc_family_t psa_family;
5557 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005558} tls_id_match_table[] =
5559{
5560#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005561 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005562#endif
5563#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005564 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005565#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005566#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005567 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005568#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005569#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005570 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005571#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005572#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005573 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005574#endif
5575#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005576 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005577#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005578#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005579 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005580#endif
5581#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005582 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005583#endif
5584#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005585 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005586#endif
5587#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005588 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005589#endif
5590#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005591 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005592#endif
5593#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005594 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005595#endif
5596#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005597 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005598#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005599 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005600};
5601
Gilles Peskine449bd832023-01-11 14:50:10 +01005602int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005603 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005605{
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5607 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005608 if (type != NULL) {
5609 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 }
5611 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005612 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005614 return PSA_SUCCESS;
5615 }
5616 }
5617
5618 return PSA_ERROR_NOT_SUPPORTED;
5619}
5620
Gilles Peskine449bd832023-01-11 14:50:10 +01005621mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005622{
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5624 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005625 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005627 }
5628
5629 return MBEDTLS_ECP_DP_NONE;
5630}
5631
Gilles Peskine449bd832023-01-11 14:50:10 +01005632uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_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].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5635 i++) {
5636 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005637 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005639 }
5640
5641 return 0;
5642}
5643
Valerio Setti67419f02023-01-04 16:12:42 +01005644#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005645static const struct {
5646 uint16_t tls_id;
5647 const char *name;
5648} tls_id_curve_name_table[] =
5649{
Valerio Setti54e23792023-07-07 10:49:27 +02005650 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5651 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5652 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5653 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5654 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5655 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5656 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5657 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5658 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5659 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5660 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5661 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5662 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005663 { 0, NULL },
5664};
5665
Gilles Peskine449bd832023-01-11 14:50:10 +01005666const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005667{
Valerio Settiacd32c02023-06-29 18:06:29 +02005668 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5669 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5670 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005672 }
5673
5674 return NULL;
5675}
Valerio Setti67419f02023-01-04 16:12:42 +01005676#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005677
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005678#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005679int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5680 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5681 int cert_endpoint,
5682 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005683{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005684 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005685 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005686 const char *ext_oid;
5687 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005688
Gilles Peskine449bd832023-01-11 14:50:10 +01005689 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005690 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005692 case MBEDTLS_KEY_EXCHANGE_RSA:
5693 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005694 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005695 break;
5696
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005697 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5698 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5699 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5700 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005701 break;
5702
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005703 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5704 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005705 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005706 break;
5707
5708 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005709 case MBEDTLS_KEY_EXCHANGE_NONE:
5710 case MBEDTLS_KEY_EXCHANGE_PSK:
5711 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5712 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005713 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005714 usage = 0;
5715 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005716 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005717 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5718 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005719 }
5720
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005722 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005723 ret = -1;
5724 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005725
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005727 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5729 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005730 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005732 }
5733
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005735 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005736 ret = -1;
5737 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005738
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005740}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005741#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005742
Jerry Yu148165c2021-09-24 23:20:59 +08005743#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005744int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5745 const mbedtls_md_type_t md,
5746 unsigned char *dst,
5747 size_t dst_len,
5748 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005749{
Ronald Cronf6893e12022-01-07 22:09:01 +01005750 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5751 psa_hash_operation_t *hash_operation_to_clone;
5752 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5753
Jerry Yu148165c2021-09-24 23:20:59 +08005754 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005755
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005757#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005758 case MBEDTLS_MD_SHA384:
5759 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5760 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005761#endif
5762
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005763#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 case MBEDTLS_MD_SHA256:
5765 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5766 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005767#endif
5768
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 default:
5770 goto exit;
5771 }
5772
5773 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5774 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005775 goto exit;
5776 }
5777
Gilles Peskine449bd832023-01-11 14:50:10 +01005778 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5779 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005780 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005782
5783exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005784#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5785 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005786 (void) ssl;
5787#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005788 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005789}
5790#else /* MBEDTLS_USE_PSA_CRYPTO */
5791
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005792#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005793MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005794static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5795 unsigned char *dst,
5796 size_t dst_len,
5797 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005798{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005799 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005800 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005801
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 if (dst_len < 48) {
5803 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5804 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005805
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005806 mbedtls_md_init(&sha384);
5807 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005808 if (ret != 0) {
5809 goto exit;
5810 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005811 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005812 if (ret != 0) {
5813 goto exit;
5814 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005815
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005816 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005817 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005818 goto exit;
5819 }
5820
5821 *olen = 48;
5822
5823exit:
5824
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005825 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005827}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005828#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005829
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005830#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005831MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005832static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5833 unsigned char *dst,
5834 size_t dst_len,
5835 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005836{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005837 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005838 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005839
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 if (dst_len < 32) {
5841 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5842 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005843
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005844 mbedtls_md_init(&sha256);
5845 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5846 if (ret != 0) {
5847 goto exit;
5848 }
5849 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5850 if (ret != 0) {
5851 goto exit;
5852 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005853
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005854 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5855 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005856 goto exit;
5857 }
5858
5859 *olen = 32;
5860
5861exit:
5862
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005863 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005865}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005866#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005867
Gilles Peskine449bd832023-01-11 14:50:10 +01005868int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5869 const mbedtls_md_type_t md,
5870 unsigned char *dst,
5871 size_t dst_len,
5872 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005873{
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005875
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005876#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005877 case MBEDTLS_MD_SHA384:
5878 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005879#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005880
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005881#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 case MBEDTLS_MD_SHA256:
5883 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005884#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005885
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005887#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5888 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 (void) ssl;
5890 (void) dst;
5891 (void) dst_len;
5892 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005893#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005895 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005897}
XiaokangQian647719a2021-12-07 09:16:29 +00005898
Jerry Yu148165c2021-09-24 23:20:59 +08005899#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005900
Ronald Crone68ab4f2022-10-05 12:46:29 +02005901#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005902/* mbedtls_ssl_parse_sig_alg_ext()
5903 *
5904 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5905 * value (TLS 1.3 RFC8446):
5906 * enum {
5907 * ....
5908 * ecdsa_secp256r1_sha256( 0x0403 ),
5909 * ecdsa_secp384r1_sha384( 0x0503 ),
5910 * ecdsa_secp521r1_sha512( 0x0603 ),
5911 * ....
5912 * } SignatureScheme;
5913 *
5914 * struct {
5915 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5916 * } SignatureSchemeList;
5917 *
5918 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5919 * value (TLS 1.2 RFC5246):
5920 * enum {
5921 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5922 * sha512(6), (255)
5923 * } HashAlgorithm;
5924 *
5925 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5926 * SignatureAlgorithm;
5927 *
5928 * struct {
5929 * HashAlgorithm hash;
5930 * SignatureAlgorithm signature;
5931 * } SignatureAndHashAlgorithm;
5932 *
5933 * SignatureAndHashAlgorithm
5934 * supported_signature_algorithms<2..2^16-2>;
5935 *
5936 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5937 * generalization of the TLS 1.2 signature algorithm extension.
5938 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5939 * `SignatureScheme` field of TLS 1.3
5940 *
5941 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005942int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5943 const unsigned char *buf,
5944 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005945{
5946 const unsigned char *p = buf;
5947 size_t supported_sig_algs_len = 0;
5948 const unsigned char *supported_sig_algs_end;
5949 uint16_t sig_alg;
5950 uint32_t common_idx = 0;
5951
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5953 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005954 p += 2;
5955
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 memset(ssl->handshake->received_sig_algs, 0,
5957 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005958
Gilles Peskine449bd832023-01-11 14:50:10 +01005959 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005960 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005961 while (p < supported_sig_algs_end) {
5962 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5963 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005964 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5966 sig_alg,
5967 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005968#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5970 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5971 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005972 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005973 }
5974#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005975
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5977 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005978
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005980 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5981 common_idx += 1;
5982 }
5983 }
5984 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 if (p != end) {
5986 MBEDTLS_SSL_DEBUG_MSG(1,
5987 ("Signature algorithms extension length misaligned"));
5988 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5989 MBEDTLS_ERR_SSL_DECODE_ERROR);
5990 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02005991 }
5992
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 if (common_idx == 0) {
5994 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
5995 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5996 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
5997 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005998 }
5999
Gabor Mezei15b95a62022-05-09 16:37:58 +02006000 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006002}
6003
Ronald Crone68ab4f2022-10-05 12:46:29 +02006004#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006005
Jerry Yudc7bd172022-02-17 13:44:15 +08006006#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6007
6008#if defined(MBEDTLS_USE_PSA_CRYPTO)
6009
Gilles Peskine449bd832023-01-11 14:50:10 +01006010static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6011 mbedtls_svc_key_id_t key,
6012 psa_algorithm_t alg,
6013 const unsigned char *raw_psk, size_t raw_psk_length,
6014 const unsigned char *seed, size_t seed_length,
6015 const unsigned char *label, size_t label_length,
6016 const unsigned char *other_secret,
6017 size_t other_secret_length,
6018 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006019{
6020 psa_status_t status;
6021
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 status = psa_key_derivation_setup(derivation, alg);
6023 if (status != PSA_SUCCESS) {
6024 return status;
6025 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006026
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6028 status = psa_key_derivation_input_bytes(derivation,
6029 PSA_KEY_DERIVATION_INPUT_SEED,
6030 seed, seed_length);
6031 if (status != PSA_SUCCESS) {
6032 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006033 }
6034
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 if (other_secret != NULL) {
6036 status = psa_key_derivation_input_bytes(derivation,
6037 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6038 other_secret, other_secret_length);
6039 if (status != PSA_SUCCESS) {
6040 return status;
6041 }
6042 }
6043
6044 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006045 status = psa_key_derivation_input_bytes(
6046 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 raw_psk, raw_psk_length);
6048 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006049 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006051 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 if (status != PSA_SUCCESS) {
6053 return status;
6054 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006055
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 status = psa_key_derivation_input_bytes(derivation,
6057 PSA_KEY_DERIVATION_INPUT_LABEL,
6058 label, label_length);
6059 if (status != PSA_SUCCESS) {
6060 return status;
6061 }
6062 } else {
6063 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006064 }
6065
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 status = psa_key_derivation_set_capacity(derivation, capacity);
6067 if (status != PSA_SUCCESS) {
6068 return status;
6069 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006070
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006072}
6073
Andrzej Kurek57d10632022-10-24 10:32:01 -04006074#if defined(PSA_WANT_ALG_SHA_384) || \
6075 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006076MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006077static int tls_prf_generic(mbedtls_md_type_t md_type,
6078 const unsigned char *secret, size_t slen,
6079 const char *label,
6080 const unsigned char *random, size_t rlen,
6081 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006082{
6083 psa_status_t status;
6084 psa_algorithm_t alg;
6085 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6086 psa_key_derivation_operation_t derivation =
6087 PSA_KEY_DERIVATION_OPERATION_INIT;
6088
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006090 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006092 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006094
6095 /* Normally a "secret" should be long enough to be impossible to
6096 * find by brute force, and in particular should not be empty. But
6097 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6098 * and for this use case it makes sense to have a 0-length "secret".
6099 * Since the key API doesn't allow importing a key of length 0,
6100 * keep master_key=0, which setup_psa_key_derivation() understands
6101 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006103 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006104 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6105 psa_set_key_algorithm(&key_attributes, alg);
6106 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006107
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6109 if (status != PSA_SUCCESS) {
6110 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6111 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006112 }
6113
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 status = setup_psa_key_derivation(&derivation,
6115 master_key, alg,
6116 NULL, 0,
6117 random, rlen,
6118 (unsigned char const *) label,
6119 (size_t) strlen(label),
6120 NULL, 0,
6121 dlen);
6122 if (status != PSA_SUCCESS) {
6123 psa_key_derivation_abort(&derivation);
6124 psa_destroy_key(master_key);
6125 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006126 }
6127
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6129 if (status != PSA_SUCCESS) {
6130 psa_key_derivation_abort(&derivation);
6131 psa_destroy_key(master_key);
6132 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006133 }
6134
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 status = psa_key_derivation_abort(&derivation);
6136 if (status != PSA_SUCCESS) {
6137 psa_destroy_key(master_key);
6138 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006139 }
6140
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 if (!mbedtls_svc_key_id_is_null(master_key)) {
6142 status = psa_destroy_key(master_key);
6143 }
6144 if (status != PSA_SUCCESS) {
6145 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6146 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006147
Gilles Peskine449bd832023-01-11 14:50:10 +01006148 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006149}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006150#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006151#else /* MBEDTLS_USE_PSA_CRYPTO */
6152
Andrzej Kurek57d10632022-10-24 10:32:01 -04006153#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006154 (defined(MBEDTLS_MD_CAN_SHA256) || \
6155 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006156MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006157static int tls_prf_generic(mbedtls_md_type_t md_type,
6158 const unsigned char *secret, size_t slen,
6159 const char *label,
6160 const unsigned char *random, size_t rlen,
6161 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006162{
6163 size_t nb;
6164 size_t i, j, k, md_len;
6165 unsigned char *tmp;
6166 size_t tmp_len = 0;
6167 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6168 const mbedtls_md_info_t *md_info;
6169 mbedtls_md_context_t md_ctx;
6170 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6171
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006173
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6175 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6176 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006177
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 tmp_len = md_len + strlen(label) + rlen;
6181 tmp = mbedtls_calloc(1, tmp_len);
6182 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006183 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6184 goto exit;
6185 }
6186
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 nb = strlen(label);
6188 memcpy(tmp + md_len, label, nb);
6189 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006190 nb += rlen;
6191
6192 /*
6193 * Compute P_<hash>(secret, label + random)[0..dlen]
6194 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006196 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006198
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6200 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006201 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 }
6203 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6204 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006205 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 }
6207 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6208 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006209 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006211
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 for (i = 0; i < dlen; i += md_len) {
6213 ret = mbedtls_md_hmac_reset(&md_ctx);
6214 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006215 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 }
6217 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6218 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006219 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 }
6221 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6222 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006223 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006225
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 ret = mbedtls_md_hmac_reset(&md_ctx);
6227 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006228 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 }
6230 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6231 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006232 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 }
6234 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6235 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006236 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006238
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006240
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006242 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006244 }
6245
6246exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006248
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 if (tmp != NULL) {
6250 mbedtls_platform_zeroize(tmp, tmp_len);
6251 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006252
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006254
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006256
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006258}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006259#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006260#endif /* MBEDTLS_USE_PSA_CRYPTO */
6261
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006262#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006263MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006264static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6265 const char *label,
6266 const unsigned char *random, size_t rlen,
6267 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006268{
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6270 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006271}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006272#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006273
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006274#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006275MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006276static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6277 const char *label,
6278 const unsigned char *random, size_t rlen,
6279 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006280{
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6282 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006283}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006284#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006285
Jerry Yuf009d862022-02-17 14:01:37 +08006286/*
6287 * Set appropriate PRF function and other SSL / TLS1.2 functions
6288 *
6289 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006290 * - hash associated with the ciphersuite (only used by TLS 1.2)
6291 *
6292 * Outputs:
6293 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6294 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006295MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006296static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6297 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006298{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006299#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006301 handshake->tls_prf = tls_prf_sha384;
6302 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6303 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006305#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006306#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006307 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006308 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006309 handshake->tls_prf = tls_prf_sha256;
6310 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6311 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6312 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006313#else
Jerry Yuf009d862022-02-17 14:01:37 +08006314 {
Jerry Yuf009d862022-02-17 14:01:37 +08006315 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006316 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006318 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006319#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006320
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006322}
Jerry Yud6ab2352022-02-17 14:03:43 +08006323
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006324/*
6325 * Compute master secret if needed
6326 *
6327 * Parameters:
6328 * [in/out] handshake
6329 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6330 * (PSA-PSK) ciphersuite_info, psk_opaque
6331 * [out] premaster (cleared)
6332 * [out] master
6333 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6334 * debug: conf->f_dbg, conf->p_dbg
6335 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006336 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006337 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006338MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006339static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6340 unsigned char *master,
6341 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006342{
6343 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6344
6345 /* cf. RFC 5246, Section 8.1:
6346 * "The master secret is always exactly 48 bytes in length." */
6347 size_t const master_secret_len = 48;
6348
6349#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6350 unsigned char session_hash[48];
6351#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6352
6353 /* The label for the KDF used for key expansion.
6354 * This is either "master secret" or "extended master secret"
6355 * depending on whether the Extended Master Secret extension
6356 * is used. */
6357 char const *lbl = "master secret";
6358
Przemek Stekielae4ed302022-04-05 17:15:55 +02006359 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006360 * - If the Extended Master Secret extension is not used,
6361 * this is ClientHello.Random + ServerHello.Random
6362 * (see Sect. 8.1 in RFC 5246).
6363 * - If the Extended Master Secret extension is used,
6364 * this is the transcript of the handshake so far.
6365 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006366 unsigned char const *seed = handshake->randbytes;
6367 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006368
6369#if !defined(MBEDTLS_DEBUG_C) && \
6370 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6371 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006373 ssl = NULL; /* make sure we don't use it except for those cases */
6374 (void) ssl;
6375#endif
6376
Gilles Peskine449bd832023-01-11 14:50:10 +01006377 if (handshake->resume != 0) {
6378 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6379 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006380 }
6381
6382#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006384 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006385 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006386 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6387 if (ret != 0) {
6388 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6389 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006390
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6392 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006393 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006394#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006395
Przemek Stekiel99114f32022-04-22 11:20:09 +02006396#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006397 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006398 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006399 /* Perform PSK-to-MS expansion in a single step. */
6400 psa_status_t status;
6401 psa_algorithm_t alg;
6402 mbedtls_svc_key_id_t psk;
6403 psa_key_derivation_operation_t derivation =
6404 PSA_KEY_DERIVATION_OPERATION_INIT;
6405 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6406
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006408
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006410
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006412 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006414 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006416
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006417 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006418 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006419
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006421 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006422 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006423 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006424 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006425 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006426 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006427 other_secret_len = 48;
6428 other_secret = handshake->premaster + 2;
6429 break;
6430 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006431 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006432 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6433 other_secret = handshake->premaster + 2;
6434 break;
6435 default:
6436 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006437 }
6438
Gilles Peskine449bd832023-01-11 14:50:10 +01006439 status = setup_psa_key_derivation(&derivation, psk, alg,
6440 ssl->conf->psk, ssl->conf->psk_len,
6441 seed, seed_len,
6442 (unsigned char const *) lbl,
6443 (size_t) strlen(lbl),
6444 other_secret, other_secret_len,
6445 master_secret_len);
6446 if (status != PSA_SUCCESS) {
6447 psa_key_derivation_abort(&derivation);
6448 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006449 }
6450
Gilles Peskine449bd832023-01-11 14:50:10 +01006451 status = psa_key_derivation_output_bytes(&derivation,
6452 master,
6453 master_secret_len);
6454 if (status != PSA_SUCCESS) {
6455 psa_key_derivation_abort(&derivation);
6456 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006457 }
6458
Gilles Peskine449bd832023-01-11 14:50:10 +01006459 status = psa_key_derivation_abort(&derivation);
6460 if (status != PSA_SUCCESS) {
6461 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6462 }
6463 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006464#endif
6465 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006466#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006467 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6468 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006469 psa_status_t status;
6470 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6471 psa_key_derivation_operation_t derivation =
6472 PSA_KEY_DERIVATION_OPERATION_INIT;
6473
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006475
6476 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6477
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 status = psa_key_derivation_setup(&derivation, alg);
6479 if (status != PSA_SUCCESS) {
6480 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006481 }
6482
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 status = psa_key_derivation_set_capacity(&derivation,
6484 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6485 if (status != PSA_SUCCESS) {
6486 psa_key_derivation_abort(&derivation);
6487 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006488 }
6489
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6491 &derivation);
6492 if (status != PSA_SUCCESS) {
6493 psa_key_derivation_abort(&derivation);
6494 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006495 }
6496
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 status = psa_key_derivation_output_bytes(&derivation,
6498 handshake->premaster,
6499 handshake->pmslen);
6500 if (status != PSA_SUCCESS) {
6501 psa_key_derivation_abort(&derivation);
6502 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6503 }
6504
6505 status = psa_key_derivation_abort(&derivation);
6506 if (status != PSA_SUCCESS) {
6507 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006508 }
6509 }
6510#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6512 lbl, seed, seed_len,
6513 master,
6514 master_secret_len);
6515 if (ret != 0) {
6516 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6517 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006518 }
6519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6521 handshake->premaster,
6522 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006523
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 mbedtls_platform_zeroize(handshake->premaster,
6525 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006526 }
6527
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006529}
6530
Gilles Peskine449bd832023-01-11 14:50:10 +01006531int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006532{
6533 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6534 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6535 ssl->handshake->ciphersuite_info;
6536
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006538
6539 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006540 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006541 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 if (ret != 0) {
6543 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6544 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006545 }
6546
6547 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006548 ret = ssl_compute_master(ssl->handshake,
6549 ssl->session_negotiate->master,
6550 ssl);
6551 if (ret != 0) {
6552 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6553 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006554 }
6555
6556 /* Swap the client and server random values:
6557 * - MS derivation wanted client+server (RFC 5246 8.1)
6558 * - key derivation wants server+client (RFC 5246 6.3) */
6559 {
6560 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 memcpy(tmp, ssl->handshake->randbytes, 64);
6562 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6563 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6564 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006565 }
6566
6567 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6569 ssl->session_negotiate->ciphersuite,
6570 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006571#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006573#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 ssl->handshake->tls_prf,
6575 ssl->handshake->randbytes,
6576 ssl->tls_version,
6577 ssl->conf->endpoint,
6578 ssl);
6579 if (ret != 0) {
6580 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6581 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006582 }
6583
6584 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6586 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006587
Gilles Peskine449bd832023-01-11 14:50:10 +01006588 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006589
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006591}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006592
Gilles Peskine449bd832023-01-11 14:50:10 +01006593int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006594{
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006596#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006597 case MBEDTLS_SSL_HASH_SHA384:
6598 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6599 break;
6600#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006601#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006602 case MBEDTLS_SSL_HASH_SHA256:
6603 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6604 break;
6605#endif
6606 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006607 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006608 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006609#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6610 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006611 (void) ssl;
6612#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006613 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006614}
6615
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006616#if defined(MBEDTLS_USE_PSA_CRYPTO)
6617static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6618 const psa_hash_operation_t *hs_op,
6619 size_t buffer_size,
6620 unsigned char *hash,
6621 size_t *hlen)
6622{
6623 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006624 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006625
6626#if !defined(MBEDTLS_DEBUG_C)
6627 (void) ssl;
6628#endif
6629 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006630 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006631 if (status != PSA_SUCCESS) {
6632 goto exit;
6633 }
6634
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006635 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006636 if (status != PSA_SUCCESS) {
6637 goto exit;
6638 }
6639
6640 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6641 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6642
6643exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006644 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006645 return mbedtls_md_error_from_psa(status);
6646}
6647#else
6648static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6649 const mbedtls_md_context_t *hs_ctx,
6650 unsigned char *hash,
6651 size_t *hlen)
6652{
6653 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006654 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006655
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006656 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006657
6658#if !defined(MBEDTLS_DEBUG_C)
6659 (void) ssl;
6660#endif
6661 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6662
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006663 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006664 if (ret != 0) {
6665 goto exit;
6666 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006667 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006668 if (ret != 0) {
6669 goto exit;
6670 }
6671
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006672 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006673 if (ret != 0) {
6674 goto exit;
6675 }
6676
6677 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6678
6679 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6680 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6681
6682exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006683 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006684 return ret;
6685}
6686#endif /* MBEDTLS_USE_PSA_CRYPTO */
6687
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006688#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006689int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6690 unsigned char *hash,
6691 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006692{
6693#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006694 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6695 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006696#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006697 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6698 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006699#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006700}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006701#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006702
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006703#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006704int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6705 unsigned char *hash,
6706 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006707{
6708#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006709 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6710 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006711#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006712 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6713 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006714#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006715}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006716#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006717
Neil Armstrong80f6f322022-05-03 17:56:38 +02006718#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6719 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006720int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006721{
6722 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006723 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006724 const unsigned char *psk = NULL;
6725 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006727
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006729 /*
6730 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006731 * checked before calling this function.
6732 *
6733 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006734 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6737 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6738 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006739 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006740 }
6741
6742 /*
6743 * PMS = struct {
6744 * opaque other_secret<0..2^16-1>;
6745 * opaque psk<0..2^16-1>;
6746 * };
6747 * with "other_secret" depending on the particular key exchange
6748 */
6749#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006750 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6751 if (end - p < 2) {
6752 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6753 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006754
Gilles Peskine449bd832023-01-11 14:50:10 +01006755 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006756 p += 2;
6757
Gilles Peskine449bd832023-01-11 14:50:10 +01006758 if (end < p || (size_t) (end - p) < psk_len) {
6759 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6760 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006761
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006763 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006765#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6766#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006768 /*
6769 * other_secret already set by the ClientKeyExchange message,
6770 * and is 48 bytes long
6771 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 if (end - p < 2) {
6773 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6774 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006775
6776 *p++ = 0;
6777 *p++ = 48;
6778 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006780#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6781#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006783 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6784 size_t len;
6785
6786 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6788 p + 2, end - (p + 2), &len,
6789 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6790 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6791 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006792 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006794 p += 2 + len;
6795
Gilles Peskine449bd832023-01-11 14:50:10 +01006796 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6797 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006798#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006799#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006801 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6802 size_t zlen;
6803
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6805 p + 2, end - (p + 2),
6806 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6807 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6808 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006809 }
6810
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006812 p += 2 + zlen;
6813
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6815 MBEDTLS_DEBUG_ECDH_Z);
6816 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006817#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006818 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6820 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006821 }
6822
6823 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 if (end - p < 2) {
6825 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6826 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006827
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006829 p += 2;
6830
Gilles Peskine449bd832023-01-11 14:50:10 +01006831 if (end < p || (size_t) (end - p) < psk_len) {
6832 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6833 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006834
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006836 p += psk_len;
6837
6838 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6839
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006841}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006842#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006843
6844#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006845MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006846static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006847
6848#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006849int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006850{
6851 /* If renegotiation is not enforced, retransmit until we would reach max
6852 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006853 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006854 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6855 unsigned char doublings = 1;
6856
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006858 ++doublings;
6859 ratio >>= 1;
6860 }
6861
Gilles Peskine449bd832023-01-11 14:50:10 +01006862 if (++ssl->renego_records_seen > doublings) {
6863 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6864 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006865 }
6866 }
6867
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006869}
6870#endif
6871#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006872
Jerry Yud9526692022-02-17 14:23:47 +08006873/*
6874 * Handshake functions
6875 */
6876#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6877/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006878int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006879{
6880 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6881 ssl->handshake->ciphersuite_info;
6882
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006884
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6886 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006887 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006889 }
6890
Gilles Peskine449bd832023-01-11 14:50:10 +01006891 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6892 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006893}
6894
Gilles Peskine449bd832023-01-11 14:50:10 +01006895int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006896{
6897 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6898 ssl->handshake->ciphersuite_info;
6899
Gilles Peskine449bd832023-01-11 14:50:10 +01006900 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006901
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6903 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006904 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006906 }
6907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6909 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006910}
6911
6912#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6913/* Some certificate support -> implement write and parse */
6914
Gilles Peskine449bd832023-01-11 14:50:10 +01006915int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006916{
6917 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6918 size_t i, n;
6919 const mbedtls_x509_crt *crt;
6920 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6921 ssl->handshake->ciphersuite_info;
6922
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006924
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6926 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006927 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006929 }
6930
6931#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6933 if (ssl->handshake->client_auth == 0) {
6934 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006935 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006937 }
6938 }
6939#endif /* MBEDTLS_SSL_CLI_C */
6940#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006941 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6942 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006943 /* Should never happen because we shouldn't have picked the
6944 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006946 }
6947 }
6948#endif
6949
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006951
6952 /*
6953 * 0 . 0 handshake type
6954 * 1 . 3 handshake length
6955 * 4 . 6 length of all certs
6956 * 7 . 9 length of cert. 1
6957 * 10 . n-1 peer certificate
6958 * n . n+2 length of cert. 2
6959 * n+3 . ... upper level cert, etc.
6960 */
6961 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006962 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006963
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006965 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006966 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6967 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6968 " > %" MBEDTLS_PRINTF_SIZET,
6969 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6970 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006971 }
6972
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6974 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6975 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006976
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006978 i += n; crt = crt->next;
6979 }
6980
Gilles Peskine449bd832023-01-11 14:50:10 +01006981 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6982 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6983 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006984
6985 ssl->out_msglen = i;
6986 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6987 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6988
6989 ssl->state++;
6990
Gilles Peskine449bd832023-01-11 14:50:10 +01006991 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6992 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6993 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006994 }
6995
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006997
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006999}
7000
7001#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7002
7003#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007004MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007005static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7006 unsigned char *crt_buf,
7007 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007008{
7009 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7010
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 if (peer_crt == NULL) {
7012 return -1;
7013 }
Jerry Yud9526692022-02-17 14:23:47 +08007014
Gilles Peskine449bd832023-01-11 14:50:10 +01007015 if (peer_crt->raw.len != crt_buf_len) {
7016 return -1;
7017 }
Jerry Yud9526692022-02-17 14:23:47 +08007018
Gilles Peskine449bd832023-01-11 14:50:10 +01007019 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007020}
7021#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007022MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007023static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7024 unsigned char *crt_buf,
7025 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007026{
7027 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7028 unsigned char const * const peer_cert_digest =
7029 ssl->session->peer_cert_digest;
7030 mbedtls_md_type_t const peer_cert_digest_type =
7031 ssl->session->peer_cert_digest_type;
7032 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007034 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7035 size_t digest_len;
7036
Gilles Peskine449bd832023-01-11 14:50:10 +01007037 if (peer_cert_digest == NULL || digest_info == NULL) {
7038 return -1;
7039 }
Jerry Yud9526692022-02-17 14:23:47 +08007040
Gilles Peskine449bd832023-01-11 14:50:10 +01007041 digest_len = mbedtls_md_get_size(digest_info);
7042 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7043 return -1;
7044 }
Jerry Yud9526692022-02-17 14:23:47 +08007045
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7047 if (ret != 0) {
7048 return -1;
7049 }
Jerry Yud9526692022-02-17 14:23:47 +08007050
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007052}
7053#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7054#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7055
7056/*
7057 * Once the certificate message is read, parse it into a cert chain and
7058 * perform basic checks, but leave actual verification to the caller
7059 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007060MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007061static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7062 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007063{
7064 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7065#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007066 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007067#endif
7068 size_t i, n;
7069 uint8_t alert;
7070
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7072 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7073 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7074 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7075 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007076 }
7077
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7079 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7080 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7081 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007082 }
7083
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7085 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7086 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7087 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7088 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007089 }
7090
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007092
7093 /*
7094 * Same message structure as in mbedtls_ssl_write_certificate()
7095 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007097
Gilles Peskine449bd832023-01-11 14:50:10 +01007098 if (ssl->in_msg[i] != 0 ||
7099 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7100 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7101 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7102 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7103 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007104 }
7105
7106 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7107 i += 3;
7108
7109 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007111 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 if (i + 3 > ssl->in_hslen) {
7113 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7114 mbedtls_ssl_send_alert_message(ssl,
7115 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7116 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7117 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007118 }
7119 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7120 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007121 if (ssl->in_msg[i] != 0) {
7122 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7123 mbedtls_ssl_send_alert_message(ssl,
7124 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7125 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7126 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007127 }
7128
7129 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007131 | (unsigned int) ssl->in_msg[i + 2];
7132 i += 3;
7133
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 if (n < 128 || i + n > ssl->in_hslen) {
7135 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7136 mbedtls_ssl_send_alert_message(ssl,
7137 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7138 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7139 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007140 }
7141
7142 /* Check if we're handling the first CRT in the chain. */
7143#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007145 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007147 /* During client-side renegotiation, check that the server's
7148 * end-CRTs hasn't changed compared to the initial handshake,
7149 * mitigating the triple handshake attack. On success, reuse
7150 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7152 if (ssl_check_peer_crt_unchanged(ssl,
7153 &ssl->in_msg[i],
7154 n) != 0) {
7155 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7156 mbedtls_ssl_send_alert_message(ssl,
7157 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7158 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7159 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007160 }
7161
7162 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007164 }
7165#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7166
7167 /* Parse the next certificate in the chain. */
7168#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007170#else
7171 /* If we don't need to store the CRT chain permanently, parse
7172 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007174#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007176 case 0: /*ok*/
7177 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7178 /* Ignore certificate with an unknown algorithm: maybe a
7179 prior certificate was already trusted. */
7180 break;
7181
7182 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7183 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7184 goto crt_parse_der_failed;
7185
7186 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7187 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7188 goto crt_parse_der_failed;
7189
7190 default:
7191 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007192crt_parse_der_failed:
7193 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7194 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7195 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007196 }
7197
7198 i += n;
7199 }
7200
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7202 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007203}
7204
7205#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007206MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007207static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007208{
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7210 return -1;
7211 }
Jerry Yud9526692022-02-17 14:23:47 +08007212
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007214 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7215 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7217 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7218 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007219 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007220 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007221}
7222#endif /* MBEDTLS_SSL_SRV_C */
7223
7224/* Check if a certificate message is expected.
7225 * Return either
7226 * - SSL_CERTIFICATE_EXPECTED, or
7227 * - SSL_CERTIFICATE_SKIP
7228 * indicating whether a Certificate message is expected or not.
7229 */
7230#define SSL_CERTIFICATE_EXPECTED 0
7231#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007232MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007233static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7234 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007235{
7236 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7237 ssl->handshake->ciphersuite_info;
7238
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7240 return SSL_CERTIFICATE_SKIP;
7241 }
Jerry Yud9526692022-02-17 14:23:47 +08007242
7243#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007244 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7245 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7246 return SSL_CERTIFICATE_SKIP;
7247 }
Jerry Yud9526692022-02-17 14:23:47 +08007248
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007250 ssl->session_negotiate->verify_result =
7251 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007253 }
7254 }
7255#else
7256 ((void) authmode);
7257#endif /* MBEDTLS_SSL_SRV_C */
7258
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007260}
7261
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007262MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007263static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7264 int authmode,
7265 mbedtls_x509_crt *chain,
7266 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007267{
7268 int ret = 0;
7269 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7270 ssl->handshake->ciphersuite_info;
7271 int have_ca_chain = 0;
7272
7273 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7274 void *p_vrfy;
7275
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7277 return 0;
7278 }
Jerry Yud9526692022-02-17 14:23:47 +08007279
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 if (ssl->f_vrfy != NULL) {
7281 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007282 f_vrfy = ssl->f_vrfy;
7283 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007284 } else {
7285 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007286 f_vrfy = ssl->conf->f_vrfy;
7287 p_vrfy = ssl->conf->p_vrfy;
7288 }
7289
7290 /*
7291 * Main check: verify certificate
7292 */
7293#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007295 ((void) rs_ctx);
7296 have_ca_chain = 1;
7297
Gilles Peskine449bd832023-01-11 14:50:10 +01007298 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007299 ret = mbedtls_x509_crt_verify_with_ca_cb(
7300 chain,
7301 ssl->conf->f_ca_cb,
7302 ssl->conf->p_ca_cb,
7303 ssl->conf->cert_profile,
7304 ssl->hostname,
7305 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007306 f_vrfy, p_vrfy);
7307 } else
Jerry Yud9526692022-02-17 14:23:47 +08007308#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7309 {
7310 mbedtls_x509_crt *ca_chain;
7311 mbedtls_x509_crl *ca_crl;
7312
7313#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007314 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007315 ca_chain = ssl->handshake->sni_ca_chain;
7316 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 } else
Jerry Yud9526692022-02-17 14:23:47 +08007318#endif
7319 {
7320 ca_chain = ssl->conf->ca_chain;
7321 ca_crl = ssl->conf->ca_crl;
7322 }
7323
Gilles Peskine449bd832023-01-11 14:50:10 +01007324 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007325 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007326 }
Jerry Yud9526692022-02-17 14:23:47 +08007327
7328 ret = mbedtls_x509_crt_verify_restartable(
7329 chain,
7330 ca_chain, ca_crl,
7331 ssl->conf->cert_profile,
7332 ssl->hostname,
7333 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007335 }
7336
Gilles Peskine449bd832023-01-11 14:50:10 +01007337 if (ret != 0) {
7338 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007339 }
7340
7341#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007342 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7343 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7344 }
Jerry Yud9526692022-02-17 14:23:47 +08007345#endif
7346
7347 /*
7348 * Secondary checks: always done, but change 'ret' only if it was 0
7349 */
7350
Valerio Settiacd32c02023-06-29 18:06:29 +02007351#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007352 {
7353 const mbedtls_pk_context *pk = &chain->pk;
7354
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007355 /* If certificate uses an EC key, make sure the curve is OK.
7356 * This is a public key, so it can't be opaque, so can_do() is a good
7357 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007359 /* and in the unlikely case the above assumption no longer holds
7360 * we are making sure that pk_ec() here does not return a NULL
7361 */
Valerio Settid0405092023-05-24 13:16:40 +02007362 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7363 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7364 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007366 }
Valerio Setti97207782023-05-18 18:59:06 +02007367 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007368 ssl->session_negotiate->verify_result |=
7369 MBEDTLS_X509_BADCERT_BAD_KEY;
7370
Gilles Peskine449bd832023-01-11 14:50:10 +01007371 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7372 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007373 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007374 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007375 }
Jerry Yud9526692022-02-17 14:23:47 +08007376 }
7377 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007378#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007379
Gilles Peskine449bd832023-01-11 14:50:10 +01007380 if (mbedtls_ssl_check_cert_usage(chain,
7381 ciphersuite_info,
7382 !ssl->conf->endpoint,
7383 &ssl->session_negotiate->verify_result) != 0) {
7384 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7385 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007386 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 }
Jerry Yud9526692022-02-17 14:23:47 +08007388 }
7389
7390 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7391 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7392 * with details encoded in the verification flags. All other kinds
7393 * of error codes, including those from the user provided f_vrfy
7394 * functions, are treated as fatal and lead to a failure of
7395 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7397 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7398 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007399 ret = 0;
7400 }
7401
Gilles Peskine449bd832023-01-11 14:50:10 +01007402 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7403 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007404 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7405 }
7406
Gilles Peskine449bd832023-01-11 14:50:10 +01007407 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007408 uint8_t alert;
7409
7410 /* The certificate may have been rejected for several reasons.
7411 Pick one and send the corresponding alert. Which alert to send
7412 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007414 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007415 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007416 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007418 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007420 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007422 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007424 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007426 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007428 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007430 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007432 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007434 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 }
7436 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7437 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007438 }
7439
7440#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 if (ssl->session_negotiate->verify_result != 0) {
7442 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7443 (unsigned int) ssl->session_negotiate->verify_result));
7444 } else {
7445 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007446 }
7447#endif /* MBEDTLS_DEBUG_C */
7448
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007450}
7451
7452#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007453MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007454static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7455 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007456{
7457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7458 /* Remember digest of the peer's end-CRT. */
7459 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7461 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7462 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7463 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7464 mbedtls_ssl_send_alert_message(ssl,
7465 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7466 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007467
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007469 }
7470
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 ret = mbedtls_md(mbedtls_md_info_from_type(
7472 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7473 start, len,
7474 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007475
7476 ssl->session_negotiate->peer_cert_digest_type =
7477 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7478 ssl->session_negotiate->peer_cert_digest_len =
7479 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7480
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007482}
7483
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007484MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007485static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7486 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007487{
7488 unsigned char *end = start + len;
7489 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7490
7491 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7493 ret = mbedtls_pk_parse_subpubkey(&start, end,
7494 &ssl->handshake->peer_pubkey);
7495 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007496 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007498 }
7499
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007501}
7502#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7503
Gilles Peskine449bd832023-01-11 14:50:10 +01007504int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007505{
7506 int ret = 0;
7507 int crt_expected;
7508#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7509 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7510 ? ssl->handshake->sni_authmode
7511 : ssl->conf->authmode;
7512#else
7513 const int authmode = ssl->conf->authmode;
7514#endif
7515 void *rs_ctx = NULL;
7516 mbedtls_x509_crt *chain = NULL;
7517
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007519
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7521 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7522 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007523 goto exit;
7524 }
7525
7526#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 if (ssl->handshake->ecrs_enabled &&
7528 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007529 chain = ssl->handshake->ecrs_peer_cert;
7530 ssl->handshake->ecrs_peer_cert = NULL;
7531 goto crt_verify;
7532 }
7533#endif
7534
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007536 /* mbedtls_ssl_read_record may have sent an alert already. We
7537 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007539 goto exit;
7540 }
7541
7542#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007544 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7545
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007547 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 }
Jerry Yud9526692022-02-17 14:23:47 +08007549
7550 goto exit;
7551 }
7552#endif /* MBEDTLS_SSL_SRV_C */
7553
7554 /* Clear existing peer CRT structure in case we tried to
7555 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007557
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7559 if (chain == NULL) {
7560 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7561 sizeof(mbedtls_x509_crt)));
7562 mbedtls_ssl_send_alert_message(ssl,
7563 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7564 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007565
7566 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7567 goto exit;
7568 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007570
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 ret = ssl_parse_certificate_chain(ssl, chain);
7572 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007573 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 }
Jerry Yud9526692022-02-17 14:23:47 +08007575
7576#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007578 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 }
Jerry Yud9526692022-02-17 14:23:47 +08007580
7581crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007583 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 }
Jerry Yud9526692022-02-17 14:23:47 +08007585#endif
7586
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 ret = ssl_parse_certificate_verify(ssl, authmode,
7588 chain, rs_ctx);
7589 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007590 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 }
Jerry Yud9526692022-02-17 14:23:47 +08007592
7593#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7594 {
7595 unsigned char *crt_start, *pk_start;
7596 size_t crt_len, pk_len;
7597
7598 /* We parse the CRT chain without copying, so
7599 * these pointers point into the input buffer,
7600 * and are hence still valid after freeing the
7601 * CRT chain. */
7602
7603 crt_start = chain->raw.p;
7604 crt_len = chain->raw.len;
7605
7606 pk_start = chain->pk_raw.p;
7607 pk_len = chain->pk_raw.len;
7608
7609 /* Free the CRT structures before computing
7610 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 mbedtls_x509_crt_free(chain);
7612 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007613 chain = NULL;
7614
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7616 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007617 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 }
Jerry Yud9526692022-02-17 14:23:47 +08007619
Gilles Peskine449bd832023-01-11 14:50:10 +01007620 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7621 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007622 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 }
Jerry Yud9526692022-02-17 14:23:47 +08007624 }
7625#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7626 /* Pass ownership to session structure. */
7627 ssl->session_negotiate->peer_cert = chain;
7628 chain = NULL;
7629#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7630
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007632
7633exit:
7634
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007636 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 }
Jerry Yud9526692022-02-17 14:23:47 +08007638
7639#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007641 ssl->handshake->ecrs_peer_cert = chain;
7642 chain = NULL;
7643 }
7644#endif
7645
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 if (chain != NULL) {
7647 mbedtls_x509_crt_free(chain);
7648 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007649 }
7650
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007652}
7653#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7654
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007655static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7656 unsigned char *padbuf, size_t hlen,
7657 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007658{
7659 int len = 12;
7660 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007661#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007662 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007663 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007664 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007665 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007666#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007667 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007668 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007669 mbedtls_md_context_t cloned_ctx;
7670 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007671#endif
7672
7673 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007674 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007675 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007677
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007679 ? "client finished"
7680 : "server finished";
7681
7682#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007683 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007684
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007685 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007687 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007688 }
7689
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007690 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007692 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007693 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007694 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007695#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007696 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007697
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007698 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007699 if (ret != 0) {
7700 goto exit;
7701 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007702 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007703 if (ret != 0) {
7704 goto exit;
7705 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007706
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007707 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007708 if (ret != 0) {
7709 goto exit;
7710 }
7711#endif /* MBEDTLS_USE_PSA_CRYPTO */
7712
7713 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7714
Jerry Yu615bd6f2022-02-17 14:25:15 +08007715 /*
7716 * TLSv1.2:
7717 * hash = PRF( master, finished_label,
7718 * Hash( handshake ) )[0.11]
7719 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007720 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007721 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007722
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007724
Paul Elliottecb95be2023-08-11 16:41:04 +01007725 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007726
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007727 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007728
7729exit:
7730#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007731 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007732 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007733#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007734 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007735 return ret;
7736#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007737}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007738
7739#if defined(MBEDTLS_MD_CAN_SHA256)
7740static int ssl_calc_finished_tls_sha256(
7741 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7742{
7743 unsigned char padbuf[32];
7744 return ssl_calc_finished_tls_generic(ssl,
7745#if defined(MBEDTLS_USE_PSA_CRYPTO)
7746 &ssl->handshake->fin_sha256_psa,
7747#else
7748 &ssl->handshake->fin_sha256,
7749#endif
7750 padbuf, sizeof(padbuf),
7751 buf, from);
7752}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007753#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007754
Jerry Yub7ba49e2022-02-17 14:25:53 +08007755
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007756#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007757static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007759{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007760 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007761 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007762#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007763 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007764#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007765 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007766#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007767 padbuf, sizeof(padbuf),
7768 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007769}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007770#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007771
Gilles Peskine449bd832023-01-11 14:50:10 +01007772void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007773{
Gilles Peskine449bd832023-01-11 14:50:10 +01007774 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007775
7776 /*
7777 * Free our handshake params
7778 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007779 mbedtls_ssl_handshake_free(ssl);
7780 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007781 ssl->handshake = NULL;
7782
7783 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007784 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007785 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 if (ssl->transform) {
7787 mbedtls_ssl_transform_free(ssl->transform);
7788 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007789 }
7790 ssl->transform = ssl->transform_negotiate;
7791 ssl->transform_negotiate = NULL;
7792
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007794}
7795
Gilles Peskine449bd832023-01-11 14:50:10 +01007796void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007797{
7798 int resume = ssl->handshake->resume;
7799
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007801
7802#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007804 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7805 ssl->renego_records_seen = 0;
7806 }
7807#endif
7808
7809 /*
7810 * Free the previous session and switch in the current one
7811 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007812 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007813#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7814 /* RFC 7366 3.1: keep the EtM state */
7815 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007817#endif
7818
Gilles Peskine449bd832023-01-11 14:50:10 +01007819 mbedtls_ssl_session_free(ssl->session);
7820 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007821 }
7822 ssl->session = ssl->session_negotiate;
7823 ssl->session_negotiate = NULL;
7824
7825 /*
7826 * Add cache entry
7827 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007828 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007829 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007830 resume == 0) {
7831 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7832 ssl->session->id,
7833 ssl->session->id_len,
7834 ssl->session) != 0) {
7835 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7836 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007837 }
7838
7839#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7841 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007842 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007843 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007844
7845 /* Keep last flight around in case we need to resend it:
7846 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007847 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7848 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007849#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007850 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007851
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007852 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007853
Gilles Peskine449bd832023-01-11 14:50:10 +01007854 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007855}
7856
Gilles Peskine449bd832023-01-11 14:50:10 +01007857int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007858{
7859 int ret, hash_len;
7860
Gilles Peskine449bd832023-01-11 14:50:10 +01007861 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007862
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007864
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007865 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7866 if (ret != 0) {
7867 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7868 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007869
7870 /*
7871 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7872 * may define some other value. Currently (early 2016), no defined
7873 * ciphersuite does this (and this is unlikely to change as activity has
7874 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7875 */
7876 hash_len = 12;
7877
7878#if defined(MBEDTLS_SSL_RENEGOTIATION)
7879 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007881#endif
7882
7883 ssl->out_msglen = 4 + hash_len;
7884 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7885 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7886
7887 /*
7888 * In case of session resuming, invert the client and server
7889 * ChangeCipherSpec messages order.
7890 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007891 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007892#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007894 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007896#endif
7897#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007899 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007901#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007902 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007903 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007904 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007905
7906 /*
7907 * Switch to our negotiated transform and session parameters for outbound
7908 * data.
7909 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007911
7912#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007914 unsigned char i;
7915
7916 /* Remember current epoch settings for resending */
7917 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7919 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007920
7921 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007923
7924
7925 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 for (i = 2; i > 0; i--) {
7927 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007928 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 }
7930 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007931
7932 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 if (i == 0) {
7934 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7935 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007936 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007938#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007939 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007940
7941 ssl->transform_out = ssl->transform_negotiate;
7942 ssl->session_out = ssl->session_negotiate;
7943
7944#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007945 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7946 mbedtls_ssl_send_flight_completed(ssl);
7947 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007948#endif
7949
Gilles Peskine449bd832023-01-11 14:50:10 +01007950 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7951 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7952 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007953 }
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 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7958 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7959 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007960 }
7961#endif
7962
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007964
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007966}
7967
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007968#define SSL_MAX_HASH_LEN 12
7969
Gilles Peskine449bd832023-01-11 14:50:10 +01007970int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007971{
7972 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7973 unsigned int hash_len = 12;
7974 unsigned char buf[SSL_MAX_HASH_LEN];
7975
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007977
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007978 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7979 if (ret != 0) {
7980 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7981 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007982
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7984 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007985 goto exit;
7986 }
7987
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7989 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7990 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7991 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007992 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7993 goto exit;
7994 }
7995
Gilles Peskine449bd832023-01-11 14:50:10 +01007996 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7997 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7998 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007999 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8000 goto exit;
8001 }
8002
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8004 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8005 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8006 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008007 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8008 goto exit;
8009 }
8010
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8012 buf, hash_len) != 0) {
8013 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8014 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8015 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008016 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8017 goto exit;
8018 }
8019
8020#if defined(MBEDTLS_SSL_RENEGOTIATION)
8021 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008023#endif
8024
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008026#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008028 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008030#endif
8031#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008032 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008033 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008035#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008036 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008037 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008039
8040#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008041 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8042 mbedtls_ssl_recv_flight_completed(ssl);
8043 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008044#endif
8045
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008047
8048exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008049 mbedtls_platform_zeroize(buf, hash_len);
8050 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008051}
8052
Jerry Yu392112c2022-02-17 14:34:10 +08008053#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8054/*
8055 * Helper to get TLS 1.2 PRF from ciphersuite
8056 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8057 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008058static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008059{
Jerry Yu392112c2022-02-17 14:34:10 +08008060 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008061 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008062#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8064 return tls_prf_sha384;
8065 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008066#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008067#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008068 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8070 return tls_prf_sha256;
8071 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008072 }
8073#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008074#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8075 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008076 (void) ciphersuite_info;
8077#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008078
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008080}
8081#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008082
Gilles Peskine449bd832023-01-11 14:50:10 +01008083static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008084{
8085 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008086#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008087 if (tls_prf == tls_prf_sha384) {
8088 return MBEDTLS_SSL_TLS_PRF_SHA384;
8089 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008090#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008091#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 if (tls_prf == tls_prf_sha256) {
8093 return MBEDTLS_SSL_TLS_PRF_SHA256;
8094 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008095#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008096 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008097}
8098
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008099/*
8100 * Populate a transform structure with session keys and all the other
8101 * necessary information.
8102 *
8103 * Parameters:
8104 * - [in/out]: transform: structure to populate
8105 * [in] must be just initialised with mbedtls_ssl_transform_init()
8106 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8107 * - [in] ciphersuite
8108 * - [in] master
8109 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008110 * - [in] tls_prf: pointer to PRF to use for key derivation
8111 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008112 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008113 * - [in] endpoint: client or server
8114 * - [in] ssl: used for:
8115 * - ssl->conf->{f,p}_export_keys
8116 * [in] optionally used for:
8117 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8118 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008119MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008120static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8121 int ciphersuite,
8122 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008123#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008124 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008125#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008126 ssl_tls_prf_t tls_prf,
8127 const unsigned char randbytes[64],
8128 mbedtls_ssl_protocol_version tls_version,
8129 unsigned endpoint,
8130 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008131{
8132 int ret = 0;
8133 unsigned char keyblk[256];
8134 unsigned char *key1;
8135 unsigned char *key2;
8136 unsigned char *mac_enc;
8137 unsigned char *mac_dec;
8138 size_t mac_key_len = 0;
8139 size_t iv_copy_len;
8140 size_t keylen;
8141 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008142 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008143#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008144 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008145 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008146#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008147
8148#if defined(MBEDTLS_USE_PSA_CRYPTO)
8149 psa_key_type_t key_type;
8150 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8151 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008152 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008153 size_t key_bits;
8154 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8155#endif
8156
8157#if !defined(MBEDTLS_DEBUG_C) && \
8158 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008159 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008160 ssl = NULL; /* make sure we don't use it except for these cases */
8161 (void) ssl;
8162 }
8163#endif
8164
8165 /*
8166 * Some data just needs copying into the structure
8167 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008168#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008169 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008170#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008171 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008172
8173#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008174 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008175#endif
8176
8177#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008178 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008179 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8180 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008181 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008182 }
8183#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8184
8185 /*
8186 * Get various info structures
8187 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8189 if (ciphersuite_info == NULL) {
8190 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8191 ciphersuite));
8192 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008193 }
8194
Neil Armstrongab555e02022-04-04 11:07:59 +02008195 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008196#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008197 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008198#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008199 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008200
Gilles Peskine449bd832023-01-11 14:50:10 +01008201 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008202 transform->taglen =
8203 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008204 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008205
8206#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 if ((status = mbedtls_ssl_cipher_to_psa(ciphersuite_info->cipher,
8208 transform->taglen,
8209 &alg,
8210 &key_type,
8211 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008212 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008213 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008214 goto end;
8215 }
8216#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008217 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008218 if (cipher_info == NULL) {
8219 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8220 ciphersuite_info->cipher));
8221 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008222 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008223#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008224
Neil Armstronge4512952022-03-08 09:08:22 +01008225#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008226 mac_alg = mbedtls_md_psa_alg_from_type(ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008228 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008229 (unsigned) ciphersuite_info->mac));
8230 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008231 }
8232#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008233 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008234 if (md_info == NULL) {
8235 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8236 (unsigned) ciphersuite_info->mac));
8237 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008238 }
Neil Armstronge4512952022-03-08 09:08:22 +01008239#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008240
8241#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8242 /* Copy own and peer's CID if the use of the CID
8243 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008244 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8245 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008246
8247 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8249 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8250 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008251
8252 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008253 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8254 ssl->handshake->peer_cid_len);
8255 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8256 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008257 }
8258#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8259
8260 /*
8261 * Compute key block using the PRF
8262 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8264 if (ret != 0) {
8265 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8266 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008267 }
8268
Gilles Peskine449bd832023-01-11 14:50:10 +01008269 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8270 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8271 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8272 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8273 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008274
8275 /*
8276 * Determine the appropriate key, IV and MAC length.
8277 */
8278
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008279#if defined(MBEDTLS_USE_PSA_CRYPTO)
8280 keylen = PSA_BITS_TO_BYTES(key_bits);
8281#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008282 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008283#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008284
8285#if defined(MBEDTLS_GCM_C) || \
8286 defined(MBEDTLS_CCM_C) || \
8287 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008288 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008289 size_t explicit_ivlen;
8290
8291 transform->maclen = 0;
8292 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008293
8294 /* All modes haves 96-bit IVs, but the length of the static parts vary
8295 * with mode and version:
8296 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8297 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8298 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8299 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8300 * sequence number).
8301 */
8302 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008303
8304 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008305#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008306 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008307#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8309 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008310#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008311
Gilles Peskine449bd832023-01-11 14:50:10 +01008312 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008313 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008314 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008315 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008316 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008317
8318 /* Minimum length of encrypted record */
8319 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8320 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008321 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008322#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8323#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008324 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008325 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008326 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008327#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008328 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008329#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008330 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008331#endif /* MBEDTLS_USE_PSA_CRYPTO */
8332
8333#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008334 /* Get MAC length */
8335 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8336#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008337 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8339 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8340 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008341 goto end;
8342 }
8343
8344 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008345 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008346#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008347 transform->maclen = mac_key_len;
8348
8349 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008350#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008351 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008352#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008353 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008354#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008355
8356 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008357 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008358 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008359 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008360 /*
8361 * GenericBlockCipher:
8362 * 1. if EtM is in use: one block plus MAC
8363 * otherwise: * first multiple of blocklen greater than maclen
8364 * 2. IV
8365 */
8366#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008368 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 + block_size;
8370 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008371#endif
8372 {
8373 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008374 + block_size
8375 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008376 }
8377
Gilles Peskine449bd832023-01-11 14:50:10 +01008378 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008379 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008380 } else {
8381 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008382 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8383 goto end;
8384 }
8385 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008386 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008387#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8388 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008389 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8390 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008391 }
8392
Gilles Peskine449bd832023-01-11 14:50:10 +01008393 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8394 (unsigned) keylen,
8395 (unsigned) transform->minlen,
8396 (unsigned) transform->ivlen,
8397 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008398
8399 /*
8400 * Finally setup the cipher contexts, IVs and MAC secrets.
8401 */
8402#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008403 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008404 key1 = keyblk + mac_key_len * 2;
8405 key2 = keyblk + mac_key_len * 2 + keylen;
8406
8407 mac_enc = keyblk;
8408 mac_dec = keyblk + mac_key_len;
8409
Gilles Peskine449bd832023-01-11 14:50:10 +01008410 iv_copy_len = (transform->fixed_ivlen) ?
8411 transform->fixed_ivlen : transform->ivlen;
8412 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8413 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8414 iv_copy_len);
8415 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008416#endif /* MBEDTLS_SSL_CLI_C */
8417#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008418 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008419 key1 = keyblk + mac_key_len * 2 + keylen;
8420 key2 = keyblk + mac_key_len * 2;
8421
8422 mac_enc = keyblk + mac_key_len;
8423 mac_dec = keyblk;
8424
Gilles Peskine449bd832023-01-11 14:50:10 +01008425 iv_copy_len = (transform->fixed_ivlen) ?
8426 transform->fixed_ivlen : transform->ivlen;
8427 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8428 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8429 iv_copy_len);
8430 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008431#endif /* MBEDTLS_SSL_SRV_C */
8432 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008434 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8435 goto end;
8436 }
8437
Gilles Peskine449bd832023-01-11 14:50:10 +01008438 if (ssl != NULL && ssl->f_export_keys != NULL) {
8439 ssl->f_export_keys(ssl->p_export_keys,
8440 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8441 master, 48,
8442 randbytes + 32,
8443 randbytes,
8444 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008445 }
8446
8447#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008448 transform->psa_alg = alg;
8449
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8451 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8452 psa_set_key_algorithm(&attributes, alg);
8453 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008454
Gilles Peskine449bd832023-01-11 14:50:10 +01008455 if ((status = psa_import_key(&attributes,
8456 key1,
8457 PSA_BITS_TO_BYTES(key_bits),
8458 &transform->psa_key_enc)) != PSA_SUCCESS) {
8459 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008460 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008462 goto end;
8463 }
8464
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008466
Gilles Peskine449bd832023-01-11 14:50:10 +01008467 if ((status = psa_import_key(&attributes,
8468 key2,
8469 PSA_BITS_TO_BYTES(key_bits),
8470 &transform->psa_key_dec)) != PSA_SUCCESS) {
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 }
8476#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008477 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8478 cipher_info)) != 0) {
8479 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008480 goto end;
8481 }
8482
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8484 cipher_info)) != 0) {
8485 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008486 goto end;
8487 }
8488
Gilles Peskine449bd832023-01-11 14:50:10 +01008489 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8490 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8491 MBEDTLS_ENCRYPT)) != 0) {
8492 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008493 goto end;
8494 }
8495
Gilles Peskine449bd832023-01-11 14:50:10 +01008496 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8497 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8498 MBEDTLS_DECRYPT)) != 0) {
8499 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008500 goto end;
8501 }
8502
8503#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8505 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8506 MBEDTLS_PADDING_NONE)) != 0) {
8507 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008508 goto end;
8509 }
8510
Gilles Peskine449bd832023-01-11 14:50:10 +01008511 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8512 MBEDTLS_PADDING_NONE)) != 0) {
8513 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008514 goto end;
8515 }
8516 }
8517#endif /* MBEDTLS_CIPHER_MODE_CBC */
8518#endif /* MBEDTLS_USE_PSA_CRYPTO */
8519
Neil Armstrong29c0c042022-03-17 17:47:28 +01008520#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8521 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8522 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008524#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008525 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008526
Gilles Peskine449bd832023-01-11 14:50:10 +01008527 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8528 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8529 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008530
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 if ((status = psa_import_key(&attributes,
8532 mac_enc, mac_key_len,
8533 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008534 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008535 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008536 goto end;
8537 }
8538
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8540 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008541#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008542 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008543#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008544 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008545 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8547 PSA_KEY_USAGE_VERIFY_HASH);
8548 } else {
8549 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8550 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008551
Gilles Peskine449bd832023-01-11 14:50:10 +01008552 if ((status = psa_import_key(&attributes,
8553 mac_dec, mac_key_len,
8554 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008555 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008556 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008557 goto end;
8558 }
8559#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8561 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008562 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 }
8564 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8565 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008566 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008567 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008568#endif /* MBEDTLS_USE_PSA_CRYPTO */
8569 }
8570#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8571
8572 ((void) mac_dec);
8573 ((void) mac_enc);
8574
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008575end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008576 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8577 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008578}
8579
Valerio Settia08b1a42022-11-17 15:10:02 +01008580#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8581 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008582int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008583 psa_pake_operation_t *pake_ctx,
8584 const unsigned char *buf,
8585 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008586{
8587 psa_status_t status;
8588 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008589 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008590 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8591 * At round two perform a single cycle
8592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008593 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008594
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 for (; remaining_steps > 0; remaining_steps--) {
8596 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008597 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008598 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008599 /* Length is stored at the first byte */
8600 size_t length = buf[input_offset];
8601 input_offset += 1;
8602
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008604 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8605 }
8606
Gilles Peskine449bd832023-01-11 14:50:10 +01008607 status = psa_pake_input(pake_ctx, step,
8608 buf + input_offset, length);
8609 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008610 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008611 }
8612
8613 input_offset += length;
8614 }
8615 }
8616
Gilles Peskine449bd832023-01-11 14:50:10 +01008617 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008618 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008619 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008620
Gilles Peskine449bd832023-01-11 14:50:10 +01008621 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008622}
8623
Valerio Setti6b3dab02022-11-17 17:14:54 +01008624int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 psa_pake_operation_t *pake_ctx,
8626 unsigned char *buf,
8627 size_t len, size_t *olen,
8628 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008629{
8630 psa_status_t status;
8631 size_t output_offset = 0;
8632 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008633 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008634 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8635 * At round two perform a single cycle
8636 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008637 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008638
Gilles Peskine449bd832023-01-11 14:50:10 +01008639 for (; remaining_steps > 0; remaining_steps--) {
8640 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8641 step <= PSA_PAKE_STEP_ZK_PROOF;
8642 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008643 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008644 * For each step, prepend 1 byte with the length of the data as
8645 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008646 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008647 status = psa_pake_output(pake_ctx, step,
8648 buf + output_offset + 1,
8649 len - output_offset - 1,
8650 &output_len);
8651 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008652 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008653 }
8654
Valerio Setti99d88c12022-11-22 16:03:43 +01008655 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008656
8657 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008658 }
8659 }
8660
8661 *olen = output_offset;
8662
Gilles Peskine449bd832023-01-11 14:50:10 +01008663 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008664}
Valerio Settia08b1a42022-11-17 15:10:02 +01008665#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8666
Jerry Yuee40f9d2022-02-17 14:55:16 +08008667#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008668int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8669 unsigned char *hash, size_t *hashlen,
8670 unsigned char *data, size_t data_len,
8671 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008672{
8673 psa_status_t status;
8674 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008675 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008676
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008678
Gilles Peskine449bd832023-01-11 14:50:10 +01008679 if ((status = psa_hash_setup(&hash_operation,
8680 hash_alg)) != PSA_SUCCESS) {
8681 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008682 goto exit;
8683 }
8684
Gilles Peskine449bd832023-01-11 14:50:10 +01008685 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8686 64)) != PSA_SUCCESS) {
8687 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008688 goto exit;
8689 }
8690
Gilles Peskine449bd832023-01-11 14:50:10 +01008691 if ((status = psa_hash_update(&hash_operation,
8692 data, data_len)) != PSA_SUCCESS) {
8693 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008694 goto exit;
8695 }
8696
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8698 hashlen)) != PSA_SUCCESS) {
8699 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8700 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008701 }
8702
8703exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 if (status != PSA_SUCCESS) {
8705 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8706 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8707 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008708 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008709 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008710 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8711 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008712 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008713 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008714 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008715 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008716 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008717 }
8718 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008719 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008720}
8721
8722#else
8723
Gilles Peskine449bd832023-01-11 14:50:10 +01008724int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8725 unsigned char *hash, size_t *hashlen,
8726 unsigned char *data, size_t data_len,
8727 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008728{
8729 int ret = 0;
8730 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008731 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8732 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008733
Gilles Peskine449bd832023-01-11 14:50:10 +01008734 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008735
Gilles Peskine449bd832023-01-11 14:50:10 +01008736 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008737
8738 /*
8739 * digitally-signed struct {
8740 * opaque client_random[32];
8741 * opaque server_random[32];
8742 * ServerDHParams params;
8743 * };
8744 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008745 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8746 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008747 goto exit;
8748 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008749 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8750 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008751 goto exit;
8752 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008753 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8754 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008755 goto exit;
8756 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008757 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8758 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008759 goto exit;
8760 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008761 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8762 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008763 goto exit;
8764 }
8765
8766exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008767 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008768
Gilles Peskine449bd832023-01-11 14:50:10 +01008769 if (ret != 0) {
8770 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8771 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8772 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008773
Gilles Peskine449bd832023-01-11 14:50:10 +01008774 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008775}
8776#endif /* MBEDTLS_USE_PSA_CRYPTO */
8777
Jerry Yud9d91da2022-02-17 14:57:06 +08008778#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8779
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008780/* Find the preferred hash for a given signature algorithm. */
8781unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008782 mbedtls_ssl_context *ssl,
8783 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008784{
Gabor Mezei078e8032022-04-27 21:17:56 +02008785 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008786 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008787
Gilles Peskine449bd832023-01-11 14:50:10 +01008788 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8789 return MBEDTLS_SSL_HASH_NONE;
8790 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008791
Gilles Peskine449bd832023-01-11 14:50:10 +01008792 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008793 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008794 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8795 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008796 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008797 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8798 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008799
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008800 mbedtls_md_type_t md_alg =
8801 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8802 if (md_alg == MBEDTLS_MD_NONE) {
8803 continue;
8804 }
8805
Gilles Peskine449bd832023-01-11 14:50:10 +01008806 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008807#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008808 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008809 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008810 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008811
Gilles Peskine449bd832023-01-11 14:50:10 +01008812 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8813 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8814 PSA_ALG_ECDSA(psa_hash_alg),
8815 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008816 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008817 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008818
Gilles Peskine449bd832023-01-11 14:50:10 +01008819 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8820 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8821 PSA_ALG_RSA_PKCS1V15_SIGN(
8822 psa_hash_alg),
8823 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008824 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008825 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008826 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008827#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008828
Gilles Peskine449bd832023-01-11 14:50:10 +01008829 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008830 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008831 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008832
Gilles Peskine449bd832023-01-11 14:50:10 +01008833 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008834}
8835
8836#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8837
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008838/* Serialization of TLS 1.2 sessions:
8839 *
8840 * struct {
8841 * uint64 start_time;
8842 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008843 * uint8 session_id_len; // at most 32
8844 * opaque session_id[32];
8845 * opaque master[48]; // fixed length in the standard
8846 * uint32 verify_result;
8847 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8848 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8849 * uint32 ticket_lifetime;
8850 * uint8 mfl_code; // up to 255 according to standard
8851 * uint8 encrypt_then_mac; // 0 or 1
8852 * } serialized_session_tls12;
8853 *
8854 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008855static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8856 unsigned char *buf,
8857 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008858{
8859 unsigned char *p = buf;
8860 size_t used = 0;
8861
8862#if defined(MBEDTLS_HAVE_TIME)
8863 uint64_t start;
8864#endif
8865#if defined(MBEDTLS_X509_CRT_PARSE_C)
8866#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8867 size_t cert_len;
8868#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8869#endif /* MBEDTLS_X509_CRT_PARSE_C */
8870
8871 /*
8872 * Time
8873 */
8874#if defined(MBEDTLS_HAVE_TIME)
8875 used += 8;
8876
Gilles Peskine449bd832023-01-11 14:50:10 +01008877 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008878 start = (uint64_t) session->start;
8879
Gilles Peskine449bd832023-01-11 14:50:10 +01008880 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008881 p += 8;
8882 }
8883#endif /* MBEDTLS_HAVE_TIME */
8884
8885 /*
8886 * Basic mandatory fields
8887 */
8888 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008889 + 1 /* id_len */
8890 + sizeof(session->id)
8891 + sizeof(session->master)
8892 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008893
Gilles Peskine449bd832023-01-11 14:50:10 +01008894 if (used <= buf_len) {
8895 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008896 p += 2;
8897
Gilles Peskine449bd832023-01-11 14:50:10 +01008898 *p++ = MBEDTLS_BYTE_0(session->id_len);
8899 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008900 p += 32;
8901
Gilles Peskine449bd832023-01-11 14:50:10 +01008902 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008903 p += 48;
8904
Gilles Peskine449bd832023-01-11 14:50:10 +01008905 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008906 p += 4;
8907 }
8908
8909 /*
8910 * Peer's end-entity certificate
8911 */
8912#if defined(MBEDTLS_X509_CRT_PARSE_C)
8913#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008914 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008915 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008916 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008917 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008918 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008919
8920 used += 3 + cert_len;
8921
Gilles Peskine449bd832023-01-11 14:50:10 +01008922 if (used <= buf_len) {
8923 *p++ = MBEDTLS_BYTE_2(cert_len);
8924 *p++ = MBEDTLS_BYTE_1(cert_len);
8925 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008926
Gilles Peskine449bd832023-01-11 14:50:10 +01008927 if (session->peer_cert != NULL) {
8928 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008929 p += cert_len;
8930 }
8931 }
8932#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008933 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008934 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008935 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008936 *p++ = (unsigned char) session->peer_cert_digest_type;
8937 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008938 memcpy(p, session->peer_cert_digest,
8939 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008940 p += session->peer_cert_digest_len;
8941 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008942 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008943 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008944 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008945 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8946 *p++ = 0;
8947 }
8948 }
8949#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8950#endif /* MBEDTLS_X509_CRT_PARSE_C */
8951
8952 /*
8953 * Session ticket if any, plus associated data
8954 */
8955#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8956 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8957
Gilles Peskine449bd832023-01-11 14:50:10 +01008958 if (used <= buf_len) {
8959 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
8960 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
8961 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008962
Gilles Peskine449bd832023-01-11 14:50:10 +01008963 if (session->ticket != NULL) {
8964 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008965 p += session->ticket_len;
8966 }
8967
Gilles Peskine449bd832023-01-11 14:50:10 +01008968 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008969 p += 4;
8970 }
8971#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8972
8973 /*
8974 * Misc extension-related info
8975 */
8976#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8977 used += 1;
8978
Gilles Peskine449bd832023-01-11 14:50:10 +01008979 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008980 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01008981 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008982#endif
8983
8984#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8985 used += 1;
8986
Gilles Peskine449bd832023-01-11 14:50:10 +01008987 if (used <= buf_len) {
8988 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
8989 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008990#endif
8991
Gilles Peskine449bd832023-01-11 14:50:10 +01008992 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008993}
8994
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008995MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008996static int ssl_tls12_session_load(mbedtls_ssl_session *session,
8997 const unsigned char *buf,
8998 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008999{
9000#if defined(MBEDTLS_HAVE_TIME)
9001 uint64_t start;
9002#endif
9003#if defined(MBEDTLS_X509_CRT_PARSE_C)
9004#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9005 size_t cert_len;
9006#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9007#endif /* MBEDTLS_X509_CRT_PARSE_C */
9008
9009 const unsigned char *p = buf;
9010 const unsigned char * const end = buf + len;
9011
9012 /*
9013 * Time
9014 */
9015#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009016 if (8 > (size_t) (end - p)) {
9017 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9018 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009019
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009020 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009021 p += 8;
9022
9023 session->start = (time_t) start;
9024#endif /* MBEDTLS_HAVE_TIME */
9025
9026 /*
9027 * Basic mandatory fields
9028 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009029 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9030 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9031 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009032
Gilles Peskine449bd832023-01-11 14:50:10 +01009033 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009034 p += 2;
9035
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009036 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009037 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009038 p += 32;
9039
Gilles Peskine449bd832023-01-11 14:50:10 +01009040 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009041 p += 48;
9042
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009043 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009044 p += 4;
9045
9046 /* Immediately clear invalid pointer values that have been read, in case
9047 * we exit early before we replaced them with valid ones. */
9048#if defined(MBEDTLS_X509_CRT_PARSE_C)
9049#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9050 session->peer_cert = NULL;
9051#else
9052 session->peer_cert_digest = NULL;
9053#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9054#endif /* MBEDTLS_X509_CRT_PARSE_C */
9055#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9056 session->ticket = NULL;
9057#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9058
9059 /*
9060 * Peer certificate
9061 */
9062#if defined(MBEDTLS_X509_CRT_PARSE_C)
9063#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9064 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009065 if (3 > (size_t) (end - p)) {
9066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9067 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009068
Gilles Peskine449bd832023-01-11 14:50:10 +01009069 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009070 p += 3;
9071
Gilles Peskine449bd832023-01-11 14:50:10 +01009072 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009073 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9074
Gilles Peskine449bd832023-01-11 14:50:10 +01009075 if (cert_len > (size_t) (end - p)) {
9076 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9077 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009078
Gilles Peskine449bd832023-01-11 14:50:10 +01009079 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009080
Gilles Peskine449bd832023-01-11 14:50:10 +01009081 if (session->peer_cert == NULL) {
9082 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9083 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009084
Gilles Peskine449bd832023-01-11 14:50:10 +01009085 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009086
Gilles Peskine449bd832023-01-11 14:50:10 +01009087 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9088 p, cert_len)) != 0) {
9089 mbedtls_x509_crt_free(session->peer_cert);
9090 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009091 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009092 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009093 }
9094
9095 p += cert_len;
9096 }
9097#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9098 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009099 if (2 > (size_t) (end - p)) {
9100 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9101 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009102
9103 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9104 session->peer_cert_digest_len = (size_t) *p++;
9105
Gilles Peskine449bd832023-01-11 14:50:10 +01009106 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009107 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009108 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9109 if (md_info == NULL) {
9110 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9111 }
9112 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9113 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9114 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009115
Gilles Peskine449bd832023-01-11 14:50:10 +01009116 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9118 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009119
9120 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009121 mbedtls_calloc(1, session->peer_cert_digest_len);
9122 if (session->peer_cert_digest == NULL) {
9123 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9124 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009125
Gilles Peskine449bd832023-01-11 14:50:10 +01009126 memcpy(session->peer_cert_digest, p,
9127 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009128 p += session->peer_cert_digest_len;
9129 }
9130#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9131#endif /* MBEDTLS_X509_CRT_PARSE_C */
9132
9133 /*
9134 * Session ticket and associated data
9135 */
9136#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009137 if (3 > (size_t) (end - p)) {
9138 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9139 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009140
Gilles Peskine449bd832023-01-11 14:50:10 +01009141 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009142 p += 3;
9143
Gilles Peskine449bd832023-01-11 14:50:10 +01009144 if (session->ticket_len != 0) {
9145 if (session->ticket_len > (size_t) (end - p)) {
9146 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9147 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009148
Gilles Peskine449bd832023-01-11 14:50:10 +01009149 session->ticket = mbedtls_calloc(1, session->ticket_len);
9150 if (session->ticket == NULL) {
9151 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9152 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009153
Gilles Peskine449bd832023-01-11 14:50:10 +01009154 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009155 p += session->ticket_len;
9156 }
9157
Gilles Peskine449bd832023-01-11 14:50:10 +01009158 if (4 > (size_t) (end - p)) {
9159 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9160 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009161
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009162 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009163 p += 4;
9164#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9165
9166 /*
9167 * Misc extension-related info
9168 */
9169#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009170 if (1 > (size_t) (end - p)) {
9171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9172 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009173
9174 session->mfl_code = *p++;
9175#endif
9176
9177#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009178 if (1 > (size_t) (end - p)) {
9179 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9180 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009181
9182 session->encrypt_then_mac = *p++;
9183#endif
9184
9185 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009186 if (p != end) {
9187 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9188 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009189
Gilles Peskine449bd832023-01-11 14:50:10 +01009190 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009191}
Jerry Yudc7bd172022-02-17 13:44:15 +08009192#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9193
XiaokangQian75d40ef2022-04-20 11:05:24 +00009194int mbedtls_ssl_validate_ciphersuite(
9195 const mbedtls_ssl_context *ssl,
9196 const mbedtls_ssl_ciphersuite_t *suite_info,
9197 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009198 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009199{
9200 (void) ssl;
9201
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 if (suite_info == NULL) {
9203 return -1;
9204 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009205
Gilles Peskine449bd832023-01-11 14:50:10 +01009206 if ((suite_info->min_tls_version > max_tls_version) ||
9207 (suite_info->max_tls_version < min_tls_version)) {
9208 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009209 }
9210
XiaokangQian060d8672022-04-21 09:24:56 +00009211#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009212#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009213#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009214 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9215 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009216#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009217 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9218 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009219#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009220 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009221 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009222 }
9223#endif
9224
9225 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9226#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009227 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9228 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9229 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009230 }
9231#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9232#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9233
Gilles Peskine449bd832023-01-11 14:50:10 +01009234 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009235}
9236
Ronald Crone68ab4f2022-10-05 12:46:29 +02009237#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009238/*
9239 * Function for writing a signature algorithm extension.
9240 *
9241 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9242 * value (TLS 1.3 RFC8446):
9243 * enum {
9244 * ....
9245 * ecdsa_secp256r1_sha256( 0x0403 ),
9246 * ecdsa_secp384r1_sha384( 0x0503 ),
9247 * ecdsa_secp521r1_sha512( 0x0603 ),
9248 * ....
9249 * } SignatureScheme;
9250 *
9251 * struct {
9252 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9253 * } SignatureSchemeList;
9254 *
9255 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9256 * value (TLS 1.2 RFC5246):
9257 * enum {
9258 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9259 * sha512(6), (255)
9260 * } HashAlgorithm;
9261 *
9262 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9263 * SignatureAlgorithm;
9264 *
9265 * struct {
9266 * HashAlgorithm hash;
9267 * SignatureAlgorithm signature;
9268 * } SignatureAndHashAlgorithm;
9269 *
9270 * SignatureAndHashAlgorithm
9271 * supported_signature_algorithms<2..2^16-2>;
9272 *
9273 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9274 * generalization of the TLS 1.2 signature algorithm extension.
9275 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9276 * `SignatureScheme` field of TLS 1.3
9277 *
9278 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009279int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9280 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009281{
9282 unsigned char *p = buf;
9283 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9284 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9285
9286 *out_len = 0;
9287
Gilles Peskine449bd832023-01-11 14:50:10 +01009288 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009289
9290 /* Check if we have space for header and length field:
9291 * - extension_type (2 bytes)
9292 * - extension_data_length (2 bytes)
9293 * - supported_signature_algorithms_length (2 bytes)
9294 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009295 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009296 p += 6;
9297
9298 /*
9299 * Write supported_signature_algorithms
9300 */
9301 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009302 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9303 if (sig_alg == NULL) {
9304 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9305 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009306
Gilles Peskine449bd832023-01-11 14:50:10 +01009307 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9308 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9309 *sig_alg,
9310 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9311 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009312 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009313 }
9314 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9315 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009316 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009317 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9318 *sig_alg,
9319 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009320 }
9321
9322 /* Length of supported_signature_algorithms */
9323 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009324 if (supported_sig_alg_len == 0) {
9325 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9326 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009327 }
9328
Gilles Peskine449bd832023-01-11 14:50:10 +01009329 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9330 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9331 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009332
XiaokangQianeaf36512022-04-24 09:07:44 +00009333 *out_len = p - buf;
9334
9335#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009336 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009337#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009338
Gilles Peskine449bd832023-01-11 14:50:10 +01009339 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009340}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009341#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009342
XiaokangQian40a35232022-05-07 09:02:40 +00009343#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009344/*
9345 * mbedtls_ssl_parse_server_name_ext
9346 *
9347 * Structure of server_name extension:
9348 *
9349 * enum {
9350 * host_name(0), (255)
9351 * } NameType;
9352 * opaque HostName<1..2^16-1>;
9353 *
9354 * struct {
9355 * NameType name_type;
9356 * select (name_type) {
9357 * case host_name: HostName;
9358 * } name;
9359 * } ServerName;
9360 * struct {
9361 * ServerName server_name_list<1..2^16-1>
9362 * } ServerNameList;
9363 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009364MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009365int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9366 const unsigned char *buf,
9367 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009368{
9369 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9370 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009371 size_t server_name_list_len, hostname_len;
9372 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009373
Gilles Peskine449bd832023-01-11 14:50:10 +01009374 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009375
Gilles Peskine449bd832023-01-11 14:50:10 +01009376 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9377 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009378 p += 2;
9379
Gilles Peskine449bd832023-01-11 14:50:10 +01009380 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009381 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009382 while (p < server_name_list_end) {
9383 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9384 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9385 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9386 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009387
Gilles Peskine449bd832023-01-11 14:50:10 +01009388 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009389 /* sni_name is intended to be used only during the parsing of the
9390 * ClientHello message (it is reset to NULL before the end of
9391 * the message parsing). Thus it is ok to just point to the
9392 * reception buffer and not make a copy of it.
9393 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009394 ssl->handshake->sni_name = p + 3;
9395 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009396 if (ssl->conf->f_sni == NULL) {
9397 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009398 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009399 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9400 ssl, p + 3, hostname_len);
9401 if (ret != 0) {
9402 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9403 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9404 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9405 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9406 }
9407 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009408 }
9409
9410 p += hostname_len + 3;
9411 }
9412
Gilles Peskine449bd832023-01-11 14:50:10 +01009413 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009414}
9415#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9416
XiaokangQianacb39922022-06-17 10:18:48 +00009417#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009418MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009419int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9420 const unsigned char *buf,
9421 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009422{
9423 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009424 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009425 const unsigned char *protocol_name_list;
9426 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009427 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009428
9429 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009430 if (ssl->conf->alpn_list == NULL) {
9431 return 0;
9432 }
XiaokangQianacb39922022-06-17 10:18:48 +00009433
9434 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009435 * RFC7301, section 3.1
9436 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009437 *
XiaokangQianc7403452022-06-23 03:24:12 +00009438 * struct {
9439 * ProtocolName protocol_name_list<2..2^16-1>
9440 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009441 */
9442
XiaokangQianc7403452022-06-23 03:24:12 +00009443 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009444 * protocol_name_list_len 2 bytes
9445 * protocol_name_len 1 bytes
9446 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009447 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009448 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009449
Gilles Peskine449bd832023-01-11 14:50:10 +01009450 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009451 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009452 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009453 protocol_name_list = p;
9454 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009455
9456 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009457 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009458 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009459 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9460 protocol_name_len);
9461 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009462 MBEDTLS_SSL_PEND_FATAL_ALERT(
9463 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009464 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9465 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009466 }
9467
9468 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009469 }
9470
9471 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009472 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9473 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009474 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009475 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009476 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009477 if (protocol_name_len == alpn_len &&
9478 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009479 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009480 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009481 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009482
9483 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009484 }
9485 }
9486
XiaokangQian95d5f542022-06-24 02:29:26 +00009487 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009488 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009489 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9490 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9491 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009492}
9493
Gilles Peskine449bd832023-01-11 14:50:10 +01009494int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9495 unsigned char *buf,
9496 unsigned char *end,
9497 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009498{
9499 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009500 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009501 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009502
Gilles Peskine449bd832023-01-11 14:50:10 +01009503 if (ssl->alpn_chosen == NULL) {
9504 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009505 }
9506
Gilles Peskine449bd832023-01-11 14:50:10 +01009507 protocol_name_len = strlen(ssl->alpn_chosen);
9508 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009509
Gilles Peskine449bd832023-01-11 14:50:10 +01009510 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009511 /*
9512 * 0 . 1 ext identifier
9513 * 2 . 3 ext length
9514 * 4 . 5 protocol list length
9515 * 6 . 6 protocol name length
9516 * 7 . 7+n protocol name
9517 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009519
XiaokangQian95d5f542022-06-24 02:29:26 +00009520 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009521
Gilles Peskine449bd832023-01-11 14:50:10 +01009522 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9523 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009524 /* Note: the length of the chosen protocol has been checked to be less
9525 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9526 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009527 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009528
Gilles Peskine449bd832023-01-11 14:50:10 +01009529 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009530
9531#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009532 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009533#endif
9534
Gilles Peskine449bd832023-01-11 14:50:10 +01009535 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009536}
9537#endif /* MBEDTLS_SSL_ALPN */
9538
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009539#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009540 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009541 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009542 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009543int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9544 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009545{
9546 /* Initialize to suppress unnecessary compiler warning */
9547 size_t hostname_len = 0;
9548
9549 /* Check if new hostname is valid before
9550 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009551 if (hostname != NULL) {
9552 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009553
Gilles Peskine449bd832023-01-11 14:50:10 +01009554 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9555 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9556 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009557 }
9558
9559 /* Now it's clear that we will overwrite the old hostname,
9560 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009561 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009562 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009563 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009564 }
9565
9566 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009567 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009568 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 } else {
9570 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9571 if (session->hostname == NULL) {
9572 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9573 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009574
Gilles Peskine449bd832023-01-11 14:50:10 +01009575 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009576 }
9577
Gilles Peskine449bd832023-01-11 14:50:10 +01009578 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009579}
Xiaokang Qian03409292022-10-12 02:49:52 +00009580#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9581 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009582 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009583 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009584
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009585#endif /* MBEDTLS_SSL_TLS_C */