blob: fc44dbe28c7777d76c1fdf89838a9e917b80f179 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
SimonBd5800b72016-04-26 07:43:27 +010028#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010029
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000030#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010031#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010032#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000033#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040034
Janos Follath73c616b2019-12-18 15:07:04 +000035#include "mbedtls/debug.h"
36#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050037#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010038#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020039#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020040
Rich Evans00ab4702015-02-06 13:43:58 +000041#include <string.h>
42
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050043#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020044#include "md_psa.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050045#include "mbedtls/psa_util.h"
46#include "psa/crypto.h"
47#endif
48
Janos Follath23bdca02016-10-07 14:47:14 +010049#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000050#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020051#endif
52
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050053#if defined(MBEDTLS_USE_PSA_CRYPTO)
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,
59 sizeof(psa_to_ssl_errors),
60 psa_generic_status_to_mbedtls);
61}
62#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
63
64static int local_md_translation(psa_status_t status)
65{
66 return psa_status_to_mbedtls(status, psa_to_md_errors,
67 sizeof(psa_to_md_errors),
68 psa_generic_status_to_mbedtls);
69}
70#define PSA_TO_MD_ERR(status) local_md_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050071#endif
72
Ronald Cronad8c17b2022-06-10 17:18:09 +020073#if defined(MBEDTLS_TEST_HOOKS)
74static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
75
76void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010077 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020078{
79 chk_buf_ptr_fail_args.cur = cur;
80 chk_buf_ptr_fail_args.end = end;
81 chk_buf_ptr_fail_args.need = need;
82}
83
Gilles Peskine449bd832023-01-11 14:50:10 +010084void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020085{
Gilles Peskine449bd832023-01-11 14:50:10 +010086 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020087}
88
Gilles Peskine449bd832023-01-11 14:50:10 +010089int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020090{
Gilles Peskine449bd832023-01-11 14:50:10 +010091 return (chk_buf_ptr_fail_args.cur != args->cur) ||
92 (chk_buf_ptr_fail_args.end != args->end) ||
93 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020094}
95#endif /* MBEDTLS_TEST_HOOKS */
96
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020097#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010098
Hanno Beckera0e20d02019-05-15 14:03:01 +010099#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100100/* Top-level Connection ID API */
101
Gilles Peskine449bd832023-01-11 14:50:10 +0100102int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
103 size_t len,
104 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +0100105{
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
107 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
108 }
Hanno Beckerad4a1372019-05-03 13:06:44 +0100109
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
111 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
112 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +0100113 }
114
115 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100116 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100118}
119
Gilles Peskine449bd832023-01-11 14:50:10 +0100120int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
121 int enable,
122 unsigned char const *own_cid,
123 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100124{
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
126 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
127 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100128
Hanno Beckerca092242019-04-25 16:01:49 +0100129 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100130 if (enable == MBEDTLS_SSL_CID_DISABLED) {
131 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
132 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100133 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100134 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
135 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100136
Gilles Peskine449bd832023-01-11 14:50:10 +0100137 if (own_cid_len != ssl->conf->cid_len) {
138 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
139 (unsigned) own_cid_len,
140 (unsigned) ssl->conf->cid_len));
141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100142 }
143
Gilles Peskine449bd832023-01-11 14:50:10 +0100144 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100145 /* Truncation is not an issue here because
146 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
147 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100148
Gilles Peskine449bd832023-01-11 14:50:10 +0100149 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100150}
151
Gilles Peskine449bd832023-01-11 14:50:10 +0100152int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
153 int *enabled,
154 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
155 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000156{
157 *enabled = MBEDTLS_SSL_CID_DISABLED;
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
160 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
161 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000162
163 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
164 * zero as this is indistinguishable from not requesting to use
165 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
167 return 0;
168 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000171 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100172 if (own_cid != NULL) {
173 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
174 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000175 }
176
177 *enabled = MBEDTLS_SSL_CID_ENABLED;
178
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000180}
181
Gilles Peskine449bd832023-01-11 14:50:10 +0100182int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
183 int *enabled,
184 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
185 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100186{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100187 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100188
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
190 mbedtls_ssl_is_handshake_over(ssl) == 0) {
191 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100192 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100193
Hanno Beckerc5f24222019-05-03 12:54:52 +0100194 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
195 * were used, but client and server requested the empty CID.
196 * This is indistinguishable from not using the CID extension
197 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 if (ssl->transform_in->in_cid_len == 0 &&
199 ssl->transform_in->out_cid_len == 0) {
200 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100201 }
202
Gilles Peskine449bd832023-01-11 14:50:10 +0100203 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100204 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 if (peer_cid != NULL) {
206 memcpy(peer_cid, ssl->transform_in->out_cid,
207 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100208 }
209 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100210
211 *enabled = MBEDTLS_SSL_CID_ENABLED;
212
Gilles Peskine449bd832023-01-11 14:50:10 +0100213 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100214}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100215#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100216
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200219#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200220/*
221 * Convert max_fragment_length codes to length.
222 * RFC 6066 says:
223 * enum{
224 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
225 * } MaxFragmentLength;
226 * and we add 0 -> extension unused
227 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100228static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200229{
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 switch (mfl) {
231 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
232 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
233 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
234 return 512;
235 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
236 return 1024;
237 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
238 return 2048;
239 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
240 return 4096;
241 default:
242 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000243 }
244}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200245#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
248 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200249{
Gilles Peskine449bd832023-01-11 14:50:10 +0100250 mbedtls_ssl_session_free(dst);
251 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800252#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
253 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000254#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
255 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000256 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800257#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000258#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800259
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200260#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000261
262#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000264 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200265
Gilles Peskine449bd832023-01-11 14:50:10 +0100266 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
267 if (dst->peer_cert == NULL) {
268 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
269 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200270
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200272
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
274 src->peer_cert->raw.len)) != 0) {
275 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200276 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100277 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200278 }
279 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000280#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000282 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 mbedtls_calloc(1, src->peer_cert_digest_len);
284 if (dst->peer_cert_digest == NULL) {
285 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
286 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000287
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
289 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000290 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000291 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000292 }
293#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200295#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200296
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200297#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 if (src->ticket != NULL) {
299 dst->ticket = mbedtls_calloc(1, src->ticket_len);
300 if (dst->ticket == NULL) {
301 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
302 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200303
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200305 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000306
307#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
308 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100309 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000310 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
312 if (ret != 0) {
313 return ret;
314 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000315 }
316#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
317 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200318#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200319
Gilles Peskine449bd832023-01-11 14:50:10 +0100320 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200321}
322
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500323#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200324MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100325static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500326{
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
328 if (resized_buffer == NULL) {
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500329 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500331
332 /* We want to copy len_new bytes when downsizing the buffer, and
333 * len_old bytes when upsizing, so we choose the smaller of two sizes,
334 * to fit one buffer into another. Size checks, ensuring that no data is
335 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100336 memcpy(resized_buffer, *buffer,
337 (len_new < *len_old) ? len_new : *len_old);
338 mbedtls_platform_zeroize(*buffer, *len_old);
339 mbedtls_free(*buffer);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500340
341 *buffer = resized_buffer;
342 *len_old = len_new;
343
344 return 0;
345}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200346
Gilles Peskine449bd832023-01-11 14:50:10 +0100347static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
348 size_t in_buf_new_len,
349 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200350{
351 int modified = 0;
352 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
353 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200355 written_in = ssl->in_msg - ssl->in_buf;
356 iv_offset_in = ssl->in_iv - ssl->in_buf;
357 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100358 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200359 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 ssl->in_buf_len < in_buf_new_len) {
361 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
362 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
363 } else {
364 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
365 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200366 modified = 1;
367 }
368 }
369 }
370
Gilles Peskine449bd832023-01-11 14:50:10 +0100371 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200372 written_out = ssl->out_msg - ssl->out_buf;
373 iv_offset_out = ssl->out_iv - ssl->out_buf;
374 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100375 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200376 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 ssl->out_buf_len < out_buf_new_len) {
378 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
379 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
380 } else {
381 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
382 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200383 modified = 1;
384 }
385 }
386 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200388 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100389 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200390 /* Fields below might not be properly updated with record
391 * splitting or with CID, so they are manually updated here. */
392 ssl->out_msg = ssl->out_buf + written_out;
393 ssl->out_len = ssl->out_buf + len_offset_out;
394 ssl->out_iv = ssl->out_buf + iv_offset_out;
395
396 ssl->in_msg = ssl->in_buf + written_in;
397 ssl->in_len = ssl->in_buf + len_offset_in;
398 ssl->in_iv = ssl->in_buf + iv_offset_in;
399 }
400}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500401#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
402
Jerry Yudb8c48a2022-01-27 14:54:54 +0800403#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800404
405#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100406typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
407 const char *label,
408 const unsigned char *random, size_t rlen,
409 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800410
Gilles Peskine449bd832023-01-11 14:50:10 +0100411static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800412
413#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
414
415/* Type for the TLS PRF */
416typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
417 const unsigned char *, size_t,
418 unsigned char *, size_t);
419
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200420MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100421static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
422 int ciphersuite,
423 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200424#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100425 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200426#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 ssl_tls_prf_t tls_prf,
428 const unsigned char randbytes[64],
429 mbedtls_ssl_protocol_version tls_version,
430 unsigned endpoint,
431 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800432
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100433#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200434MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100435static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300436 const char *label,
437 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100439static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
440static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100441
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100442#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100443
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100444#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100445MBEDTLS_CHECK_RETURN_CRITICAL
446static int tls_prf_sha384(const unsigned char *secret, size_t slen,
447 const char *label,
448 const unsigned char *random, size_t rlen,
449 unsigned char *dstbuf, size_t dlen);
450
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100451static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
452static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100453#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100454
455static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
456 unsigned char *buf,
457 size_t buf_len);
458
459MBEDTLS_CHECK_RETURN_CRITICAL
460static int ssl_tls12_session_load(mbedtls_ssl_session *session,
461 const unsigned char *buf,
462 size_t len);
463#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
464
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100465static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100466
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100467#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100468static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100469#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100470
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100471#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100472static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100473#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100474
475int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
476 const unsigned char *secret, size_t slen,
477 const char *label,
478 const unsigned char *random, size_t rlen,
479 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300480{
481 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
482
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300484#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100485#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300486 case MBEDTLS_SSL_TLS_PRF_SHA384:
487 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100488 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100489#endif /* MBEDTLS_MD_CAN_SHA384*/
490#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300491 case MBEDTLS_SSL_TLS_PRF_SHA256:
492 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100493 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100494#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300495#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100496 default:
497 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300498 }
499
Gilles Peskine449bd832023-01-11 14:50:10 +0100500 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300501}
502
Jerry Yuc73c6182022-02-08 20:29:25 +0800503#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100504static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800505{
506#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 if (session->peer_cert != NULL) {
508 mbedtls_x509_crt_free(session->peer_cert);
509 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800510 session->peer_cert = NULL;
511 }
512#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100513 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800514 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100515 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800516 session->peer_cert_digest = NULL;
517 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
518 session->peer_cert_digest_len = 0;
519 }
520#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
521}
522#endif /* MBEDTLS_X509_CRT_PARSE_C */
523
Gilles Peskine449bd832023-01-11 14:50:10 +0100524uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800525{
Gilles Peskine449bd832023-01-11 14:50:10 +0100526 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800527 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
584 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800592
593 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800595
596 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100597 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800598
599 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800601
602 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100603 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800604
Jan Bruckner151f6422023-02-10 12:45:19 +0100605 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
606 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
607
Jerry Yu7a485c12022-10-31 13:08:18 +0800608 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800610
611 }
612
Gilles Peskine449bd832023-01-11 14:50:10 +0100613 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800614}
615
Gilles Peskine449bd832023-01-11 14:50:10 +0100616uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800617{
Gilles Peskine449bd832023-01-11 14:50:10 +0100618 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800619}
620
Jerry Yud25cab02022-10-31 12:48:30 +0800621#if defined(MBEDTLS_DEBUG_C)
622static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800623 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800624 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
625 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
626 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
627 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
628 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
629 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
630 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
631 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
632 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
633 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
634 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
635 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
636 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
637 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
639 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
640 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
641 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
642 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
643 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
644 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
645 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
646 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
647 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
648 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
649 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100650 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
651 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800652};
653
Gilles Peskine449bd832023-01-11 14:50:10 +0100654static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800655 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
656 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
657 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
658 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
659 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
660 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
661 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
662 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
663 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
664 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
665 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
666 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
667 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
668 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
669 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
670 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
671 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
672 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
673 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
674 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
675 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
676 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
677 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
678 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
679 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
680 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
681 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100682 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
683 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800684};
685
Gilles Peskine449bd832023-01-11 14:50:10 +0100686const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800687{
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return extension_name_table[
689 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800690}
691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800693{
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800695 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800697 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800699 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100700 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800701 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800703 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100704 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800705 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100706 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800707 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100708 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800709 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800711}
712
Gilles Peskine449bd832023-01-11 14:50:10 +0100713void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
714 int level, const char *file, int line,
715 int hs_msg_type, unsigned int extension_type,
716 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800717{
718 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100719 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800720 mbedtls_debug_print_msg(
721 ssl, level, file, line,
722 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100723 ssl_tls13_get_hs_msg_name(hs_msg_type),
724 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800725 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100726 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800727 return;
728 }
729
730 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800732 mbedtls_debug_print_msg(
733 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100734 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
735 mbedtls_ssl_get_extension_name(extension_type), extension_type,
736 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800737 return;
738 }
739
740 mbedtls_debug_print_msg(
741 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
743 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800744}
745
Gilles Peskine449bd832023-01-11 14:50:10 +0100746void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
747 int level, const char *file, int line,
748 int hs_msg_type, uint32_t extensions_mask,
749 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800750{
751
Gilles Peskine449bd832023-01-11 14:50:10 +0100752 for (unsigned i = 0;
753 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
754 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800755 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800756 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100757 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800758 }
759}
760
Pengyu Lvee455c02023-01-12 14:37:24 +0800761#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800762static const char *ticket_flag_name_table[] =
763{
764 [0] = "ALLOW_PSK_RESUMPTION",
765 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
766 [3] = "ALLOW_EARLY_DATA",
767};
768
Pengyu Lv4938a562023-01-16 11:28:49 +0800769void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
770 int level, const char *file, int line,
771 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800772{
773 size_t i;
774
775 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800776 "print ticket_flags (0x%02x)", flags);
777
778 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800779
780 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800781 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800782 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
783 ticket_flag_name_table[i]);
784 }
785 }
786}
787#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
788
Jerry Yud25cab02022-10-31 12:48:30 +0800789#endif /* MBEDTLS_DEBUG_C */
790
Gilles Peskine449bd832023-01-11 14:50:10 +0100791void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
792 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800793{
794 ((void) ciphersuite_info);
795
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100796#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100797 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800798 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100799 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800800#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100801#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800803 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100804 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800805#endif
806 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800808 return;
809 }
810}
811
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100812int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100813 unsigned hs_type,
814 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100815{
816 unsigned char hs_hdr[4];
817
818 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100819 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
820 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
821 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
822 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100823
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100824 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100825}
826
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100827int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100828 unsigned hs_type,
829 unsigned char const *msg,
830 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100831{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100832 int ret;
833 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100834 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100835 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100836 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100837 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100838}
839
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100840int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800841{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100842#if defined(MBEDTLS_MD_CAN_SHA256) || \
843 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100844#if defined(MBEDTLS_USE_PSA_CRYPTO)
845 psa_status_t status;
846#else
847 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
848#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100849#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800850 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100851#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100852#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800853#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100854 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
855 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200856 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100857 }
858 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
859 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200860 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100861 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800862#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100863 mbedtls_md_free(&ssl->handshake->fin_sha256);
864 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100865 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
866 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
867 0);
868 if (ret != 0) {
869 return ret;
870 }
871 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100872 if (ret != 0) {
873 return ret;
874 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800875#endif
876#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100877#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100879 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
880 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200881 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100882 }
883 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
884 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200885 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100886 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800887#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100888 mbedtls_md_free(&ssl->handshake->fin_sha384);
889 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100890 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
891 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
892 if (ret != 0) {
893 return ret;
894 }
895 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100896 if (ret != 0) {
897 return ret;
898 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800899#endif
900#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100901 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800902}
903
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100904static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100905 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800906{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100907#if defined(MBEDTLS_MD_CAN_SHA256) || \
908 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100909#if defined(MBEDTLS_USE_PSA_CRYPTO)
910 psa_status_t status;
911#else
912 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
913#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100914#else /* SHA-256 or SHA-384 */
915 ((void) ssl);
916 (void) buf;
917 (void) len;
918#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100919#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800920#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100921 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
922 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200923 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100924 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800925#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100926 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100927 if (ret != 0) {
928 return ret;
929 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800930#endif
931#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100932#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800933#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100934 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
935 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200936 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100937 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800938#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100939 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100940 if (ret != 0) {
941 return ret;
942 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800943#endif
944#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100945 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800946}
947
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100948#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100949static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100950 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800951{
952#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200953 return mbedtls_md_error_from_psa(psa_hash_update(
954 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800955#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100956 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800957#endif
958}
959#endif
960
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100961#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100962static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100963 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800964{
965#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200966 return mbedtls_md_error_from_psa(psa_hash_update(
967 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800968#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100969 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800970#endif
971}
972#endif
973
Gilles Peskine449bd832023-01-11 14:50:10 +0100974static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200975{
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100978#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500979#if defined(MBEDTLS_USE_PSA_CRYPTO)
980 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500981#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100982 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200983#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500984#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100985#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500986#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500987 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500988#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100989 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200990#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500991#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200992
993 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100994
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200995#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100996 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200997#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200998#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001000#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001001#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02001002#if defined(MBEDTLS_USE_PSA_CRYPTO)
1003 handshake->psa_pake_ctx = psa_pake_operation_init();
1004 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
1005#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02001007#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02001008#if defined(MBEDTLS_SSL_CLI_C)
1009 handshake->ecjpake_cache = NULL;
1010 handshake->ecjpake_cache_len = 0;
1011#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001012#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001013
Gilles Peskineeccd8882020-03-10 12:19:08 +01001014#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001016#endif
1017
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001018#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1019 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1020#endif
Hanno Becker75173122019-02-06 16:18:31 +00001021
1022#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1023 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001025#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001026}
1027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029{
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001031
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001032#if defined(MBEDTLS_USE_PSA_CRYPTO)
1033 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1034 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001035#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1037 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001038#endif
1039
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001040#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001041#if defined(MBEDTLS_USE_PSA_CRYPTO)
1042 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1043 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001044#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 mbedtls_md_init(&transform->md_ctx_enc);
1046 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001047#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001048#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001049}
1050
Gilles Peskine449bd832023-01-11 14:50:10 +01001051void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001052{
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001054}
1055
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001056MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001057static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001058{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001059 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1060
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001061 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001062#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 if (ssl->transform_negotiate) {
1064 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1065 }
Jerry Yu2e199812022-12-01 18:57:19 +08001066#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001067 if (ssl->session_negotiate) {
1068 mbedtls_ssl_session_free(ssl->session_negotiate);
1069 }
1070 if (ssl->handshake) {
1071 mbedtls_ssl_handshake_free(ssl);
1072 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001073
Jerry Yu2e199812022-12-01 18:57:19 +08001074#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001075 /*
1076 * Either the pointers are now NULL or cleared properly and can be freed.
1077 * Now allocate missing structures.
1078 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 if (ssl->transform_negotiate == NULL) {
1080 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001081 }
Jerry Yu2e199812022-12-01 18:57:19 +08001082#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001083
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 if (ssl->session_negotiate == NULL) {
1085 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001086 }
Paul Bakker48916f92012-09-16 19:57:18 +00001087
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 if (ssl->handshake == NULL) {
1089 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001090 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001091#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1092 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1095 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001096#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001097
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001098 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001100#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001101 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001102#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 ssl->session_negotiate == NULL) {
1104 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001107 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001108
1109#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001111 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001112#endif
1113
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001115 ssl->session_negotiate = NULL;
1116
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001118 }
1119
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001120 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 mbedtls_ssl_session_init(ssl->session_negotiate);
1122 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001123
Jerry Yu2e199812022-12-01 18:57:19 +08001124#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001126#endif
1127
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001128 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001129 ret = mbedtls_ssl_reset_checksum(ssl);
1130 if (ret != 0) {
1131 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1132 return ret;
1133 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001134
Jerry Yud0766ec2022-09-22 10:46:57 +08001135#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1136 defined(MBEDTLS_SSL_SRV_C) && \
1137 defined(MBEDTLS_SSL_SESSION_TICKETS)
1138 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001140#endif
1141
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001142#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001144 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001145
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001147 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001149 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001151
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001153 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001154#endif
1155
Brett Warrene0edc842021-08-17 09:53:13 +01001156/*
1157 * curve_list is translated to IANA TLS group identifiers here because
1158 * mbedtls_ssl_conf_curves returns void and so can't return
1159 * any error codes.
1160 */
Valerio Setti6c496a12023-04-07 15:53:51 +02001161#if defined(MBEDTLS_ECP_LIGHT)
Brett Warrene0edc842021-08-17 09:53:13 +01001162#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1163 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001165 size_t length;
1166 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1167
Thomas Daubney850a0792023-05-22 12:05:03 +01001168 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 }
Brett Warrene0edc842021-08-17 09:53:13 +01001170
1171 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1173 if (group_list == NULL) {
1174 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1175 }
Brett Warrene0edc842021-08-17 09:53:13 +01001176
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001178 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 curve_list[i]);
1180 if (tls_id == 0) {
1181 mbedtls_free(group_list);
1182 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001183 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001184 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001185 }
1186
1187 group_list[length] = 0;
1188
1189 ssl->handshake->group_list = group_list;
1190 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001191 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001192 ssl->handshake->group_list = ssl->conf->group_list;
1193 ssl->handshake->group_list_heap_allocated = 0;
1194 }
1195#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6c496a12023-04-07 15:53:51 +02001196#endif /* MBEDTLS_ECP_LIGHT */
Brett Warrene0edc842021-08-17 09:53:13 +01001197
Ronald Crone68ab4f2022-10-05 12:46:29 +02001198#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001199#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001200#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001201 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1202 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1204 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001205 const int *md;
1206 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001207 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001208 uint16_t *p;
1209
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001210 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1211 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1212 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001213
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1215 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001216 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 }
Valerio Setti75fba322023-02-23 17:35:09 +01001218#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001220#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001221
Jerry Yub476a442022-01-21 18:14:45 +08001222#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001224#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1226 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1227 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001228 }
1229
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1231 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1232 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001233
Gilles Peskine449bd832023-01-11 14:50:10 +01001234 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1235 sizeof(uint16_t));
1236 if (ssl->handshake->sig_algs == NULL) {
1237 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1238 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001239
Gilles Peskine449bd832023-01-11 14:50:10 +01001240 p = (uint16_t *) ssl->handshake->sig_algs;
1241 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1242 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1243 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001244 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 }
Valerio Setti75fba322023-02-23 17:35:09 +01001246#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001248 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001249#endif
1250#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001251 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001252 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001253#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001254 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001255 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001256 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001257 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001258#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001259 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001260 ssl->handshake->sig_algs_heap_allocated = 0;
1261 }
Jerry Yucc539102022-06-27 16:27:35 +08001262#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001263#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001265}
1266
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001267#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001268/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001269MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001270static int ssl_cookie_write_dummy(void *ctx,
1271 unsigned char **p, unsigned char *end,
1272 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001273{
1274 ((void) ctx);
1275 ((void) p);
1276 ((void) end);
1277 ((void) cli_id);
1278 ((void) cli_id_len);
1279
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001281}
1282
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001283MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001284static int ssl_cookie_check_dummy(void *ctx,
1285 const unsigned char *cookie, size_t cookie_len,
1286 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001287{
1288 ((void) ctx);
1289 ((void) cookie);
1290 ((void) cookie_len);
1291 ((void) cli_id);
1292 ((void) cli_id_len);
1293
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001295}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001296#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001297
Paul Bakker5121ce52009-01-03 21:22:43 +00001298/*
1299 * Initialize an SSL context
1300 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001301void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001302{
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001304}
1305
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001306MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001307static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001308{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001309 const mbedtls_ssl_config *conf = ssl->conf;
1310
Ronald Cron6f135e12021-12-08 16:57:54 +01001311#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001312 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1313 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1314 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1315 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001316 }
1317
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1319 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001320 }
1321#endif
1322
1323#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1325 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1326 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001327 }
1328#endif
1329
Ronald Cron6f135e12021-12-08 16:57:54 +01001330#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1332 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1333 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1334 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001335 }
1336
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1338 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001339 }
1340#endif
1341
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1343 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001344}
1345
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001346MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001347static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1348{
1349 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 ret = ssl_conf_version_check(ssl);
1351 if (ret != 0) {
1352 return ret;
1353 }
Jerry Yu60835a82021-08-04 10:13:52 +08001354
Jerry Yudef7ae42022-10-30 14:13:19 +08001355#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1356 /* RFC 8446 section 4.4.3
1357 *
1358 * If the verification fails, the receiver MUST terminate the handshake with
1359 * a "decrypt_error" alert.
1360 *
1361 * If the client is configured as TLS 1.3 only with optional verify, return
1362 * bad config.
1363 *
1364 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1366 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001367 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1368 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1369 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001371 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 1, ("Optional verify auth mode "
1373 "is not available for TLS 1.3 client"));
1374 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001375 }
1376#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1377
Jerry Yu60835a82021-08-04 10:13:52 +08001378 /* Space for further checks */
1379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001381}
1382
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001383/*
1384 * Setup an SSL context
1385 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001386
Gilles Peskine449bd832023-01-11 14:50:10 +01001387int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1388 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001389{
Janos Follath865b3eb2019-12-16 11:46:15 +00001390 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001391 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1392 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001393
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001394 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001395
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 if ((ret = ssl_conf_check(ssl)) != 0) {
1397 return ret;
1398 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001399 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001400
Paul Bakker62f2dee2012-09-28 07:31:51 +00001401 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001402 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001403 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001404
1405 /* Set to NULL in case of an error condition */
1406 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001407
Darryl Greenb33cc762019-11-28 14:29:44 +00001408#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1409 ssl->in_buf_len = in_buf_len;
1410#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1412 if (ssl->in_buf == NULL) {
1413 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001414 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001415 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001416 }
1417
Darryl Greenb33cc762019-11-28 14:29:44 +00001418#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1419 ssl->out_buf_len = out_buf_len;
1420#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1422 if (ssl->out_buf == NULL) {
1423 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001424 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001425 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001426 }
1427
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001429
Johan Pascalb62bb512015-12-03 21:56:45 +01001430#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001432#endif
1433
Gilles Peskine449bd832023-01-11 14:50:10 +01001434 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001435 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001436 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001437
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001439
1440error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 mbedtls_free(ssl->in_buf);
1442 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001443
1444 ssl->conf = NULL;
1445
Darryl Greenb33cc762019-11-28 14:29:44 +00001446#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1447 ssl->in_buf_len = 0;
1448 ssl->out_buf_len = 0;
1449#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001450 ssl->in_buf = NULL;
1451 ssl->out_buf = NULL;
1452
1453 ssl->in_hdr = NULL;
1454 ssl->in_ctr = NULL;
1455 ssl->in_len = NULL;
1456 ssl->in_iv = NULL;
1457 ssl->in_msg = NULL;
1458
1459 ssl->out_hdr = NULL;
1460 ssl->out_ctr = NULL;
1461 ssl->out_len = NULL;
1462 ssl->out_iv = NULL;
1463 ssl->out_msg = NULL;
1464
Gilles Peskine449bd832023-01-11 14:50:10 +01001465 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001466}
1467
1468/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001469 * Reset an initialized and used SSL context for re-use while retaining
1470 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001471 *
1472 * If partial is non-zero, keep data in the input buffer and client ID.
1473 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001474 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001475void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1476 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001477{
Darryl Greenb33cc762019-11-28 14:29:44 +00001478#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1479 size_t in_buf_len = ssl->in_buf_len;
1480 size_t out_buf_len = ssl->out_buf_len;
1481#else
1482 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1483 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1484#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001485
Hanno Beckerb0302c42021-08-03 09:39:42 +01001486#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1487 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001488#endif
1489
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001490 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001491 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001492
Gilles Peskine449bd832023-01-11 14:50:10 +01001493 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001494
1495 /* Reset incoming message parsing */
1496 ssl->in_offt = NULL;
1497 ssl->nb_zero = 0;
1498 ssl->in_msgtype = 0;
1499 ssl->in_msglen = 0;
1500 ssl->in_hslen = 0;
1501 ssl->keep_current_message = 0;
1502 ssl->transform_in = NULL;
1503
1504#if defined(MBEDTLS_SSL_PROTO_DTLS)
1505 ssl->next_record_offset = 0;
1506 ssl->in_epoch = 0;
1507#endif
1508
1509 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001511 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001513 }
1514
Ronald Cronad8c17b2022-06-10 17:18:09 +02001515 ssl->send_alert = 0;
1516
Hanno Beckerb0302c42021-08-03 09:39:42 +01001517 /* Reset outgoing message writing */
1518 ssl->out_msgtype = 0;
1519 ssl->out_msglen = 0;
1520 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 memset(ssl->out_buf, 0, out_buf_len);
1522 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001523 ssl->transform_out = NULL;
1524
1525#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001527#endif
1528
XiaokangQian2b01dc32022-01-21 02:53:13 +00001529#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 if (ssl->transform) {
1531 mbedtls_ssl_transform_free(ssl->transform);
1532 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001533 ssl->transform = NULL;
1534 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001535#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1536
XiaokangQian2b01dc32022-01-21 02:53:13 +00001537#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001538 mbedtls_ssl_transform_free(ssl->transform_application);
1539 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001540 ssl->transform_application = NULL;
1541
Gilles Peskine449bd832023-01-11 14:50:10 +01001542 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001543#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1545 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001546 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001547#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1550 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001551 ssl->handshake->transform_handshake = NULL;
1552 }
1553
XiaokangQian2b01dc32022-01-21 02:53:13 +00001554#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001555}
1556
Gilles Peskine449bd832023-01-11 14:50:10 +01001557int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001558{
1559 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1560
1561 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1562
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001564
1565 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566#if defined(MBEDTLS_SSL_RENEGOTIATION)
1567 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001568 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001569
1570 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1572 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001573#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001574 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001575
Hanno Beckerb0302c42021-08-03 09:39:42 +01001576 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001577 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 if (ssl->session) {
1579 mbedtls_ssl_session_free(ssl->session);
1580 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001581 ssl->session = NULL;
1582 }
1583
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001584#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001585 ssl->alpn_chosen = NULL;
1586#endif
1587
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001588#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001589 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001590#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001592#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 if (free_cli_id) {
1594 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001595 ssl->cli_id = NULL;
1596 ssl->cli_id_len = 0;
1597 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001598#endif
1599
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 if ((ret = ssl_handshake_init(ssl)) != 0) {
1601 return ret;
1602 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001603
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001605}
1606
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001607/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001608 * Reset an initialized and used SSL context for re-use while retaining
1609 * all application-set variables, function pointers and data.
1610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001611int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001612{
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001614}
1615
1616/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001617 * SSL set accessors
1618 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001619void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001620{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001621 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001622}
1623
Gilles Peskine449bd832023-01-11 14:50:10 +01001624void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001625{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001626 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001627}
1628
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001629#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001630void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001631{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001632 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001633}
1634#endif
1635
Gilles Peskine449bd832023-01-11 14:50:10 +01001636void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001637{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001638 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001639}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001640
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001641#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001642
Gilles Peskine449bd832023-01-11 14:50:10 +01001643void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1644 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001645{
1646 ssl->disable_datagram_packing = !allow_packing;
1647}
1648
Gilles Peskine449bd832023-01-11 14:50:10 +01001649void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1650 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001651{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001652 conf->hs_timeout_min = min;
1653 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001654}
1655#endif
1656
Gilles Peskine449bd832023-01-11 14:50:10 +01001657void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001658{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001659 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001660}
1661
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001663void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1664 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1665 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001666{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001667 conf->f_vrfy = f_vrfy;
1668 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001669}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001670#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1673 int (*f_rng)(void *, unsigned char *, size_t),
1674 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001675{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001676 conf->f_rng = f_rng;
1677 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001678}
1679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1681 void (*f_dbg)(void *, int, const char *, int, const char *),
1682 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001683{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001684 conf->f_dbg = f_dbg;
1685 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001686}
1687
Gilles Peskine449bd832023-01-11 14:50:10 +01001688void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1689 void *p_bio,
1690 mbedtls_ssl_send_t *f_send,
1691 mbedtls_ssl_recv_t *f_recv,
1692 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001693{
1694 ssl->p_bio = p_bio;
1695 ssl->f_send = f_send;
1696 ssl->f_recv = f_recv;
1697 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001698}
1699
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001700#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001701void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001702{
1703 ssl->mtu = mtu;
1704}
1705#endif
1706
Gilles Peskine449bd832023-01-11 14:50:10 +01001707void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001708{
1709 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001710}
1711
Gilles Peskine449bd832023-01-11 14:50:10 +01001712void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1713 void *p_timer,
1714 mbedtls_ssl_set_timer_t *f_set_timer,
1715 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001716{
1717 ssl->p_timer = p_timer;
1718 ssl->f_set_timer = f_set_timer;
1719 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001720
1721 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001723}
1724
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001726void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1727 void *p_cache,
1728 mbedtls_ssl_cache_get_t *f_get_cache,
1729 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001730{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001731 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001732 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001733 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001734}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001735#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001736
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001737#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001738int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001739{
Janos Follath865b3eb2019-12-16 11:46:15 +00001740 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001741
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001743 session == NULL ||
1744 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1746 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001747 }
1748
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 if (ssl->handshake->resume == 1) {
1750 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1751 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001752
Jerry Yu21092062022-10-10 21:21:31 +08001753#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001755 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001757
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001759 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1761 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1762 session->ciphersuite));
1763 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001764 }
Jerry Yu40afab62022-10-08 10:42:13 +08001765 }
Jerry Yu21092062022-10-10 21:21:31 +08001766#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001767
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1769 session)) != 0) {
1770 return ret;
1771 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001772
Paul Bakker0a597072012-09-25 21:55:46 +00001773 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001776}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001777#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001778
Gilles Peskine449bd832023-01-11 14:50:10 +01001779void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1780 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001781{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001782 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001783}
1784
Ronald Cron6f135e12021-12-08 16:57:54 +01001785#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001786void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1787 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001788{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001789 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001790}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001791
1792#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001793void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
1794 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001795{
1796 conf->early_data_enabled = early_data_enabled;
1797}
Jerry Yucc4e0072022-11-22 17:22:22 +08001798
1799#if defined(MBEDTLS_SSL_SRV_C)
1800void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001802{
Jerry Yu39da9852022-12-06 16:58:36 +08001803 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001804}
1805#endif /* MBEDTLS_SSL_SRV_C */
1806
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001807#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001808#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001809
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001811void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1812 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001813{
1814 conf->cert_profile = profile;
1815}
1816
Gilles Peskine449bd832023-01-11 14:50:10 +01001817static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001818{
1819 mbedtls_ssl_key_cert *cur = key_cert, *next;
1820
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001822 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001824 cur = next;
1825 }
1826}
1827
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001828/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001829MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001830static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1831 mbedtls_x509_crt *cert,
1832 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001833{
niisato8ee24222018-06-25 19:05:48 +09001834 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001835
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001837 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001839 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001841 }
1842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1844 if (new_cert == NULL) {
1845 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1846 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001847
niisato8ee24222018-06-25 19:05:48 +09001848 new_cert->cert = cert;
1849 new_cert->key = key;
1850 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001851
Glenn Strauss36872db2022-01-22 05:06:31 -05001852 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001854 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001856 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001858 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 }
niisato8ee24222018-06-25 19:05:48 +09001860 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001861 }
1862
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001864}
1865
Gilles Peskine449bd832023-01-11 14:50:10 +01001866int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001867 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001869{
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001871}
1872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001874 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001876{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001877 conf->ca_chain = ca_chain;
1878 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001879
1880#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1881 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1882 * cannot be used together. */
1883 conf->f_ca_cb = NULL;
1884 conf->p_ca_cb = NULL;
1885#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001886}
Hanno Becker5adaad92019-03-27 16:54:37 +00001887
1888#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001889void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1890 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1891 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001892{
1893 conf->f_ca_cb = f_ca_cb;
1894 conf->p_ca_cb = p_ca_cb;
1895
1896 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1897 * cannot be used together. */
1898 conf->ca_chain = NULL;
1899 conf->ca_crl = NULL;
1900}
1901#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001903
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001904#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001905const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1906 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001907{
1908 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001910}
1911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1913 mbedtls_x509_crt *own_cert,
1914 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001915{
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1917 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001918}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1921 mbedtls_x509_crt *ca_chain,
1922 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001923{
1924 ssl->handshake->sni_ca_chain = ca_chain;
1925 ssl->handshake->sni_ca_crl = ca_crl;
1926}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001927
Glenn Strauss999ef702022-03-11 01:37:23 -05001928#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001929void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1930 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001931{
1932 ssl->handshake->dn_hints = crt;
1933}
1934#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1935
Gilles Peskine449bd832023-01-11 14:50:10 +01001936void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1937 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001938{
1939 ssl->handshake->sni_authmode = authmode;
1940}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001941#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1942
Hanno Becker8927c832019-04-03 12:52:50 +01001943#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001944void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1945 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1946 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001947{
1948 ssl->f_vrfy = f_vrfy;
1949 ssl->p_vrfy = p_vrfy;
1950}
1951#endif
1952
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001953#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001954
Valerio Setti016f6822022-12-09 14:17:50 +01001955#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001956static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1957static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1958
Valerio Setti016f6822022-12-09 14:17:50 +01001959static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 mbedtls_ssl_context *ssl,
1961 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001962{
1963 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001964 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001965 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001966 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001967 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001968 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1970 psa_pake_cs_set_primitive(&cipher_suite,
1971 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1972 PSA_ECC_FAMILY_SECP_R1,
1973 256));
1974 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001975
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1977 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001978 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001980
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001982 user = jpake_server_id;
1983 user_len = sizeof(jpake_server_id);
1984 peer = jpake_client_id;
1985 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001987 user = jpake_client_id;
1988 user_len = sizeof(jpake_client_id);
1989 peer = jpake_server_id;
1990 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001992
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001993 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1994 if (status != PSA_SUCCESS) {
1995 return status;
1996 }
1997
1998 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002000 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 }
Valerio Setti016f6822022-12-09 14:17:50 +01002002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
2004 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002005 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 }
Valerio Setti016f6822022-12-09 14:17:50 +01002007
2008 ssl->handshake->psa_pake_ctx_is_ok = 1;
2009
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002011}
2012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2014 const unsigned char *pw,
2015 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002016{
2017 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2018 psa_status_t status;
2019
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 if (ssl->handshake == NULL || ssl->conf == NULL) {
2021 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002022 }
2023
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 /* Empty password is not valid */
2025 if ((pw == NULL) || (pw_len == 0)) {
2026 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2027 }
2028
2029 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2030 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2031 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2032
2033 status = psa_import_key(&attributes, pw, pw_len,
2034 &ssl->handshake->psa_pake_password);
2035 if (status != PSA_SUCCESS) {
2036 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2037 }
2038
2039 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2040 ssl->handshake->psa_pake_password);
2041 if (status != PSA_SUCCESS) {
2042 psa_destroy_key(ssl->handshake->psa_pake_password);
2043 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2044 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2045 }
2046
2047 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002048}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002049
Gilles Peskine449bd832023-01-11 14:50:10 +01002050int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2051 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002052{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002053 psa_status_t status;
2054
Gilles Peskine449bd832023-01-11 14:50:10 +01002055 if (ssl->handshake == NULL || ssl->conf == NULL) {
2056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002057 }
2058
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 if (mbedtls_svc_key_id_is_null(pwd)) {
2060 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2061 }
2062
2063 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2064 if (status != PSA_SUCCESS) {
2065 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2066 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2067 }
2068
2069 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002070}
2071#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002072int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2073 const unsigned char *pw,
2074 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002075{
2076 mbedtls_ecjpake_role role;
2077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 if (ssl->handshake == NULL || ssl->conf == NULL) {
2079 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2080 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081
Valerio Settic689ed82022-12-07 14:40:38 +01002082 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 if ((pw == NULL) || (pw_len == 0)) {
2084 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2085 }
Valerio Settic689ed82022-12-07 14:40:38 +01002086
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002088 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002090 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002092
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2094 role,
2095 MBEDTLS_MD_SHA256,
2096 MBEDTLS_ECP_DP_SECP256R1,
2097 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002098}
Valerio Setti02c25b52022-11-15 14:08:42 +01002099#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002100#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002101
Ronald Cron73fe8df2022-10-05 14:31:43 +02002102#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002103int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002104{
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 if (conf->psk_identity == NULL ||
2106 conf->psk_identity_len == 0) {
2107 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002108 }
2109
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002110#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2112 return 1;
2113 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002114#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 if (conf->psk != NULL && conf->psk_len != 0) {
2117 return 1;
2118 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002119
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002121}
2122
Gilles Peskine449bd832023-01-11 14:50:10 +01002123static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002124{
2125 /* Remove reference to existing PSK, if any. */
2126#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002128 /* The maintenance of the PSK key slot is the
2129 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002130 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002131 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002132#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 if (conf->psk != NULL) {
2134 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002135
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 mbedtls_free(conf->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002137 conf->psk = NULL;
2138 conf->psk_len = 0;
2139 }
2140
2141 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 if (conf->psk_identity != NULL) {
2143 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002144 conf->psk_identity = NULL;
2145 conf->psk_identity_len = 0;
2146 }
2147}
2148
Hanno Becker7390c712018-11-15 13:33:04 +00002149/* This function assumes that PSK identity in the SSL config is unset.
2150 * It checks that the provided identity is well-formed and attempts
2151 * to make a copy of it in the SSL config.
2152 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002153MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002154static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2155 unsigned char const *psk_identity,
2156 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002157{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002158 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002160 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 (psk_identity_len >> 16) != 0 ||
2162 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2163 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002164 }
2165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2167 if (conf->psk_identity == NULL) {
2168 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2169 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002170
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002171 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002173
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002175}
2176
Gilles Peskine449bd832023-01-11 14:50:10 +01002177int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2178 const unsigned char *psk, size_t psk_len,
2179 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002180{
Janos Follath865b3eb2019-12-16 11:46:15 +00002181 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002182
2183 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2185 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2186 }
Hanno Becker7390c712018-11-15 13:33:04 +00002187
2188 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if (psk == NULL) {
2190 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2191 }
2192 if (psk_len == 0) {
2193 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2194 }
2195 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2196 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2197 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002198
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2200 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2201 }
Hanno Becker7390c712018-11-15 13:33:04 +00002202 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002204
2205 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2207 if (ret != 0) {
2208 ssl_conf_remove_psk(conf);
2209 }
Hanno Becker7390c712018-11-15 13:33:04 +00002210
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002212}
2213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002215{
2216#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002218 /* The maintenance of the external PSK key slot is the
2219 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 if (ssl->handshake->psk_opaque_is_internal) {
2221 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002222 ssl->handshake->psk_opaque_is_internal = 0;
2223 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002224 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002225 }
Neil Armstronge952a302022-05-03 10:22:14 +02002226#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 if (ssl->handshake->psk != NULL) {
2228 mbedtls_platform_zeroize(ssl->handshake->psk,
2229 ssl->handshake->psk_len);
2230 mbedtls_free(ssl->handshake->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002231 ssl->handshake->psk_len = 0;
2232 }
Neil Armstronge952a302022-05-03 10:22:14 +02002233#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002234}
2235
Gilles Peskine449bd832023-01-11 14:50:10 +01002236int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2237 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002238{
Neil Armstrong501c9322022-05-03 09:35:09 +02002239#if defined(MBEDTLS_USE_PSA_CRYPTO)
2240 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002241 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002242 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002243 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002244#endif /* MBEDTLS_USE_PSA_CRYPTO */
2245
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 if (psk == NULL || ssl->handshake == NULL) {
2247 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2248 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002249
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2251 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2252 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002253
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002255
Neil Armstrong501c9322022-05-03 09:35:09 +02002256#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002257#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2259 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2260 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2261 } else {
2262 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2263 }
2264 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002265 }
2266#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002267
Jerry Yu568ec252022-07-22 21:27:34 +08002268#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2270 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2271 psa_set_key_usage_flags(&key_attributes,
2272 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002273 }
2274#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2275
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 psa_set_key_algorithm(&key_attributes, alg);
2277 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002278
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2280 if (status != PSA_SUCCESS) {
2281 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2282 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002283
2284 /* Allow calling psa_destroy_key() on psk remove */
2285 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002287#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2289 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2290 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002291
2292 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002294
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002296#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002297}
2298
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002299#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002300int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2301 mbedtls_svc_key_id_t psk,
2302 const unsigned char *psk_identity,
2303 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002304{
Janos Follath865b3eb2019-12-16 11:46:15 +00002305 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002306
2307 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2309 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2310 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002311
Hanno Becker7390c712018-11-15 13:33:04 +00002312 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 if (mbedtls_svc_key_id_is_null(psk)) {
2314 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2315 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002316 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002317
2318 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2320 psk_identity_len);
2321 if (ret != 0) {
2322 ssl_conf_remove_psk(conf);
2323 }
Hanno Becker7390c712018-11-15 13:33:04 +00002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002326}
2327
Gilles Peskine449bd832023-01-11 14:50:10 +01002328int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2329 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002330{
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 if ((mbedtls_svc_key_id_is_null(psk)) ||
2332 (ssl->handshake == NULL)) {
2333 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2334 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002335
Gilles Peskine449bd832023-01-11 14:50:10 +01002336 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002337 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002339}
2340#endif /* MBEDTLS_USE_PSA_CRYPTO */
2341
Jerry Yu8897c072022-08-12 13:56:53 +08002342#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002343void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2344 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2345 size_t),
2346 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002347{
2348 conf->f_psk = f_psk;
2349 conf->p_psk = p_psk;
2350}
Jerry Yu8897c072022-08-12 13:56:53 +08002351#endif /* MBEDTLS_SSL_SRV_C */
2352
Ronald Cron73fe8df2022-10-05 14:31:43 +02002353#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002354
2355#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002356static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002357 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002358{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002359#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 if (alg == PSA_ALG_CBC_NO_PADDING) {
2361 return MBEDTLS_SSL_MODE_CBC;
2362 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002363#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 if (PSA_ALG_IS_AEAD(alg)) {
2365 return MBEDTLS_SSL_MODE_AEAD;
2366 }
2367 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002368}
2369
2370#else /* MBEDTLS_USE_PSA_CRYPTO */
2371
2372static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002374{
2375#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (mode == MBEDTLS_MODE_CBC) {
2377 return MBEDTLS_SSL_MODE_CBC;
2378 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002379#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2380
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381#if defined(MBEDTLS_GCM_C) || \
2382 defined(MBEDTLS_CCM_C) || \
2383 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002385 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 mode == MBEDTLS_MODE_CHACHAPOLY) {
2387 return MBEDTLS_SSL_MODE_AEAD;
2388 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002389#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002390
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002392}
Gilles Peskine301711e2022-04-26 16:57:05 +02002393#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002394
Gilles Peskinee108d982022-04-26 16:50:40 +02002395static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2396 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002398{
2399#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2401 base_mode == MBEDTLS_SSL_MODE_CBC) {
2402 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002403 }
2404#else
2405 (void) encrypt_then_mac;
2406#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002408}
2409
Neil Armstrongab555e02022-04-04 11:07:59 +02002410mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002412{
Gilles Peskinee108d982022-04-26 16:50:40 +02002413 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002414#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002416#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002418#endif
2419 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002420
Gilles Peskinee108d982022-04-26 16:50:40 +02002421 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002422#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002423 encrypt_then_mac = transform->encrypt_then_mac;
2424#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002426}
2427
Neil Armstrongab555e02022-04-04 11:07:59 +02002428mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002429#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002431#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002433{
Gilles Peskinee108d982022-04-26 16:50:40 +02002434 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2435
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002436#if defined(MBEDTLS_USE_PSA_CRYPTO)
2437 psa_status_t status;
2438 psa_algorithm_t alg;
2439 psa_key_type_t type;
2440 size_t size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 status = mbedtls_ssl_cipher_to_psa(suite->cipher, 0, &alg, &type, &size);
2442 if (status == PSA_SUCCESS) {
2443 base_mode = mbedtls_ssl_get_base_mode(alg);
2444 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002445#else
2446 const mbedtls_cipher_info_t *cipher =
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 mbedtls_cipher_info_from_type(suite->cipher);
2448 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002449 base_mode =
2450 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002452 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002453#endif /* MBEDTLS_USE_PSA_CRYPTO */
2454
Gilles Peskinee108d982022-04-26 16:50:40 +02002455#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2456 int encrypt_then_mac = 0;
2457#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002459}
2460
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002461#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002462
2463#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002464/* Serialization of TLS 1.3 sessions:
2465 *
2466 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002467 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002468 * uint64 ticket_received;
2469 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002470 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002471 * } ClientOnlyData;
2472 *
2473 * struct {
2474 * uint8 endpoint;
2475 * uint8 ciphersuite[2];
2476 * uint32 ticket_age_add;
2477 * uint8 ticket_flags;
2478 * opaque resumption_key<0..255>;
2479 * select ( endpoint ) {
2480 * case client: ClientOnlyData;
2481 * case server: uint64 start_time;
2482 * };
2483 * } serialized_session_tls13;
2484 *
2485 */
2486#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002487MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002488static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2489 unsigned char *buf,
2490 size_t buf_len,
2491 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002492{
2493 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002494#if defined(MBEDTLS_SSL_CLI_C) && \
2495 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 size_t hostname_len = (session->hostname == NULL) ?
2497 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002498#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002499 size_t needed = 1 /* endpoint */
2500 + 2 /* ciphersuite */
2501 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002502 + 1 /* ticket_flags */
2503 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002504 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002505
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2507 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2508 }
Jerry Yu34191072022-08-18 10:32:09 +08002509 needed += session->resumption_key_len; /* resumption_key */
2510
Jerry Yu438ddd82022-07-07 06:55:50 +00002511#if defined(MBEDTLS_HAVE_TIME)
2512 needed += 8; /* start_time or ticket_received */
2513#endif
2514
2515#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002517#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002518 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002520#endif
2521
Jerry Yu438ddd82022-07-07 06:55:50 +00002522 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002523 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002524
2525 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002526 if (session->ticket_len > SIZE_MAX - needed) {
2527 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2528 }
Jerry Yu34191072022-08-18 10:32:09 +08002529
Jerry Yue28d9742022-08-18 15:44:03 +08002530 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002531 }
2532#endif /* MBEDTLS_SSL_CLI_C */
2533
Jerry Yue36fdd62022-08-17 21:31:36 +08002534 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 if (needed > buf_len) {
2536 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2537 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002538
2539 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2541 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002542 p[7] = session->ticket_flags;
2543
2544 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002545 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002546 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002548 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002549
2550#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2552 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002553 p += 8;
2554 }
2555#endif /* MBEDTLS_HAVE_TIME */
2556
2557#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002559#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002561 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002563 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002565 p += hostname_len;
2566 }
2567#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2568
Jerry Yu438ddd82022-07-07 06:55:50 +00002569#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002571 p += 8;
2572#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002574 p += 4;
2575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002577 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002578
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 if (session->ticket != NULL && session->ticket_len > 0) {
2580 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002581 p += session->ticket_len;
2582 }
2583 }
2584#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002586}
2587
2588MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002589static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2590 const unsigned char *buf,
2591 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002592{
2593 const unsigned char *p = buf;
2594 const unsigned char *end = buf + len;
2595
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 if (end - p < 9) {
2597 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2598 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002599 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2601 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002602 session->ticket_flags = p[7];
2603
2604 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002605 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002606 p += 9;
2607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 if (end - p < session->resumption_key_len) {
2609 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2610 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002611
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2614 }
2615 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002616 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002617
2618#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2620 if (end - p < 8) {
2621 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2622 }
2623 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002624 p += 8;
2625 }
2626#endif /* MBEDTLS_HAVE_TIME */
2627
2628#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002630#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002632 size_t hostname_len;
2633 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 if (end - p < 2) {
2635 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2636 }
2637 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002638 p += 2;
2639
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 if (end - p < (long int) hostname_len) {
2641 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2642 }
2643 if (hostname_len > 0) {
2644 session->hostname = mbedtls_calloc(1, hostname_len);
2645 if (session->hostname == NULL) {
2646 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2647 }
2648 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002649 p += hostname_len;
2650 }
2651#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2652 MBEDTLS_SSL_SESSION_TICKETS */
2653
Jerry Yu438ddd82022-07-07 06:55:50 +00002654#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 if (end - p < 8) {
2656 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2657 }
2658 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002659 p += 8;
2660#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if (end - p < 4) {
2662 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2663 }
2664 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002665 p += 4;
2666
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 if (end - p < 2) {
2668 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2669 }
2670 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002671 p += 2;
2672
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 if (end - p < (long int) session->ticket_len) {
2674 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2675 }
2676 if (session->ticket_len > 0) {
2677 session->ticket = mbedtls_calloc(1, session->ticket_len);
2678 if (session->ticket == NULL) {
2679 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2680 }
2681 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002682 p += session->ticket_len;
2683 }
2684 }
2685#endif /* MBEDTLS_SSL_CLI_C */
2686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002688
2689}
2690#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002691MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002692static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2693 unsigned char *buf,
2694 size_t buf_len,
2695 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002696{
2697 ((void) session);
2698 ((void) buf);
2699 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002700 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002702}
Jerry Yu438ddd82022-07-07 06:55:50 +00002703
Gilles Peskine449bd832023-01-11 14:50:10 +01002704static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2705 unsigned char *buf,
2706 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002707{
2708 ((void) session);
2709 ((void) buf);
2710 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002712}
2713#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002714#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2715
Gilles Peskine449bd832023-01-11 14:50:10 +01002716psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2717 size_t taglen,
2718 psa_algorithm_t *alg,
2719 psa_key_type_t *key_type,
2720 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002721{
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002723 case MBEDTLS_CIPHER_AES_128_CBC:
2724 *alg = PSA_ALG_CBC_NO_PADDING;
2725 *key_type = PSA_KEY_TYPE_AES;
2726 *key_size = 128;
2727 break;
2728 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002729 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002730 *key_type = PSA_KEY_TYPE_AES;
2731 *key_size = 128;
2732 break;
2733 case MBEDTLS_CIPHER_AES_128_GCM:
2734 *alg = PSA_ALG_GCM;
2735 *key_type = PSA_KEY_TYPE_AES;
2736 *key_size = 128;
2737 break;
2738 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002740 *key_type = PSA_KEY_TYPE_AES;
2741 *key_size = 192;
2742 break;
2743 case MBEDTLS_CIPHER_AES_192_GCM:
2744 *alg = PSA_ALG_GCM;
2745 *key_type = PSA_KEY_TYPE_AES;
2746 *key_size = 192;
2747 break;
2748 case MBEDTLS_CIPHER_AES_256_CBC:
2749 *alg = PSA_ALG_CBC_NO_PADDING;
2750 *key_type = PSA_KEY_TYPE_AES;
2751 *key_size = 256;
2752 break;
2753 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002755 *key_type = PSA_KEY_TYPE_AES;
2756 *key_size = 256;
2757 break;
2758 case MBEDTLS_CIPHER_AES_256_GCM:
2759 *alg = PSA_ALG_GCM;
2760 *key_type = PSA_KEY_TYPE_AES;
2761 *key_size = 256;
2762 break;
2763 case MBEDTLS_CIPHER_ARIA_128_CBC:
2764 *alg = PSA_ALG_CBC_NO_PADDING;
2765 *key_type = PSA_KEY_TYPE_ARIA;
2766 *key_size = 128;
2767 break;
2768 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002770 *key_type = PSA_KEY_TYPE_ARIA;
2771 *key_size = 128;
2772 break;
2773 case MBEDTLS_CIPHER_ARIA_128_GCM:
2774 *alg = PSA_ALG_GCM;
2775 *key_type = PSA_KEY_TYPE_ARIA;
2776 *key_size = 128;
2777 break;
2778 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002780 *key_type = PSA_KEY_TYPE_ARIA;
2781 *key_size = 192;
2782 break;
2783 case MBEDTLS_CIPHER_ARIA_192_GCM:
2784 *alg = PSA_ALG_GCM;
2785 *key_type = PSA_KEY_TYPE_ARIA;
2786 *key_size = 192;
2787 break;
2788 case MBEDTLS_CIPHER_ARIA_256_CBC:
2789 *alg = PSA_ALG_CBC_NO_PADDING;
2790 *key_type = PSA_KEY_TYPE_ARIA;
2791 *key_size = 256;
2792 break;
2793 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002795 *key_type = PSA_KEY_TYPE_ARIA;
2796 *key_size = 256;
2797 break;
2798 case MBEDTLS_CIPHER_ARIA_256_GCM:
2799 *alg = PSA_ALG_GCM;
2800 *key_type = PSA_KEY_TYPE_ARIA;
2801 *key_size = 256;
2802 break;
2803 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2804 *alg = PSA_ALG_CBC_NO_PADDING;
2805 *key_type = PSA_KEY_TYPE_CAMELLIA;
2806 *key_size = 128;
2807 break;
2808 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002810 *key_type = PSA_KEY_TYPE_CAMELLIA;
2811 *key_size = 128;
2812 break;
2813 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2814 *alg = PSA_ALG_GCM;
2815 *key_type = PSA_KEY_TYPE_CAMELLIA;
2816 *key_size = 128;
2817 break;
2818 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002820 *key_type = PSA_KEY_TYPE_CAMELLIA;
2821 *key_size = 192;
2822 break;
2823 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2824 *alg = PSA_ALG_GCM;
2825 *key_type = PSA_KEY_TYPE_CAMELLIA;
2826 *key_size = 192;
2827 break;
2828 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2829 *alg = PSA_ALG_CBC_NO_PADDING;
2830 *key_type = PSA_KEY_TYPE_CAMELLIA;
2831 *key_size = 256;
2832 break;
2833 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002835 *key_type = PSA_KEY_TYPE_CAMELLIA;
2836 *key_size = 256;
2837 break;
2838 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2839 *alg = PSA_ALG_GCM;
2840 *key_type = PSA_KEY_TYPE_CAMELLIA;
2841 *key_size = 256;
2842 break;
2843 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2844 *alg = PSA_ALG_CHACHA20_POLY1305;
2845 *key_type = PSA_KEY_TYPE_CHACHA20;
2846 *key_size = 256;
2847 break;
2848 case MBEDTLS_CIPHER_NULL:
2849 *alg = MBEDTLS_SSL_NULL_CIPHER;
2850 *key_type = 0;
2851 *key_size = 0;
2852 break;
2853 default:
2854 return PSA_ERROR_NOT_SUPPORTED;
2855 }
2856
2857 return PSA_SUCCESS;
2858}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002859#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002860
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002861#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002862int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2863 const unsigned char *dhm_P, size_t P_len,
2864 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002865{
Janos Follath865b3eb2019-12-16 11:46:15 +00002866 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002867
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 mbedtls_mpi_free(&conf->dhm_P);
2869 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2872 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2873 mbedtls_mpi_free(&conf->dhm_P);
2874 mbedtls_mpi_free(&conf->dhm_G);
2875 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002876 }
2877
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002879}
Paul Bakker5121ce52009-01-03 21:22:43 +00002880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002882{
Janos Follath865b3eb2019-12-16 11:46:15 +00002883 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002884
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 mbedtls_mpi_free(&conf->dhm_P);
2886 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002887
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2889 &conf->dhm_P)) != 0 ||
2890 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2891 &conf->dhm_G)) != 0) {
2892 mbedtls_mpi_free(&conf->dhm_P);
2893 mbedtls_mpi_free(&conf->dhm_G);
2894 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002895 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002898}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002899#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002900
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002901#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2902/*
2903 * Set the minimum length for Diffie-Hellman parameters
2904 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002905void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2906 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002907{
2908 conf->dhm_min_bitlen = bitlen;
2909}
2910#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2911
Ronald Crone68ab4f2022-10-05 12:46:29 +02002912#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002913#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002914/*
2915 * Set allowed/preferred hashes for handshake signatures
2916 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002917void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2918 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002919{
2920 conf->sig_hashes = hashes;
2921}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002922#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002923
Jerry Yuf017ee42022-01-12 15:49:48 +08002924/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002925void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2926 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002927{
Jerry Yuf017ee42022-01-12 15:49:48 +08002928#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2929 conf->sig_hashes = NULL;
2930#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2931 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002932}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002933#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002934
Valerio Setti6c496a12023-04-07 15:53:51 +02002935#if defined(MBEDTLS_ECP_LIGHT)
Brett Warrene0edc842021-08-17 09:53:13 +01002936#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002937/*
2938 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002939 *
2940 * mbedtls_ssl_setup() takes the provided list
2941 * and translates it to a list of IANA TLS group identifiers,
2942 * stored in ssl->handshake->group_list.
2943 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002944 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002945void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2946 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002947{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002948 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002949 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002950}
Brett Warrene0edc842021-08-17 09:53:13 +01002951#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6c496a12023-04-07 15:53:51 +02002952#endif /* MBEDTLS_ECP_LIGHT */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002953
Brett Warrene0edc842021-08-17 09:53:13 +01002954/*
2955 * Set the allowed groups
2956 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002957void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2958 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002959{
2960#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2961 conf->curve_list = NULL;
2962#endif
2963 conf->group_list = group_list;
2964}
2965
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002966#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002967int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002968{
Hanno Becker947194e2017-04-07 13:25:49 +01002969 /* Initialize to suppress unnecessary compiler warning */
2970 size_t hostname_len = 0;
2971
2972 /* Check if new hostname is valid before
2973 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 if (hostname != NULL) {
2975 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2978 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2979 }
Hanno Becker947194e2017-04-07 13:25:49 +01002980 }
2981
2982 /* Now it's clear that we will overwrite the old hostname,
2983 * so we can free it safely */
2984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 if (ssl->hostname != NULL) {
2986 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
2987 mbedtls_free(ssl->hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002988 }
2989
2990 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002993 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 } else {
2995 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2996 if (ssl->hostname == NULL) {
2997 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2998 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002999
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003001
Hanno Becker947194e2017-04-07 13:25:49 +01003002 ssl->hostname[hostname_len] = '\0';
3003 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003006}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003007#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003008
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003009#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003010void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3011 int (*f_sni)(void *, mbedtls_ssl_context *,
3012 const unsigned char *, size_t),
3013 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003014{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003015 conf->f_sni = f_sni;
3016 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003017}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003018#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003019
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003021int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003022{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003023 size_t cur_len, tot_len;
3024 const char **p;
3025
3026 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003027 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3028 * MUST NOT be truncated."
3029 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003030 */
3031 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 for (p = protos; *p != NULL; p++) {
3033 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003034 tot_len += cur_len;
3035
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 if ((cur_len == 0) ||
3037 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3038 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3039 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3040 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003041 }
3042
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003043 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003044
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003046}
3047
Gilles Peskine449bd832023-01-11 14:50:10 +01003048const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003049{
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003051}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003052#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003053
Johan Pascalb62bb512015-12-03 21:56:45 +01003054#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003055void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3056 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003057{
3058 conf->dtls_srtp_mki_support = support_mki_value;
3059}
3060
Gilles Peskine449bd832023-01-11 14:50:10 +01003061int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3062 unsigned char *mki_value,
3063 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003064{
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003067 }
Ron Eldor591f1622018-01-22 12:30:04 +02003068
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3070 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003071 }
Ron Eldor591f1622018-01-22 12:30:04 +02003072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003074 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003076}
3077
Gilles Peskine449bd832023-01-11 14:50:10 +01003078int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3079 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003080{
Johan Pascal253d0262020-09-22 13:04:45 +02003081 const mbedtls_ssl_srtp_profile *p;
3082 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003083
Johan Pascal253d0262020-09-22 13:04:45 +02003084 /* check the profiles list: all entry must be valid,
3085 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3087 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3088 p++) {
3089 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003090 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003092 /* unsupported value, stop parsing and set the size to an error value */
3093 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003094 }
3095 }
3096
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3098 conf->dtls_srtp_profile_list = NULL;
3099 conf->dtls_srtp_profile_list_len = 0;
3100 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003101 }
3102
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003103 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003104 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003105
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003107}
3108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3110 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003111{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003112 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3113 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003115 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003117 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3119 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003120 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003121}
Johan Pascalb62bb512015-12-03 21:56:45 +01003122#endif /* MBEDTLS_SSL_DTLS_SRTP */
3123
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303124#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003125void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003126{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003127 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00003128}
3129
Gilles Peskine449bd832023-01-11 14:50:10 +01003130void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003131{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003132 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00003133}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303134#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003135
Janos Follath088ce432017-04-10 12:42:31 +01003136#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003137void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3138 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003139{
3140 conf->cert_req_ca_list = cert_req_ca_list;
3141}
3142#endif
3143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003144#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003145void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003146{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003147 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003148}
3149#endif
3150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003152void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003153{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003154 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003155}
3156#endif
3157
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003159int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003160{
Gilles Peskine449bd832023-01-11 14:50:10 +01003161 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3162 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3163 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003164 }
3165
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003166 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003167
Gilles Peskine449bd832023-01-11 14:50:10 +01003168 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003169}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003171
Gilles Peskine449bd832023-01-11 14:50:10 +01003172void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003173{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003174 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003175}
3176
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003177#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003178void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003179{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003180 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003181}
3182
Gilles Peskine449bd832023-01-11 14:50:10 +01003183void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003184{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003185 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003186}
3187
Gilles Peskine449bd832023-01-11 14:50:10 +01003188void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3189 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003190{
Gilles Peskine449bd832023-01-11 14:50:10 +01003191 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003192}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003195#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003196#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003197void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003198{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003199 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003200}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003201#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003202
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003203#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003204
Jerry Yud0766ec2022-09-22 10:46:57 +08003205#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003206void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3207 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003208{
Jerry Yud0766ec2022-09-22 10:46:57 +08003209 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003210}
3211#endif
3212
Gilles Peskine449bd832023-01-11 14:50:10 +01003213void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3214 mbedtls_ssl_ticket_write_t *f_ticket_write,
3215 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3216 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003217{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003218 conf->f_ticket_write = f_ticket_write;
3219 conf->f_ticket_parse = f_ticket_parse;
3220 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003221}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003222#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003223#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003224
Gilles Peskine449bd832023-01-11 14:50:10 +01003225void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3226 mbedtls_ssl_export_keys_t *f_export_keys,
3227 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003228{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003229 ssl->f_export_keys = f_export_keys;
3230 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003231}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003232
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003233#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003234void mbedtls_ssl_conf_async_private_cb(
3235 mbedtls_ssl_config *conf,
3236 mbedtls_ssl_async_sign_t *f_async_sign,
3237 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3238 mbedtls_ssl_async_resume_t *f_async_resume,
3239 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003241{
3242 conf->f_async_sign_start = f_async_sign;
3243 conf->f_async_decrypt_start = f_async_decrypt;
3244 conf->f_async_resume = f_async_resume;
3245 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003246 conf->p_async_config_data = async_config_data;
3247}
3248
Gilles Peskine449bd832023-01-11 14:50:10 +01003249void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003250{
Gilles Peskine449bd832023-01-11 14:50:10 +01003251 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003252}
3253
Gilles Peskine449bd832023-01-11 14:50:10 +01003254void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003255{
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 if (ssl->handshake == NULL) {
3257 return NULL;
3258 } else {
3259 return ssl->handshake->user_async_ctx;
3260 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003261}
3262
Gilles Peskine449bd832023-01-11 14:50:10 +01003263void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3264 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003265{
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003267 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003269}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003270#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003271
Paul Bakker5121ce52009-01-03 21:22:43 +00003272/*
3273 * SSL get accessors
3274 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003275uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003276{
Gilles Peskine449bd832023-01-11 14:50:10 +01003277 if (ssl->session != NULL) {
3278 return ssl->session->verify_result;
3279 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003280
Gilles Peskine449bd832023-01-11 14:50:10 +01003281 if (ssl->session_negotiate != NULL) {
3282 return ssl->session_negotiate->verify_result;
3283 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003284
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003286}
3287
Gilles Peskine449bd832023-01-11 14:50:10 +01003288int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003289{
Gilles Peskine449bd832023-01-11 14:50:10 +01003290 if (ssl == NULL || ssl->session == NULL) {
3291 return 0;
3292 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003293
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003295}
3296
Gilles Peskine449bd832023-01-11 14:50:10 +01003297const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003298{
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 if (ssl == NULL || ssl->session == NULL) {
3300 return NULL;
3301 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003302
Gilles Peskine449bd832023-01-11 14:50:10 +01003303 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003304}
3305
Gilles Peskine449bd832023-01-11 14:50:10 +01003306const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003307{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003308#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3310 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003311 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003313 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003315 }
3316 }
3317#endif
3318
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003320 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003321 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003322 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003323 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003324 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003325 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003326 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003327}
3328
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003329#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003330size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003331{
David Horstmann95d516f2021-05-04 18:36:56 +01003332 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003333 size_t read_mfl;
3334
Jerry Yuddda0502022-12-01 19:43:12 +08003335#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003336 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003337 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3338 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3339 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003340 }
Jerry Yuddda0502022-12-01 19:43:12 +08003341#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003342
3343 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 if (ssl->session_out != NULL) {
3345 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3346 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003347 max_len = read_mfl;
3348 }
3349 }
3350
Jerry Yuddda0502022-12-01 19:43:12 +08003351 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 if (ssl->session_negotiate != NULL) {
3353 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3354 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003355 max_len = read_mfl;
3356 }
3357 }
3358
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003360}
3361
Gilles Peskine449bd832023-01-11 14:50:10 +01003362size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003363{
3364 size_t max_len;
3365
3366 /*
3367 * Assume mfl_code is correct since it was checked when set
3368 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003369 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003370
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003371 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 if (ssl->session_out != NULL &&
3373 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3374 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003375 }
3376
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003377 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 if (ssl->session_negotiate != NULL &&
3379 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3380 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003381 }
3382
Gilles Peskine449bd832023-01-11 14:50:10 +01003383 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003384}
3385#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3386
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003387#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003388size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003389{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003390 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003391 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3392 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3393 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3394 return 0;
3395 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003396
Gilles Peskine449bd832023-01-11 14:50:10 +01003397 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3398 return ssl->mtu;
3399 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003400
Gilles Peskine449bd832023-01-11 14:50:10 +01003401 if (ssl->mtu == 0) {
3402 return ssl->handshake->mtu;
3403 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003404
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 return ssl->mtu < ssl->handshake->mtu ?
3406 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003407}
3408#endif /* MBEDTLS_SSL_PROTO_DTLS */
3409
Gilles Peskine449bd832023-01-11 14:50:10 +01003410int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003411{
3412 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3413
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003414#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3415 !defined(MBEDTLS_SSL_PROTO_DTLS)
3416 (void) ssl;
3417#endif
3418
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003419#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003421
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003423 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003425#endif
3426
3427#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003428 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3429 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3430 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003431 const size_t overhead = (size_t) ret;
3432
Gilles Peskine449bd832023-01-11 14:50:10 +01003433 if (ret < 0) {
3434 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003435 }
3436
Gilles Peskine449bd832023-01-11 14:50:10 +01003437 if (mtu <= overhead) {
3438 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3439 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3440 }
3441
3442 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003443 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003444 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003445 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003446#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003447
Hanno Becker0defedb2018-08-10 12:35:02 +01003448#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3449 !defined(MBEDTLS_SSL_PROTO_DTLS)
3450 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003451#endif
3452
Gilles Peskine449bd832023-01-11 14:50:10 +01003453 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003454}
3455
Gilles Peskine449bd832023-01-11 14:50:10 +01003456int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003457{
3458 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3459
3460#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3461 (void) ssl;
3462#endif
3463
3464#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003465 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003466
Gilles Peskine449bd832023-01-11 14:50:10 +01003467 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003468 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003469 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003470#endif
3471
Gilles Peskine449bd832023-01-11 14:50:10 +01003472 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003473}
3474
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003475#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003476const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003477{
Gilles Peskine449bd832023-01-11 14:50:10 +01003478 if (ssl == NULL || ssl->session == NULL) {
3479 return NULL;
3480 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003481
Hanno Beckere6824572019-02-07 13:18:46 +00003482#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003483 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003484#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003485 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003486#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003487}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003488#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003489
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003491int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3492 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003493{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003494 int ret;
3495
Gilles Peskine449bd832023-01-11 14:50:10 +01003496 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003497 dst == NULL ||
3498 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003499 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3500 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003501 }
3502
Hanno Beckere810bbc2021-05-14 16:01:05 +01003503 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3504 * idempotent: Each session can only be exported once.
3505 *
3506 * (This is in preparation for TLS 1.3 support where we will
3507 * need the ability to export multiple sessions (aka tickets),
3508 * which will be achieved by calling mbedtls_ssl_get_session()
3509 * multiple times until it fails.)
3510 *
3511 * Check whether we have already exported the current session,
3512 * and fail if so.
3513 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003514 if (ssl->session->exported == 1) {
3515 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3516 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003517
Gilles Peskine449bd832023-01-11 14:50:10 +01003518 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3519 if (ret != 0) {
3520 return ret;
3521 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003522
3523 /* Remember that we've exported the session. */
3524 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003525 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003526}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003527#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003528
Paul Bakker5121ce52009-01-03 21:22:43 +00003529/*
Hanno Beckera835da52019-05-16 12:39:07 +01003530 * Define ticket header determining Mbed TLS version
3531 * and structure of the ticket.
3532 */
3533
Hanno Becker94ef3b32019-05-16 12:50:45 +01003534/*
Hanno Becker50b59662019-05-28 14:30:45 +01003535 * Define bitflag determining compile-time settings influencing
3536 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003537 */
3538
Hanno Becker50b59662019-05-28 14:30:45 +01003539#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003540#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003541#else
Hanno Becker3e088662019-05-29 11:10:18 +01003542#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003543#endif /* MBEDTLS_HAVE_TIME */
3544
3545#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003546#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003547#else
Hanno Becker3e088662019-05-29 11:10:18 +01003548#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003549#endif /* MBEDTLS_X509_CRT_PARSE_C */
3550
3551#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003552#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003553#else
Hanno Becker3e088662019-05-29 11:10:18 +01003554#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003555#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3556
3557#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003558#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003559#else
Hanno Becker3e088662019-05-29 11:10:18 +01003560#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003561#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3562
Hanno Becker94ef3b32019-05-16 12:50:45 +01003563#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003564#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003565#else
Hanno Becker3e088662019-05-29 11:10:18 +01003566#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003567#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3568
Hanno Becker94ef3b32019-05-16 12:50:45 +01003569#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3570#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3571#else
3572#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3573#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3574
Hanno Becker3e088662019-05-29 11:10:18 +01003575#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3576#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3577#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3578#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003579#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3580#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003581
Hanno Becker50b59662019-05-28 14:30:45 +01003582#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003583 ((uint16_t) ( \
3584 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3585 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3586 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3587 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3588 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3589 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3590 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003591
Hanno Beckerf8787072019-05-16 12:41:07 +01003592static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003593 MBEDTLS_VERSION_MAJOR,
3594 MBEDTLS_VERSION_MINOR,
3595 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003596 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3597 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003598};
Hanno Beckera835da52019-05-16 12:39:07 +01003599
3600/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003601 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003602 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003603 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003604 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003605 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003606 * opaque mbedtls_version[3]; // library version: major, minor, patch
3607 * opaque session_format[2]; // library-version specific 16-bit field
3608 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003609 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003610 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003611 * Note: When updating the format, remember to keep
3612 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003613 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003614 * // In this version, `session_format` determines
3615 * // the setting of those compile-time
3616 * // configuration options which influence
3617 * // the structure of mbedtls_ssl_session.
3618 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003619 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003620 * // - TLS 1.2 (0x0303)
3621 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003622 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003623 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003624 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003625 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003626 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003627 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003628 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003629 *
3630 * };
3631 *
3632 * } serialized_session;
3633 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003634 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003635
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003636MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003637static int ssl_session_save(const mbedtls_ssl_session *session,
3638 unsigned char omit_header,
3639 unsigned char *buf,
3640 size_t buf_len,
3641 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003642{
3643 unsigned char *p = buf;
3644 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003645 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003646#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3647 size_t out_len;
3648 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3649#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003650 if (session == NULL) {
3651 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3652 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003653
Gilles Peskine449bd832023-01-11 14:50:10 +01003654 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003655 /*
3656 * Add Mbed TLS version identifier
3657 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003658 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003659
Gilles Peskine449bd832023-01-11 14:50:10 +01003660 if (used <= buf_len) {
3661 memcpy(p, ssl_serialized_session_header,
3662 sizeof(ssl_serialized_session_header));
3663 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003664 }
3665 }
3666
3667 /*
3668 * TLS version identifier
3669 */
3670 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003671 if (used <= buf_len) {
3672 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003673 }
3674
3675 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003676 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003677 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003678#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003679 case MBEDTLS_SSL_VERSION_TLS1_2:
3680 used += ssl_tls12_session_save(session, p, remaining_len);
3681 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003682#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3683
Jerry Yu251a12e2022-07-13 15:15:48 +08003684#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003685 case MBEDTLS_SSL_VERSION_TLS1_3:
3686 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3687 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3688 return ret;
3689 }
3690 used += out_len;
3691 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003692#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3693
Gilles Peskine449bd832023-01-11 14:50:10 +01003694 default:
3695 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003696 }
3697
3698 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003699 if (used > buf_len) {
3700 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3701 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003702
Gilles Peskine449bd832023-01-11 14:50:10 +01003703 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003704}
3705
3706/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003707 * Public wrapper for ssl_session_save()
3708 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003709int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3710 unsigned char *buf,
3711 size_t buf_len,
3712 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003713{
Gilles Peskine449bd832023-01-11 14:50:10 +01003714 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003715}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003716
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003717/*
3718 * Deserialize session, see mbedtls_ssl_session_save() for format.
3719 *
3720 * This internal version is wrapped by a public function that cleans up in
3721 * case of error, and has an extra option omit_header.
3722 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003723MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003724static int ssl_session_load(mbedtls_ssl_session *session,
3725 unsigned char omit_header,
3726 const unsigned char *buf,
3727 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003728{
3729 const unsigned char *p = buf;
3730 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003731 size_t remaining_len;
3732
3733
Gilles Peskine449bd832023-01-11 14:50:10 +01003734 if (session == NULL) {
3735 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3736 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003737
Gilles Peskine449bd832023-01-11 14:50:10 +01003738 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003739 /*
3740 * Check Mbed TLS version identifier
3741 */
3742
Gilles Peskine449bd832023-01-11 14:50:10 +01003743 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3744 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003745 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003746
3747 if (memcmp(p, ssl_serialized_session_header,
3748 sizeof(ssl_serialized_session_header)) != 0) {
3749 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3750 }
3751 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003752 }
3753
3754 /*
3755 * TLS version identifier
3756 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003757 if (1 > (size_t) (end - p)) {
3758 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3759 }
Glenn Straussda7851c2022-03-14 13:29:48 -04003760 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003761
3762 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003763 remaining_len = (end - p);
3764 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003765#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003766 case MBEDTLS_SSL_VERSION_TLS1_2:
3767 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003768#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3769
Jerry Yu438ddd82022-07-07 06:55:50 +00003770#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003771 case MBEDTLS_SSL_VERSION_TLS1_3:
3772 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003773#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3774
Gilles Peskine449bd832023-01-11 14:50:10 +01003775 default:
3776 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003777 }
3778}
3779
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003780/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003781 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003782 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003783int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3784 const unsigned char *buf,
3785 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003786{
Gilles Peskine449bd832023-01-11 14:50:10 +01003787 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003788
Gilles Peskine449bd832023-01-11 14:50:10 +01003789 if (ret != 0) {
3790 mbedtls_ssl_session_free(session);
3791 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003792
Gilles Peskine449bd832023-01-11 14:50:10 +01003793 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003794}
3795
3796/*
Paul Bakker1961b702013-01-25 14:49:24 +01003797 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003798 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003799MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003800static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003801{
3802 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3803
Ronald Cron66dbf912022-02-02 15:33:46 +01003804 /*
3805 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003806 * that were written into the output buffer by the previous handshake step,
3807 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003808 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3809 * We proceed to the next handshake step only when all data from the
3810 * previous one have been sent to the peer, thus we make sure that this is
3811 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3812 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3813 * we have to wait before to go ahead.
3814 * In the case of TLS 1.3, handshake step handlers do not send data to the
3815 * peer. Data are only sent here and through
3816 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003817 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003818 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003819 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3820 return ret;
3821 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003822
3823#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003824 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3825 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3826 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3827 return ret;
3828 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003829 }
3830#endif /* MBEDTLS_SSL_PROTO_DTLS */
3831
Gilles Peskine449bd832023-01-11 14:50:10 +01003832 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003833}
3834
Gilles Peskine449bd832023-01-11 14:50:10 +01003835int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003836{
Hanno Becker41934dd2021-08-07 19:13:43 +01003837 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003838
Gilles Peskine449bd832023-01-11 14:50:10 +01003839 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003840 ssl->conf == NULL ||
3841 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003842 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3843 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003844 }
3845
Gilles Peskine449bd832023-01-11 14:50:10 +01003846 ret = ssl_prepare_handshake_step(ssl);
3847 if (ret != 0) {
3848 return ret;
3849 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003850
Gilles Peskine449bd832023-01-11 14:50:10 +01003851 ret = mbedtls_ssl_handle_pending_alert(ssl);
3852 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003853 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003854 }
Jerry Yue7047812021-09-13 19:26:39 +08003855
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003856 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3857 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3858 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3859
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003860#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003861 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3862 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
3863 mbedtls_ssl_states_str(ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003864
Gilles Peskine449bd832023-01-11 14:50:10 +01003865 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003866 case MBEDTLS_SSL_HELLO_REQUEST:
3867 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003868 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003869 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003870
Ronald Cron9f0fba32022-02-10 16:45:15 +01003871 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003872 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003873 break;
3874
3875 default:
3876#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003877 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3878 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3879 } else {
3880 ret = mbedtls_ssl_handshake_client_step(ssl);
3881 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003882#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003883 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003884#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003885 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003886#endif
3887 }
Jerry Yub9930e72021-08-06 17:11:51 +08003888 }
Ronald Cron6291b232023-03-08 15:51:25 +01003889#endif /* MBEDTLS_SSL_CLI_C */
3890
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003891#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003892 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003893#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3894 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003895 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003896 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003897 ret = mbedtls_ssl_handshake_server_step(ssl);
3898 }
Ronald Cron6291b232023-03-08 15:51:25 +01003899#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3900 ret = mbedtls_ssl_handshake_server_step(ssl);
3901#else
3902 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003903#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003904 }
3905#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003906
Gilles Peskine449bd832023-01-11 14:50:10 +01003907 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003908 /* handshake_step return error. And it is same
3909 * with alert_reason.
3910 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003911 if (ssl->send_alert) {
3912 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003913 goto cleanup;
3914 }
3915 }
3916
3917cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003918 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003919}
3920
3921/*
3922 * Perform the SSL handshake
3923 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003924int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003925{
3926 int ret = 0;
3927
Hanno Beckera817ea42020-10-20 15:20:23 +01003928 /* Sanity checks */
3929
Gilles Peskine449bd832023-01-11 14:50:10 +01003930 if (ssl == NULL || ssl->conf == NULL) {
3931 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3932 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003933
Hanno Beckera817ea42020-10-20 15:20:23 +01003934#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003935 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3936 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3937 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3938 "mbedtls_ssl_set_timer_cb() for DTLS"));
3939 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003940 }
3941#endif /* MBEDTLS_SSL_PROTO_DTLS */
3942
Gilles Peskine449bd832023-01-11 14:50:10 +01003943 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003944
Hanno Beckera817ea42020-10-20 15:20:23 +01003945 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3947 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003948
Gilles Peskine449bd832023-01-11 14:50:10 +01003949 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003950 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003951 }
Paul Bakker1961b702013-01-25 14:49:24 +01003952 }
3953
Gilles Peskine449bd832023-01-11 14:50:10 +01003954 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003955
Gilles Peskine449bd832023-01-11 14:50:10 +01003956 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003957}
3958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003959#if defined(MBEDTLS_SSL_RENEGOTIATION)
3960#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003961/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003962 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003963 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003964MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003965static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003966{
Janos Follath865b3eb2019-12-16 11:46:15 +00003967 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003968
Gilles Peskine449bd832023-01-11 14:50:10 +01003969 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003970
3971 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003972 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3973 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003974
Gilles Peskine449bd832023-01-11 14:50:10 +01003975 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3976 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3977 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003978 }
3979
Gilles Peskine449bd832023-01-11 14:50:10 +01003980 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003981
Gilles Peskine449bd832023-01-11 14:50:10 +01003982 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003983}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003984#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003985
3986/*
3987 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003988 * - any side: calling mbedtls_ssl_renegotiate(),
3989 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3990 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003991 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003992 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003993 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003994 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003995int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003996{
Janos Follath865b3eb2019-12-16 11:46:15 +00003997 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003998
Gilles Peskine449bd832023-01-11 14:50:10 +01003999 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004000
Gilles Peskine449bd832023-01-11 14:50:10 +01004001 if ((ret = ssl_handshake_init(ssl)) != 0) {
4002 return ret;
4003 }
Paul Bakker48916f92012-09-16 19:57:18 +00004004
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004005 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4006 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004007#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004008 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4009 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4010 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004011 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004012 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004013 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004014 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004015 }
4016#endif
4017
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004018 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4019 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004020
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4022 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4023 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004024 }
4025
Gilles Peskine449bd832023-01-11 14:50:10 +01004026 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004027
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004029}
4030
4031/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004032 * Renegotiate current connection on client,
4033 * or request renegotiation on server
4034 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004035int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004036{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004037 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004038
Gilles Peskine449bd832023-01-11 14:50:10 +01004039 if (ssl == NULL || ssl->conf == NULL) {
4040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4041 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004043#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004044 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004045 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4046 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4047 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4048 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004049
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004050 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004051
4052 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 if (ssl->out_left != 0) {
4054 return mbedtls_ssl_flush_output(ssl);
4055 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004056
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004058 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004059#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004061#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004062 /*
4063 * On client, either start the renegotiation process or,
4064 * if already in progress, continue the handshake
4065 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004066 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4067 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4068 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004069 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004070
4071 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4072 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4073 return ret;
4074 }
4075 } else {
4076 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4077 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4078 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004079 }
4080 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004081#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004082
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004084}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004085#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004086
Gilles Peskine449bd832023-01-11 14:50:10 +01004087void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004088{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004089 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4090
Gilles Peskine449bd832023-01-11 14:50:10 +01004091 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004092 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004093 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004094
Valerio Setti6c496a12023-04-07 15:53:51 +02004095#if defined(MBEDTLS_ECP_LIGHT)
Brett Warrene0edc842021-08-17 09:53:13 +01004096#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 if (ssl->handshake->group_list_heap_allocated) {
4098 mbedtls_free((void *) handshake->group_list);
4099 }
Brett Warrene0edc842021-08-17 09:53:13 +01004100 handshake->group_list = NULL;
4101#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6c496a12023-04-07 15:53:51 +02004102#endif /* MBEDTLS_ECP_LIGHT */
Brett Warrene0edc842021-08-17 09:53:13 +01004103
Ronald Crone68ab4f2022-10-05 12:46:29 +02004104#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004105#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 if (ssl->handshake->sig_algs_heap_allocated) {
4107 mbedtls_free((void *) handshake->sig_algs);
4108 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004109 handshake->sig_algs = NULL;
4110#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004111#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 if (ssl->handshake->certificate_request_context) {
4113 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004114 }
4115#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004116#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004117
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004118#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4120 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004121 handshake->async_in_progress = 0;
4122 }
4123#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4124
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004125#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004126#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004128#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004129 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004130#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004131#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004132#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004133#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004135#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004136 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004137#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004138#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004140#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004141 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004142#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02004143#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004145#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004146
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004147#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004148#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004150 /*
4151 * Opaque keys are not stored in the handshake's data and it's the user
4152 * responsibility to destroy them. Clear ones, instead, are created by
4153 * the TLS library and should be destroyed at the same level
4154 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4156 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004157 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004158 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4159#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004161#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004162#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004164 handshake->ecjpake_cache = NULL;
4165 handshake->ecjpake_cache_len = 0;
4166#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004167#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004168
Janos Follath4ae5c292016-02-10 11:27:43 +00004169#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4170 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004171 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004173#endif
4174
Ronald Cron73fe8df2022-10-05 14:31:43 +02004175#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004176#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004177 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004178 /* The maintenance of the external PSK key slot is the
4179 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 if (ssl->handshake->psk_opaque_is_internal) {
4181 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004182 ssl->handshake->psk_opaque_is_internal = 0;
4183 }
4184 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4185 }
Neil Armstronge952a302022-05-03 10:22:14 +02004186#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 if (handshake->psk != NULL) {
4188 mbedtls_platform_zeroize(handshake->psk, handshake->psk_len);
4189 mbedtls_free(handshake->psk);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004190 }
Neil Armstronge952a302022-05-03 10:22:14 +02004191#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004192#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004194#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4195 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004196 /*
4197 * Free only the linked list wrapper, not the keys themselves
4198 * since the belong to the SNI callback
4199 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004201#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004202
Gilles Peskineeccd8882020-03-10 12:19:08 +01004203#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4205 if (handshake->ecrs_peer_cert != NULL) {
4206 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4207 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004208 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004209#endif
4210
Hanno Becker75173122019-02-06 16:18:31 +00004211#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4212 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004214#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4215
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004216#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4218 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004219#endif /* MBEDTLS_SSL_CLI_C &&
4220 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004221
4222#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 mbedtls_ssl_flight_free(handshake->flight);
4224 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004225#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004226
Valerio Setti080a22b2023-03-20 15:22:47 +01004227#if defined(PSA_WANT_ALG_ECDH) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 (defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4229 if (handshake->ecdh_psa_privkey_is_external == 0) {
4230 psa_destroy_key(handshake->ecdh_psa_privkey);
4231 }
Valerio Setti080a22b2023-03-20 15:22:47 +01004232#endif /* PSA_WANT_ALG_ECDH && (MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3) */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004233
Ronald Cron6f135e12021-12-08 16:57:54 +01004234#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004235 mbedtls_ssl_transform_free(handshake->transform_handshake);
4236 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004237#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4239 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004240#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004241#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004242
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004243
4244#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4245 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4246 * processes datagrams and the fact that a datagram is allowed to have
4247 * several records in it, it is possible that the I/O buffers are not
4248 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4250 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004251#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004252
Jerry Yuba9c7272021-10-30 11:54:10 +08004253 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 mbedtls_platform_zeroize(handshake,
4255 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004256}
4257
Gilles Peskine449bd832023-01-11 14:50:10 +01004258void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004259{
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004261 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004263
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004264#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004266#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004267
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004268#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004269#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4270 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004272#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004273 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004274#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004275
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004277}
4278
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004279#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004280
4281#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4282#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4283#else
4284#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4285#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4286
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004287#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004288
4289#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4290#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4291#else
4292#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4293#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4294
4295#if defined(MBEDTLS_SSL_ALPN)
4296#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4297#else
4298#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4299#endif /* MBEDTLS_SSL_ALPN */
4300
4301#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4302#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4303#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4304#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4305
4306#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 ((uint32_t) ( \
4308 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4309 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4310 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4311 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4312 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4313 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4314 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4315 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004316
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004317static unsigned char ssl_serialized_context_header[] = {
4318 MBEDTLS_VERSION_MAJOR,
4319 MBEDTLS_VERSION_MINOR,
4320 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4322 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4323 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4324 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4325 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004326};
4327
Paul Bakker5121ce52009-01-03 21:22:43 +00004328/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004329 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004330 *
4331 * The format of the serialized data is:
4332 * (in the presentation language of TLS, RFC 8446 section 3)
4333 *
4334 * // header
4335 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004336 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004337 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004338 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004339 * Note: When updating the format, remember to keep these
4340 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004341 *
4342 * // session sub-structure
4343 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4344 * // transform sub-structure
4345 * uint8 random[64]; // ServerHello.random+ClientHello.random
4346 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4347 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4348 * // fields from ssl_context
4349 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4350 * uint64 in_window_top; // DTLS: last validated record seq_num
4351 * uint64 in_window; // DTLS: bitmask for replay protection
4352 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4353 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4354 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4355 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4356 *
4357 * Note that many fields of the ssl_context or sub-structures are not
4358 * serialized, as they fall in one of the following categories:
4359 *
4360 * 1. forced value (eg in_left must be 0)
4361 * 2. pointer to dynamically-allocated memory (eg session, transform)
4362 * 3. value can be re-derived from other data (eg session keys from MS)
4363 * 4. value was temporary (eg content of input buffer)
4364 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004365 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004366int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4367 unsigned char *buf,
4368 size_t buf_len,
4369 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004370{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004371 unsigned char *p = buf;
4372 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004373 size_t session_len;
4374 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004375
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004376 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004377 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4378 * this function's documentation.
4379 *
4380 * These are due to assumptions/limitations in the implementation. Some of
4381 * them are likely to stay (no handshake in progress) some might go away
4382 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004383 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004384 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4386 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4387 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004388 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if (ssl->handshake != NULL) {
4390 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4391 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004392 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004393 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 if (ssl->transform == NULL || ssl->session == NULL) {
4395 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4396 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004397 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004398 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if (mbedtls_ssl_check_pending(ssl) != 0) {
4400 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4401 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004402 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 if (ssl->out_left != 0) {
4404 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4405 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004406 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004407 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4409 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4410 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004411 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004412 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4414 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4415 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004416 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004417 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4419 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4420 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004421 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004422 /* Renegotiation must not be enabled */
4423#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4425 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4426 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004427 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004428#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004429
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004430 /*
4431 * Version and format identifier
4432 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004434
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 if (used <= buf_len) {
4436 memcpy(p, ssl_serialized_context_header,
4437 sizeof(ssl_serialized_context_header));
4438 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004439 }
4440
4441 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004442 * Session (length + data)
4443 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4445 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4446 return ret;
4447 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004448
4449 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 if (used <= buf_len) {
4451 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004452 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004453
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 ret = ssl_session_save(ssl->session, 1,
4455 p, session_len, &session_len);
4456 if (ret != 0) {
4457 return ret;
4458 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004459
4460 p += session_len;
4461 }
4462
4463 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004464 * Transform
4465 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 used += sizeof(ssl->transform->randbytes);
4467 if (used <= buf_len) {
4468 memcpy(p, ssl->transform->randbytes,
4469 sizeof(ssl->transform->randbytes));
4470 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004471 }
4472
4473#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4474 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004476 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004478 p += ssl->transform->in_cid_len;
4479
4480 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004482 p += ssl->transform->out_cid_len;
4483 }
4484#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4485
4486 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004487 * Saved fields from top-level ssl_context structure
4488 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004489 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 if (used <= buf_len) {
4491 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004492 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004493 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004494
4495#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4496 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 if (used <= buf_len) {
4498 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004499 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004500
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004502 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004503 }
4504#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4505
4506#if defined(MBEDTLS_SSL_PROTO_DTLS)
4507 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004509 *p++ = ssl->disable_datagram_packing;
4510 }
4511#endif /* MBEDTLS_SSL_PROTO_DTLS */
4512
Jerry Yuae0b2e22021-10-08 15:21:19 +08004513 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 if (used <= buf_len) {
4515 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004516 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004517 }
4518
4519#if defined(MBEDTLS_SSL_PROTO_DTLS)
4520 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 if (used <= buf_len) {
4522 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004523 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004524 }
4525#endif /* MBEDTLS_SSL_PROTO_DTLS */
4526
4527#if defined(MBEDTLS_SSL_ALPN)
4528 {
4529 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004531 : 0;
4532
4533 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004535 *p++ = alpn_len;
4536
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 if (ssl->alpn_chosen != NULL) {
4538 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004539 p += alpn_len;
4540 }
4541 }
4542 }
4543#endif /* MBEDTLS_SSL_ALPN */
4544
4545 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004546 * Done
4547 */
4548 *olen = used;
4549
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 if (used > buf_len) {
4551 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4552 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004553
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004555
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004557}
4558
4559/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004560 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004561 *
4562 * This internal version is wrapped by a public function that cleans up in
4563 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004564 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004565MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004566static int ssl_context_load(mbedtls_ssl_context *ssl,
4567 const unsigned char *buf,
4568 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004569{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004570 const unsigned char *p = buf;
4571 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004572 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004573 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004574#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004575 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004576#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004577
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004578 /*
4579 * The context should have been freshly setup or reset.
4580 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004581 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004582 * renegotiating, or if the user mistakenly loaded a session first.)
4583 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4585 ssl->session != NULL) {
4586 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004587 }
4588
4589 /*
4590 * We can't check that the config matches the initial one, but we can at
4591 * least check it matches the requirements for serializing.
4592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004594 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4595 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004596#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004597 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004598#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004599 0) {
4600 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004601 }
4602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004604
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004605 /*
4606 * Check version identifier
4607 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4609 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004610 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004611
4612 if (memcmp(p, ssl_serialized_context_header,
4613 sizeof(ssl_serialized_context_header)) != 0) {
4614 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4615 }
4616 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004617
4618 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004619 * Session
4620 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 if ((size_t) (end - p) < 4) {
4622 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4623 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004624
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004625 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004626 p += 4;
4627
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004628 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004629 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004630 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004631 ssl->session_in = ssl->session;
4632 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004633 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004634
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 if ((size_t) (end - p) < session_len) {
4636 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4637 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004638
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 ret = ssl_session_load(ssl->session, 1, p, session_len);
4640 if (ret != 0) {
4641 mbedtls_ssl_session_free(ssl->session);
4642 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004643 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004644
4645 p += session_len;
4646
4647 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004648 * Transform
4649 */
4650
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004651 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004652 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004653#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004654 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004655 ssl->transform_in = ssl->transform;
4656 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004657 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004658#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004659
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004660#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4662 if (prf_func == NULL) {
4663 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4664 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004665
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004666 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4668 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4669 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004670
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 ret = ssl_tls12_populate_transform(ssl->transform,
4672 ssl->session->ciphersuite,
4673 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004674#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004676#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 prf_func,
4678 p, /* currently pointing to randbytes */
4679 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4680 ssl->conf->endpoint,
4681 ssl);
4682 if (ret != 0) {
4683 return ret;
4684 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004685#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004687
4688#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4689 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 if ((size_t) (end - p) < 1) {
4691 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4692 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004693
4694 ssl->transform->in_cid_len = *p++;
4695
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4697 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4698 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004699
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004701 p += ssl->transform->in_cid_len;
4702
4703 ssl->transform->out_cid_len = *p++;
4704
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4706 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4707 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004708
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004710 p += ssl->transform->out_cid_len;
4711#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4712
4713 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004714 * Saved fields from top-level ssl_context structure
4715 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 if ((size_t) (end - p) < 4) {
4717 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4718 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004719
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004720 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004721 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004722
4723#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 if ((size_t) (end - p) < 16) {
4725 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4726 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004727
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004728 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004729 p += 8;
4730
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004731 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004732 p += 8;
4733#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4734
4735#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if ((size_t) (end - p) < 1) {
4737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4738 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004739
4740 ssl->disable_datagram_packing = *p++;
4741#endif /* MBEDTLS_SSL_PROTO_DTLS */
4742
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4744 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4745 }
4746 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4747 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004748
4749#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 if ((size_t) (end - p) < 2) {
4751 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4752 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004753
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004755 p += 2;
4756#endif /* MBEDTLS_SSL_PROTO_DTLS */
4757
4758#if defined(MBEDTLS_SSL_ALPN)
4759 {
4760 uint8_t alpn_len;
4761 const char **cur;
4762
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 if ((size_t) (end - p) < 1) {
4764 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4765 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004766
4767 alpn_len = *p++;
4768
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004770 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4772 if (strlen(*cur) == alpn_len &&
4773 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004774 ssl->alpn_chosen = *cur;
4775 break;
4776 }
4777 }
4778 }
4779
4780 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4782 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4783 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004784
4785 p += alpn_len;
4786 }
4787#endif /* MBEDTLS_SSL_ALPN */
4788
4789 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004790 * Forced fields from top-level ssl_context structure
4791 *
4792 * Most of them already set to the correct value by mbedtls_ssl_init() and
4793 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4794 */
4795 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004796 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004797
Hanno Becker361b10d2019-08-30 10:42:49 +01004798 /* Adjust pointers for header fields of outgoing records to
4799 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004801
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004802#if defined(MBEDTLS_SSL_PROTO_DTLS)
4803 ssl->in_epoch = 1;
4804#endif
4805
4806 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4807 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004808 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4809 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 if (ssl->handshake != NULL) {
4811 mbedtls_ssl_handshake_free(ssl);
4812 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004813 ssl->handshake = NULL;
4814 }
4815
4816 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004817 * Done - should have consumed entire buffer
4818 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 if (p != end) {
4820 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4821 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004822
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004824}
4825
4826/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004827 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004828 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004829int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4830 const unsigned char *buf,
4831 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004832{
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004834
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 if (ret != 0) {
4836 mbedtls_ssl_free(context);
4837 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004838
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004840}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004841#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004842
4843/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004844 * Free an SSL context
4845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004846void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004847{
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004849 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004851
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004853
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004855#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4856 size_t out_buf_len = ssl->out_buf_len;
4857#else
4858 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4859#endif
4860
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 mbedtls_platform_zeroize(ssl->out_buf, out_buf_len);
4862 mbedtls_free(ssl->out_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004863 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004864 }
4865
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004867#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4868 size_t in_buf_len = ssl->in_buf_len;
4869#else
4870 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4871#endif
4872
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 mbedtls_platform_zeroize(ssl->in_buf, in_buf_len);
4874 mbedtls_free(ssl->in_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004875 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004876 }
4877
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 if (ssl->transform) {
4879 mbedtls_ssl_transform_free(ssl->transform);
4880 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004881 }
4882
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 if (ssl->handshake) {
4884 mbedtls_ssl_handshake_free(ssl);
4885 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004886
4887#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4889 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004890#endif
4891
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 mbedtls_ssl_session_free(ssl->session_negotiate);
4893 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004894 }
4895
Ronald Cron6f135e12021-12-08 16:57:54 +01004896#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 mbedtls_ssl_transform_free(ssl->transform_application);
4898 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004899#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004900
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 if (ssl->session) {
4902 mbedtls_ssl_session_free(ssl->session);
4903 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004904 }
4905
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004906#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 if (ssl->hostname != NULL) {
4908 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
4909 mbedtls_free(ssl->hostname);
Paul Bakker5121ce52009-01-03 21:22:43 +00004910 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004911#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004912
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004913#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004915#endif
4916
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004918
Paul Bakker86f04f42013-02-14 11:20:09 +01004919 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004921}
4922
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004923/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004924 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004925 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004926void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004927{
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004929}
4930
Gilles Peskineae270bf2021-06-02 00:05:29 +02004931/* The selection should be the same as mbedtls_x509_crt_profile_default in
4932 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004933 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004934 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004935 * about this list.
4936 */
Brett Warrene0edc842021-08-17 09:53:13 +01004937static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004938#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004939 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004940#endif
4941#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004942 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004943#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004944#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004945 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004946#endif
4947#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004948 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004949#endif
4950#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004951 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004952#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004953#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004954 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004955#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004956#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004957 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004958#endif
4959#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004960 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004961#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004962 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004963};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004964
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03004965static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004966 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4967 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4968 0
4969};
4970
Ronald Crone68ab4f2022-10-05 12:46:29 +02004971#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004972
Jerry Yu909df7b2022-01-22 11:56:27 +08004973/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004974 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004975 * rules SHOULD be upheld.
4976 * - No duplicate entries.
4977 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004978 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004979 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004980 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004981static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004982
Valerio Setti75fba322023-02-23 17:35:09 +01004983#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004984 defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004985 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4986 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004987#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA256 &&
Jerry Yued5e9f42022-01-26 11:21:34 +08004988 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004989
Valerio Setti75fba322023-02-23 17:35:09 +01004990#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004991 defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08004992 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4993 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004994#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004995 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4996
Valerio Setti75fba322023-02-23 17:35:09 +01004997#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004998 defined(MBEDTLS_MD_CAN_SHA512) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004999 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
5000 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005001#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yued5e9f42022-01-26 11:21:34 +08005002 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005003
Gilles Peskine449bd832023-01-11 14:50:10 +01005004#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005005 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005006 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005007#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005008 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005011 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005012 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005013#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005014 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005015
Gilles Peskine449bd832023-01-11 14:50:10 +01005016#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005017 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005018 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005019#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005020 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005021
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005022#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005023 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005024#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005025
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005026#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005027 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005028#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005029
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005030#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005031 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005032#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005033
Gabor Mezei15b95a62022-05-09 16:37:58 +02005034 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005035};
5036
5037/* NOTICE: see above */
5038#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5039static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005040#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Setti75fba322023-02-23 17:35:09 +01005041#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005043#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005044#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5045 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5046#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005047#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005049#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005050#endif /* MBEDTLS_MD_CAN_SHA512*/
5051#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Setti75fba322023-02-23 17:35:09 +01005052#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005054#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005055#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5056 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5057#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005058#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005060#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005061#endif /* MBEDTLS_MD_CAN_SHA384*/
5062#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Setti75fba322023-02-23 17:35:09 +01005063#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005065#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005066#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5067 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5068#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005069#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005071#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005072#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005073 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005074};
5075#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5076/* NOTICE: see above */
5077static uint16_t ssl_preset_suiteb_sig_algs[] = {
5078
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005079#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08005080 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5081 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005082#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA256&&
Jerry Yu909df7b2022-01-22 11:56:27 +08005083 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
5084
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005085#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu53037892022-01-25 11:02:06 +08005086 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5087 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005088#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu53037892022-01-25 11:02:06 +08005089 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005090
Gilles Peskine449bd832023-01-11 14:50:10 +01005091#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005092 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005093 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005094#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005095 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005096
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005097#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005098 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005099#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005100
Gabor Mezei15b95a62022-05-09 16:37:58 +02005101 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005102};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005103
Jerry Yu909df7b2022-01-22 11:56:27 +08005104/* NOTICE: see above */
5105#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5106static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005107#if defined(MBEDTLS_MD_CAN_SHA256)
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_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +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_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005113#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005114#endif /* MBEDTLS_MD_CAN_SHA256*/
5115#if defined(MBEDTLS_MD_CAN_SHA384)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005116#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005118#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005119#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005121#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005122#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005123 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005124};
Jerry Yu909df7b2022-01-22 11:56:27 +08005125#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5126
Ronald Crone68ab4f2022-10-05 12:46:29 +02005127#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005128
Brett Warrene0edc842021-08-17 09:53:13 +01005129static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01005130#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005131 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005132#endif
5133#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005134 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005135#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005136 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005137};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005138
Ronald Crone68ab4f2022-10-05 12:46:29 +02005139#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005140/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005141 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005142MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005143static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005144{
5145 size_t i, j;
5146 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005147
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5149 for (j = 0; j < i; j++) {
5150 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005151 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 }
5153 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5154 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5155 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005156 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005157 }
5158 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005160}
5161
Ronald Crone68ab4f2022-10-05 12:46:29 +02005162#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005163
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005164/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005165 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005166 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005167int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5168 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005169{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005170#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005171 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005172#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005173
Ronald Crone68ab4f2022-10-05 12:46:29 +02005174#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5176 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5177 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005178 }
5179
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5181 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5182 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005183 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005184
5185#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5187 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5188 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005189 }
5190
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5192 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5193 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005194 }
5195#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005196#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005197
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005198 /* Use the functions here so that they are covered in tests,
5199 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005200 mbedtls_ssl_conf_endpoint(conf, endpoint);
5201 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005202
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005203 /*
5204 * Things that are common to all presets
5205 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005206#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005207 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005208 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5209#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5210 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5211#endif
5212 }
5213#endif
5214
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005215#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5216 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5217#endif
5218
5219#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5220 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5221#endif
5222
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005223#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005224 conf->f_cookie_write = ssl_cookie_write_dummy;
5225 conf->f_cookie_check = ssl_cookie_check_dummy;
5226#endif
5227
5228#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5229 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5230#endif
5231
Janos Follath088ce432017-04-10 12:42:31 +01005232#if defined(MBEDTLS_SSL_SRV_C)
5233 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005234 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005235#endif
5236
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005237#if defined(MBEDTLS_SSL_PROTO_DTLS)
5238 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5239 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5240#endif
5241
5242#if defined(MBEDTLS_SSL_RENEGOTIATION)
5243 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 memset(conf->renego_period, 0x00, 2);
5245 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005246#endif
5247
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005248#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005249 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005250 const unsigned char dhm_p[] =
5251 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5252 const unsigned char dhm_g[] =
5253 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005254
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5256 dhm_p, sizeof(dhm_p),
5257 dhm_g, sizeof(dhm_g))) != 0) {
5258 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005259 }
5260 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005261#endif
5262
Ronald Cron6f135e12021-12-08 16:57:54 +01005263#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005264
5265#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 mbedtls_ssl_tls13_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005267#if defined(MBEDTLS_SSL_SRV_C)
5268 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005270#endif
5271#endif /* MBEDTLS_SSL_EARLY_DATA */
5272
Jerry Yud0766ec2022-09-22 10:46:57 +08005273#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005274 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005276#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005277 /*
5278 * Allow all TLS 1.3 key exchange modes by default.
5279 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005280 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005281#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005282
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005284#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005285 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005286 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005287#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005288 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005289#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005290 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005291#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005292 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5293 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005294#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5295 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5296 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5297#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5298 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5299 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5300#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005301 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005302#endif
5303 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005304
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005305 /*
5306 * Preset-specific defaults
5307 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005309 /*
5310 * NSA Suite B
5311 */
5312 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005313
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005314 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005315
5316#if defined(MBEDTLS_X509_CRT_PARSE_C)
5317 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005318#endif
5319
Ronald Crone68ab4f2022-10-05 12:46:29 +02005320#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005321#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005323 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005325#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005327#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005328
Brett Warrene0edc842021-08-17 09:53:13 +01005329#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5330 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005331#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005332 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005333 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005334
5335 /*
5336 * Default
5337 */
5338 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005339
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005340 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005341
5342#if defined(MBEDTLS_X509_CRT_PARSE_C)
5343 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5344#endif
5345
Ronald Crone68ab4f2022-10-05 12:46:29 +02005346#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005347#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005349 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005351#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005353#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005354
Brett Warrene0edc842021-08-17 09:53:13 +01005355#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5356 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005357#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005358 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005359
5360#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5361 conf->dhm_min_bitlen = 1024;
5362#endif
5363 }
5364
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005366}
5367
5368/*
5369 * Free mbedtls_ssl_config
5370 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005371void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005372{
5373#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 mbedtls_mpi_free(&conf->dhm_P);
5375 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005376#endif
5377
Ronald Cron73fe8df2022-10-05 14:31:43 +02005378#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005379#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005381 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5382 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005383#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 if (conf->psk != NULL) {
5385 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
5386 mbedtls_free(conf->psk);
Azim Khan27e8a122018-03-21 14:24:11 +00005387 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005388 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005389 }
5390
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 if (conf->psk_identity != NULL) {
5392 mbedtls_platform_zeroize(conf->psk_identity, conf->psk_identity_len);
5393 mbedtls_free(conf->psk_identity);
Azim Khan27e8a122018-03-21 14:24:11 +00005394 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005395 conf->psk_identity_len = 0;
5396 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005397#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005398
5399#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005401#endif
5402
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005404}
5405
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005406#if defined(MBEDTLS_PK_C) && \
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005407 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_CAN_ECDSA_SOME))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005408/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005409 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005410 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005411unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005412{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005413#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5415 return MBEDTLS_SSL_SIG_RSA;
5416 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005417#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005418#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5420 return MBEDTLS_SSL_SIG_ECDSA;
5421 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005422#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005424}
5425
Gilles Peskine449bd832023-01-11 14:50:10 +01005426unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005427{
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005429 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005431 case MBEDTLS_PK_ECDSA:
5432 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005434 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005436 }
5437}
5438
Gilles Peskine449bd832023-01-11 14:50:10 +01005439mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005440{
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005442#if defined(MBEDTLS_RSA_C)
5443 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005444 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005445#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005446#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005447 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005448 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005449#endif
5450 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005452 }
5453}
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005454#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_PK_CAN_ECDSA_SOME ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005455
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005456/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005457 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005459mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005460{
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005462#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005463 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005465#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005466#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005467 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005469#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005470#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005471 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005473#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005474#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005475 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005477#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005478#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005481#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005482#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005483 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005485#endif
5486 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005488 }
5489}
5490
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005491/*
5492 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5493 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005494unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005495{
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005497#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005498 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005499 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005500#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005501#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005502 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005504#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005505#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005506 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005508#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005509#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005510 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005512#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005513#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005514 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005516#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005517#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005518 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005520#endif
5521 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005523 }
5524}
5525
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005526/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005527 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005528 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005529 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005530int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005531{
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005533
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 if (group_list == NULL) {
5535 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005536 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005537
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 for (; *group_list != 0; group_list++) {
5539 if (*group_list == tls_id) {
5540 return 0;
5541 }
5542 }
5543
5544 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005545}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005546
Valerio Settid4a5d462023-04-05 18:19:01 +02005547#if defined(MBEDTLS_ECP_LIGHT)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005548/*
5549 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5550 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005551int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005552{
Gilles Peskine449bd832023-01-11 14:50:10 +01005553 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005554
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005556 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005558
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005560}
Valerio Settid4a5d462023-04-05 18:19:01 +02005561#endif /* MBEDTLS_ECP_LIGHT */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005562
Gilles Peskine449bd832023-01-11 14:50:10 +01005563#if defined(MBEDTLS_DEBUG_C)
Valerio Setti67419f02023-01-04 16:12:42 +01005564#define EC_NAME(_name_) _name_
5565#else
5566#define EC_NAME(_name_) NULL
5567#endif
5568
Valerio Setti18c9fed2022-12-30 17:44:24 +01005569static const struct {
5570 uint16_t tls_id;
5571 mbedtls_ecp_group_id ecp_group_id;
5572 psa_ecc_family_t psa_family;
5573 uint16_t bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005574 const char *name;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005575} tls_id_match_table[] =
5576{
5577#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521, EC_NAME("secp521r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005579#endif
5580#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512, EC_NAME("brainpoolP512r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005582#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005583#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384, EC_NAME("secp384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005585#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005586#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384, EC_NAME("brainpoolP384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005588#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005589#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256, EC_NAME("secp256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005591#endif
5592#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256, EC_NAME("secp256k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005594#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005595#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256, EC_NAME("brainpoolP256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005597#endif
5598#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224, EC_NAME("secp224r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005600#endif
5601#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224, EC_NAME("secp224k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005603#endif
5604#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192, EC_NAME("secp192r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005606#endif
5607#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192, EC_NAME("secp192k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005609#endif
5610#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255, EC_NAME("x25519") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005612#endif
5613#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448, EC_NAME("x448") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005615#endif
5616 { 0, MBEDTLS_ECP_DP_NONE, 0, 0, NULL },
5617};
5618
Gilles Peskine449bd832023-01-11 14:50:10 +01005619int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
5620 psa_ecc_family_t *family,
5621 size_t *bits)
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) {
5625 if (family != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005626 *family = tls_id_match_table[i].psa_family;
Gilles Peskine449bd832023-01-11 14:50:10 +01005627 }
5628 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005629 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005631 return PSA_SUCCESS;
5632 }
5633 }
5634
5635 return PSA_ERROR_NOT_SUPPORTED;
5636}
5637
Gilles Peskine449bd832023-01-11 14:50:10 +01005638mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005639{
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5641 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005642 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005644 }
5645
5646 return MBEDTLS_ECP_DP_NONE;
5647}
5648
Gilles Peskine449bd832023-01-11 14:50:10 +01005649uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005650{
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5652 i++) {
5653 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005654 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005656 }
5657
5658 return 0;
5659}
5660
Valerio Setti67419f02023-01-04 16:12:42 +01005661#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005662const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005663{
Gilles Peskine449bd832023-01-11 14:50:10 +01005664 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5665 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005666 return tls_id_match_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005668 }
5669
5670 return NULL;
5671}
Valerio Setti67419f02023-01-04 16:12:42 +01005672#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005673
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005674#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005675int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5676 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5677 int cert_endpoint,
5678 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005679{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005680 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005681 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005682 const char *ext_oid;
5683 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005684
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005686 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005687 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005688 case MBEDTLS_KEY_EXCHANGE_RSA:
5689 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005690 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005691 break;
5692
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005693 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5694 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5695 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5696 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005697 break;
5698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005699 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5700 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005701 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005702 break;
5703
5704 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005705 case MBEDTLS_KEY_EXCHANGE_NONE:
5706 case MBEDTLS_KEY_EXCHANGE_PSK:
5707 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5708 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005709 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005710 usage = 0;
5711 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005713 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5714 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005715 }
5716
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005718 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005719 ret = -1;
5720 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005721
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005723 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5725 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005726 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005728 }
5729
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005731 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005732 ret = -1;
5733 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005734
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005736}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005737#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005738
Jerry Yu148165c2021-09-24 23:20:59 +08005739#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005740int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5741 const mbedtls_md_type_t md,
5742 unsigned char *dst,
5743 size_t dst_len,
5744 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005745{
Ronald Cronf6893e12022-01-07 22:09:01 +01005746 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5747 psa_hash_operation_t *hash_operation_to_clone;
5748 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5749
Jerry Yu148165c2021-09-24 23:20:59 +08005750 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005751
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005753#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 case MBEDTLS_MD_SHA384:
5755 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5756 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005757#endif
5758
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005759#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 case MBEDTLS_MD_SHA256:
5761 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5762 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005763#endif
5764
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 default:
5766 goto exit;
5767 }
5768
5769 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5770 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005771 goto exit;
5772 }
5773
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5775 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005776 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005777 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005778
5779exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005780#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5781 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005782 (void) ssl;
5783#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005784 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005785}
5786#else /* MBEDTLS_USE_PSA_CRYPTO */
5787
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005788#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005789MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005790static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5791 unsigned char *dst,
5792 size_t dst_len,
5793 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005794{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005795 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005796 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005797
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 if (dst_len < 48) {
5799 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5800 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005801
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005802 mbedtls_md_init(&sha384);
5803 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005804 if (ret != 0) {
5805 goto exit;
5806 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005807 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005808 if (ret != 0) {
5809 goto exit;
5810 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005811
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005812 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005813 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005814 goto exit;
5815 }
5816
5817 *olen = 48;
5818
5819exit:
5820
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005821 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005823}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005824#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005825
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005826#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005827MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005828static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5829 unsigned char *dst,
5830 size_t dst_len,
5831 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005832{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005833 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005834 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005835
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 if (dst_len < 32) {
5837 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5838 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005839
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005840 mbedtls_md_init(&sha256);
5841 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5842 if (ret != 0) {
5843 goto exit;
5844 }
5845 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5846 if (ret != 0) {
5847 goto exit;
5848 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005849
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005850 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5851 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005852 goto exit;
5853 }
5854
5855 *olen = 32;
5856
5857exit:
5858
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005859 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005860 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005861}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005862#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005863
Gilles Peskine449bd832023-01-11 14:50:10 +01005864int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5865 const mbedtls_md_type_t md,
5866 unsigned char *dst,
5867 size_t dst_len,
5868 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005869{
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005871
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005872#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005873 case MBEDTLS_MD_SHA384:
5874 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005875#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005876
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005877#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 case MBEDTLS_MD_SHA256:
5879 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005880#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005881
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005883#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5884 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 (void) ssl;
5886 (void) dst;
5887 (void) dst_len;
5888 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005889#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005890 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005891 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005893}
XiaokangQian647719a2021-12-07 09:16:29 +00005894
Jerry Yu148165c2021-09-24 23:20:59 +08005895#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005896
Ronald Crone68ab4f2022-10-05 12:46:29 +02005897#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005898/* mbedtls_ssl_parse_sig_alg_ext()
5899 *
5900 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5901 * value (TLS 1.3 RFC8446):
5902 * enum {
5903 * ....
5904 * ecdsa_secp256r1_sha256( 0x0403 ),
5905 * ecdsa_secp384r1_sha384( 0x0503 ),
5906 * ecdsa_secp521r1_sha512( 0x0603 ),
5907 * ....
5908 * } SignatureScheme;
5909 *
5910 * struct {
5911 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5912 * } SignatureSchemeList;
5913 *
5914 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5915 * value (TLS 1.2 RFC5246):
5916 * enum {
5917 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5918 * sha512(6), (255)
5919 * } HashAlgorithm;
5920 *
5921 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5922 * SignatureAlgorithm;
5923 *
5924 * struct {
5925 * HashAlgorithm hash;
5926 * SignatureAlgorithm signature;
5927 * } SignatureAndHashAlgorithm;
5928 *
5929 * SignatureAndHashAlgorithm
5930 * supported_signature_algorithms<2..2^16-2>;
5931 *
5932 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5933 * generalization of the TLS 1.2 signature algorithm extension.
5934 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5935 * `SignatureScheme` field of TLS 1.3
5936 *
5937 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005938int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5939 const unsigned char *buf,
5940 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005941{
5942 const unsigned char *p = buf;
5943 size_t supported_sig_algs_len = 0;
5944 const unsigned char *supported_sig_algs_end;
5945 uint16_t sig_alg;
5946 uint32_t common_idx = 0;
5947
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5949 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005950 p += 2;
5951
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 memset(ssl->handshake->received_sig_algs, 0,
5953 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005954
Gilles Peskine449bd832023-01-11 14:50:10 +01005955 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005956 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 while (p < supported_sig_algs_end) {
5958 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5959 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005960 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005961 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5962 sig_alg,
5963 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005964#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5966 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5967 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005968 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005969 }
5970#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005971
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5973 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005974
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005976 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5977 common_idx += 1;
5978 }
5979 }
5980 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 if (p != end) {
5982 MBEDTLS_SSL_DEBUG_MSG(1,
5983 ("Signature algorithms extension length misaligned"));
5984 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5985 MBEDTLS_ERR_SSL_DECODE_ERROR);
5986 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02005987 }
5988
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 if (common_idx == 0) {
5990 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
5991 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5992 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
5993 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005994 }
5995
Gabor Mezei15b95a62022-05-09 16:37:58 +02005996 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02005998}
5999
Ronald Crone68ab4f2022-10-05 12:46:29 +02006000#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006001
Jerry Yudc7bd172022-02-17 13:44:15 +08006002#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6003
6004#if defined(MBEDTLS_USE_PSA_CRYPTO)
6005
Gilles Peskine449bd832023-01-11 14:50:10 +01006006static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6007 mbedtls_svc_key_id_t key,
6008 psa_algorithm_t alg,
6009 const unsigned char *raw_psk, size_t raw_psk_length,
6010 const unsigned char *seed, size_t seed_length,
6011 const unsigned char *label, size_t label_length,
6012 const unsigned char *other_secret,
6013 size_t other_secret_length,
6014 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006015{
6016 psa_status_t status;
6017
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 status = psa_key_derivation_setup(derivation, alg);
6019 if (status != PSA_SUCCESS) {
6020 return status;
6021 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006022
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6024 status = psa_key_derivation_input_bytes(derivation,
6025 PSA_KEY_DERIVATION_INPUT_SEED,
6026 seed, seed_length);
6027 if (status != PSA_SUCCESS) {
6028 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006029 }
6030
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 if (other_secret != NULL) {
6032 status = psa_key_derivation_input_bytes(derivation,
6033 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6034 other_secret, other_secret_length);
6035 if (status != PSA_SUCCESS) {
6036 return status;
6037 }
6038 }
6039
6040 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006041 status = psa_key_derivation_input_bytes(
6042 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 raw_psk, raw_psk_length);
6044 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006045 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006047 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006048 if (status != PSA_SUCCESS) {
6049 return status;
6050 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006051
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 status = psa_key_derivation_input_bytes(derivation,
6053 PSA_KEY_DERIVATION_INPUT_LABEL,
6054 label, label_length);
6055 if (status != PSA_SUCCESS) {
6056 return status;
6057 }
6058 } else {
6059 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006060 }
6061
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 status = psa_key_derivation_set_capacity(derivation, capacity);
6063 if (status != PSA_SUCCESS) {
6064 return status;
6065 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006066
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006068}
6069
Andrzej Kurek57d10632022-10-24 10:32:01 -04006070#if defined(PSA_WANT_ALG_SHA_384) || \
6071 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006072MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006073static int tls_prf_generic(mbedtls_md_type_t md_type,
6074 const unsigned char *secret, size_t slen,
6075 const char *label,
6076 const unsigned char *random, size_t rlen,
6077 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006078{
6079 psa_status_t status;
6080 psa_algorithm_t alg;
6081 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6082 psa_key_derivation_operation_t derivation =
6083 PSA_KEY_DERIVATION_OPERATION_INIT;
6084
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006086 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006088 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006090
6091 /* Normally a "secret" should be long enough to be impossible to
6092 * find by brute force, and in particular should not be empty. But
6093 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6094 * and for this use case it makes sense to have a 0-length "secret".
6095 * Since the key API doesn't allow importing a key of length 0,
6096 * keep master_key=0, which setup_psa_key_derivation() understands
6097 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006099 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6101 psa_set_key_algorithm(&key_attributes, alg);
6102 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006103
Gilles Peskine449bd832023-01-11 14:50:10 +01006104 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6105 if (status != PSA_SUCCESS) {
6106 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6107 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006108 }
6109
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 status = setup_psa_key_derivation(&derivation,
6111 master_key, alg,
6112 NULL, 0,
6113 random, rlen,
6114 (unsigned char const *) label,
6115 (size_t) strlen(label),
6116 NULL, 0,
6117 dlen);
6118 if (status != PSA_SUCCESS) {
6119 psa_key_derivation_abort(&derivation);
6120 psa_destroy_key(master_key);
6121 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006122 }
6123
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6125 if (status != PSA_SUCCESS) {
6126 psa_key_derivation_abort(&derivation);
6127 psa_destroy_key(master_key);
6128 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006129 }
6130
Gilles Peskine449bd832023-01-11 14:50:10 +01006131 status = psa_key_derivation_abort(&derivation);
6132 if (status != PSA_SUCCESS) {
6133 psa_destroy_key(master_key);
6134 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006135 }
6136
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 if (!mbedtls_svc_key_id_is_null(master_key)) {
6138 status = psa_destroy_key(master_key);
6139 }
6140 if (status != PSA_SUCCESS) {
6141 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6142 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006143
Gilles Peskine449bd832023-01-11 14:50:10 +01006144 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006145}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006146#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006147#else /* MBEDTLS_USE_PSA_CRYPTO */
6148
Andrzej Kurek57d10632022-10-24 10:32:01 -04006149#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006150 (defined(MBEDTLS_MD_CAN_SHA256) || \
6151 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006152MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006153static int tls_prf_generic(mbedtls_md_type_t md_type,
6154 const unsigned char *secret, size_t slen,
6155 const char *label,
6156 const unsigned char *random, size_t rlen,
6157 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006158{
6159 size_t nb;
6160 size_t i, j, k, md_len;
6161 unsigned char *tmp;
6162 size_t tmp_len = 0;
6163 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6164 const mbedtls_md_info_t *md_info;
6165 mbedtls_md_context_t md_ctx;
6166 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6167
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006169
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6171 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6172 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006173
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006175
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 tmp_len = md_len + strlen(label) + rlen;
6177 tmp = mbedtls_calloc(1, tmp_len);
6178 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006179 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6180 goto exit;
6181 }
6182
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 nb = strlen(label);
6184 memcpy(tmp + md_len, label, nb);
6185 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006186 nb += rlen;
6187
6188 /*
6189 * Compute P_<hash>(secret, label + random)[0..dlen]
6190 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006191 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006192 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006194
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6196 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006197 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 }
6199 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
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_finish(&md_ctx, tmp);
6204 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006205 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006207
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 for (i = 0; i < dlen; i += md_len) {
6209 ret = mbedtls_md_hmac_reset(&md_ctx);
6210 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006211 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 }
6213 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
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_finish(&md_ctx, h_i);
6218 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006219 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006221
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 ret = mbedtls_md_hmac_reset(&md_ctx);
6223 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006224 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006225 }
6226 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
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_finish(&md_ctx, tmp);
6231 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006232 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006234
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006236
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006238 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006240 }
6241
6242exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006244
Gilles Peskine449bd832023-01-11 14:50:10 +01006245 if (tmp != NULL) {
6246 mbedtls_platform_zeroize(tmp, tmp_len);
6247 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006248
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006250
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006252
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006254}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006255#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006256#endif /* MBEDTLS_USE_PSA_CRYPTO */
6257
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006258#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006259MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006260static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6261 const char *label,
6262 const unsigned char *random, size_t rlen,
6263 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006264{
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6266 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006267}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006268#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006269
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006270#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006271MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006272static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6273 const char *label,
6274 const unsigned char *random, size_t rlen,
6275 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006276{
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6278 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006279}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006280#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006281
Jerry Yuf009d862022-02-17 14:01:37 +08006282/*
6283 * Set appropriate PRF function and other SSL / TLS1.2 functions
6284 *
6285 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006286 * - hash associated with the ciphersuite (only used by TLS 1.2)
6287 *
6288 * Outputs:
6289 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6290 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006291MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006292static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6293 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006294{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006295#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006297 handshake->tls_prf = tls_prf_sha384;
6298 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6299 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006301#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006302#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006303 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006304 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006305 handshake->tls_prf = tls_prf_sha256;
6306 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6307 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6308 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006309#else
Jerry Yuf009d862022-02-17 14:01:37 +08006310 {
Jerry Yuf009d862022-02-17 14:01:37 +08006311 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006312 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006313 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006314 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006315#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006316
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006318}
Jerry Yud6ab2352022-02-17 14:03:43 +08006319
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006320/*
6321 * Compute master secret if needed
6322 *
6323 * Parameters:
6324 * [in/out] handshake
6325 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6326 * (PSA-PSK) ciphersuite_info, psk_opaque
6327 * [out] premaster (cleared)
6328 * [out] master
6329 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6330 * debug: conf->f_dbg, conf->p_dbg
6331 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006332 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006333 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006334MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006335static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6336 unsigned char *master,
6337 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006338{
6339 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6340
6341 /* cf. RFC 5246, Section 8.1:
6342 * "The master secret is always exactly 48 bytes in length." */
6343 size_t const master_secret_len = 48;
6344
6345#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6346 unsigned char session_hash[48];
6347#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6348
6349 /* The label for the KDF used for key expansion.
6350 * This is either "master secret" or "extended master secret"
6351 * depending on whether the Extended Master Secret extension
6352 * is used. */
6353 char const *lbl = "master secret";
6354
Przemek Stekielae4ed302022-04-05 17:15:55 +02006355 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006356 * - If the Extended Master Secret extension is not used,
6357 * this is ClientHello.Random + ServerHello.Random
6358 * (see Sect. 8.1 in RFC 5246).
6359 * - If the Extended Master Secret extension is used,
6360 * this is the transcript of the handshake so far.
6361 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006362 unsigned char const *seed = handshake->randbytes;
6363 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006364
6365#if !defined(MBEDTLS_DEBUG_C) && \
6366 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6367 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006369 ssl = NULL; /* make sure we don't use it except for those cases */
6370 (void) ssl;
6371#endif
6372
Gilles Peskine449bd832023-01-11 14:50:10 +01006373 if (handshake->resume != 0) {
6374 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6375 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006376 }
6377
6378#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006380 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006381 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006382 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6383 if (ret != 0) {
6384 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6385 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006386
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6388 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006389 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006390#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006391
Przemek Stekiel99114f32022-04-22 11:20:09 +02006392#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006393 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006395 /* Perform PSK-to-MS expansion in a single step. */
6396 psa_status_t status;
6397 psa_algorithm_t alg;
6398 mbedtls_svc_key_id_t psk;
6399 psa_key_derivation_operation_t derivation =
6400 PSA_KEY_DERIVATION_OPERATION_INIT;
6401 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6402
Gilles Peskine449bd832023-01-11 14:50:10 +01006403 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006404
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006406
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006408 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006410 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006412
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006413 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006415
Gilles Peskine449bd832023-01-11 14:50:10 +01006416 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006417 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006418 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006419 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006420 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006421 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006422 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006423 other_secret_len = 48;
6424 other_secret = handshake->premaster + 2;
6425 break;
6426 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006427 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006428 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6429 other_secret = handshake->premaster + 2;
6430 break;
6431 default:
6432 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006433 }
6434
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 status = setup_psa_key_derivation(&derivation, psk, alg,
6436 ssl->conf->psk, ssl->conf->psk_len,
6437 seed, seed_len,
6438 (unsigned char const *) lbl,
6439 (size_t) strlen(lbl),
6440 other_secret, other_secret_len,
6441 master_secret_len);
6442 if (status != PSA_SUCCESS) {
6443 psa_key_derivation_abort(&derivation);
6444 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006445 }
6446
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 status = psa_key_derivation_output_bytes(&derivation,
6448 master,
6449 master_secret_len);
6450 if (status != PSA_SUCCESS) {
6451 psa_key_derivation_abort(&derivation);
6452 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006453 }
6454
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 status = psa_key_derivation_abort(&derivation);
6456 if (status != PSA_SUCCESS) {
6457 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6458 }
6459 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006460#endif
6461 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006462#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006463 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6464 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006465 psa_status_t status;
6466 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6467 psa_key_derivation_operation_t derivation =
6468 PSA_KEY_DERIVATION_OPERATION_INIT;
6469
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006471
6472 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6473
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 status = psa_key_derivation_setup(&derivation, alg);
6475 if (status != PSA_SUCCESS) {
6476 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006477 }
6478
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 status = psa_key_derivation_set_capacity(&derivation,
6480 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6481 if (status != PSA_SUCCESS) {
6482 psa_key_derivation_abort(&derivation);
6483 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006484 }
6485
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6487 &derivation);
6488 if (status != PSA_SUCCESS) {
6489 psa_key_derivation_abort(&derivation);
6490 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006491 }
6492
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 status = psa_key_derivation_output_bytes(&derivation,
6494 handshake->premaster,
6495 handshake->pmslen);
6496 if (status != PSA_SUCCESS) {
6497 psa_key_derivation_abort(&derivation);
6498 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6499 }
6500
6501 status = psa_key_derivation_abort(&derivation);
6502 if (status != PSA_SUCCESS) {
6503 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006504 }
6505 }
6506#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6508 lbl, seed, seed_len,
6509 master,
6510 master_secret_len);
6511 if (ret != 0) {
6512 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6513 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006514 }
6515
Gilles Peskine449bd832023-01-11 14:50:10 +01006516 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6517 handshake->premaster,
6518 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 mbedtls_platform_zeroize(handshake->premaster,
6521 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006522 }
6523
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006525}
6526
Gilles Peskine449bd832023-01-11 14:50:10 +01006527int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006528{
6529 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6530 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6531 ssl->handshake->ciphersuite_info;
6532
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006534
6535 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 ret = ssl_set_handshake_prfs(ssl->handshake,
6537 ciphersuite_info->mac);
6538 if (ret != 0) {
6539 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6540 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006541 }
6542
6543 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 ret = ssl_compute_master(ssl->handshake,
6545 ssl->session_negotiate->master,
6546 ssl);
6547 if (ret != 0) {
6548 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6549 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006550 }
6551
6552 /* Swap the client and server random values:
6553 * - MS derivation wanted client+server (RFC 5246 8.1)
6554 * - key derivation wants server+client (RFC 5246 6.3) */
6555 {
6556 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 memcpy(tmp, ssl->handshake->randbytes, 64);
6558 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6559 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6560 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006561 }
6562
6563 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6565 ssl->session_negotiate->ciphersuite,
6566 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006567#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006569#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 ssl->handshake->tls_prf,
6571 ssl->handshake->randbytes,
6572 ssl->tls_version,
6573 ssl->conf->endpoint,
6574 ssl);
6575 if (ret != 0) {
6576 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6577 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006578 }
6579
6580 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006581 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6582 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006583
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006585
Gilles Peskine449bd832023-01-11 14:50:10 +01006586 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006587}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006588
Gilles Peskine449bd832023-01-11 14:50:10 +01006589int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006590{
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006592#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006593 case MBEDTLS_SSL_HASH_SHA384:
6594 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6595 break;
6596#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006597#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006598 case MBEDTLS_SSL_HASH_SHA256:
6599 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6600 break;
6601#endif
6602 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006603 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006604 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006605#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6606 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006607 (void) ssl;
6608#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006610}
6611
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006612#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006613int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6614 unsigned char *hash,
6615 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006616{
6617#if defined(MBEDTLS_USE_PSA_CRYPTO)
6618 size_t hash_size;
6619 psa_status_t status;
6620 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
6621
Gilles Peskine449bd832023-01-11 14:50:10 +01006622 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify sha256"));
6623 status = psa_hash_clone(&ssl->handshake->fin_sha256_psa, &sha256_psa);
6624 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006625 goto exit;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006626 }
6627
Gilles Peskine449bd832023-01-11 14:50:10 +01006628 status = psa_hash_finish(&sha256_psa, hash, 32, &hash_size);
6629 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006630 goto exit;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006631 }
6632
6633 *hlen = 32;
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6635 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006636
6637exit:
6638 psa_hash_abort(&sha256_psa);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02006639 return mbedtls_md_error_from_psa(status);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006640#else
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006641 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006642 mbedtls_md_context_t sha256;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006643
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006644 mbedtls_md_init(&sha256);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006645
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify sha256"));
Jerry Yu8392e0d2022-02-17 14:10:24 +08006647
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006648 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6649 if (ret != 0) {
6650 goto exit;
6651 }
6652 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6653 if (ret != 0) {
6654 goto exit;
6655 }
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006656
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006657 ret = mbedtls_md_finish(&sha256, hash);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006658 if (ret != 0) {
6659 goto exit;
6660 }
Jerry Yu8392e0d2022-02-17 14:10:24 +08006661
6662 *hlen = 32;
6663
Gilles Peskine449bd832023-01-11 14:50:10 +01006664 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6665 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
Jerry Yu8392e0d2022-02-17 14:10:24 +08006666
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006667exit:
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006668 mbedtls_md_free(&sha256);
Manuel Pégourié-Gonnard8e176f72023-02-09 10:33:54 +01006669 return ret;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006670#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006671}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006672#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006673
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006674#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006675int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6676 unsigned char *hash,
6677 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006678{
6679#if defined(MBEDTLS_USE_PSA_CRYPTO)
6680 size_t hash_size;
6681 psa_status_t status;
6682 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
6683
Gilles Peskine449bd832023-01-11 14:50:10 +01006684 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify sha384"));
6685 status = psa_hash_clone(&ssl->handshake->fin_sha384_psa, &sha384_psa);
6686 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006687 goto exit;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006688 }
6689
Gilles Peskine449bd832023-01-11 14:50:10 +01006690 status = psa_hash_finish(&sha384_psa, hash, 48, &hash_size);
6691 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006692 goto exit;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006693 }
6694
6695 *hlen = 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006696 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6697 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006698
6699exit:
6700 psa_hash_abort(&sha384_psa);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02006701 return mbedtls_md_error_from_psa(status);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006702#else
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006703 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006704 mbedtls_md_context_t sha384;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006705
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006706 mbedtls_md_init(&sha384);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006707
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify sha384"));
Jerry Yuc1cb3842022-02-17 14:13:48 +08006709
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006710 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006711 if (ret != 0) {
6712 goto exit;
6713 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006714 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006715 if (ret != 0) {
6716 goto exit;
6717 }
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006718
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006719 ret = mbedtls_md_finish(&sha384, hash);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006720 if (ret != 0) {
6721 goto exit;
6722 }
Jerry Yuc1cb3842022-02-17 14:13:48 +08006723
6724 *hlen = 48;
6725
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6727 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
Jerry Yuc1cb3842022-02-17 14:13:48 +08006728
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006729exit:
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006730 mbedtls_md_free(&sha384);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006731 return ret;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006732#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006733}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006734#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006735
Neil Armstrong80f6f322022-05-03 17:56:38 +02006736#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6737 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006738int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006739{
6740 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006741 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006742 const unsigned char *psk = NULL;
6743 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006745
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006747 /*
6748 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006749 * checked before calling this function.
6750 *
6751 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006752 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006753 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6755 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6756 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006757 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006758 }
6759
6760 /*
6761 * PMS = struct {
6762 * opaque other_secret<0..2^16-1>;
6763 * opaque psk<0..2^16-1>;
6764 * };
6765 * with "other_secret" depending on the particular key exchange
6766 */
6767#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6769 if (end - p < 2) {
6770 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6771 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006772
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006774 p += 2;
6775
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 if (end < p || (size_t) (end - p) < psk_len) {
6777 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6778 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006779
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006781 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006783#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6784#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006786 /*
6787 * other_secret already set by the ClientKeyExchange message,
6788 * and is 48 bytes long
6789 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 if (end - p < 2) {
6791 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6792 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006793
6794 *p++ = 0;
6795 *p++ = 48;
6796 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006798#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6799#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006801 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6802 size_t len;
6803
6804 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006805 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6806 p + 2, end - (p + 2), &len,
6807 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6808 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6809 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006810 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006812 p += 2 + len;
6813
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6815 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006816#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006817#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006819 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6820 size_t zlen;
6821
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6823 p + 2, end - (p + 2),
6824 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6825 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6826 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006827 }
6828
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006830 p += 2 + zlen;
6831
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6833 MBEDTLS_DEBUG_ECDH_Z);
6834 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006835#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006836 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6838 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006839 }
6840
6841 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 if (end - p < 2) {
6843 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6844 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006845
Gilles Peskine449bd832023-01-11 14:50:10 +01006846 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006847 p += 2;
6848
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 if (end < p || (size_t) (end - p) < psk_len) {
6850 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6851 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006852
Gilles Peskine449bd832023-01-11 14:50:10 +01006853 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006854 p += psk_len;
6855
6856 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6857
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006859}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006860#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006861
6862#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006863MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006864static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006865
6866#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006867int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006868{
6869 /* If renegotiation is not enforced, retransmit until we would reach max
6870 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006872 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6873 unsigned char doublings = 1;
6874
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006876 ++doublings;
6877 ratio >>= 1;
6878 }
6879
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 if (++ssl->renego_records_seen > doublings) {
6881 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6882 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006883 }
6884 }
6885
Gilles Peskine449bd832023-01-11 14:50:10 +01006886 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006887}
6888#endif
6889#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006890
Jerry Yud9526692022-02-17 14:23:47 +08006891/*
6892 * Handshake functions
6893 */
6894#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6895/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006896int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006897{
6898 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6899 ssl->handshake->ciphersuite_info;
6900
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006902
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6904 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006905 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006907 }
6908
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6910 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006911}
6912
Gilles Peskine449bd832023-01-11 14:50:10 +01006913int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006914{
6915 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6916 ssl->handshake->ciphersuite_info;
6917
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006919
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6921 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006922 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006924 }
6925
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6927 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006928}
6929
6930#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6931/* Some certificate support -> implement write and parse */
6932
Gilles Peskine449bd832023-01-11 14:50:10 +01006933int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006934{
6935 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6936 size_t i, n;
6937 const mbedtls_x509_crt *crt;
6938 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6939 ssl->handshake->ciphersuite_info;
6940
Gilles Peskine449bd832023-01-11 14:50:10 +01006941 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006942
Gilles Peskine449bd832023-01-11 14:50:10 +01006943 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6944 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006945 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006947 }
6948
6949#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6951 if (ssl->handshake->client_auth == 0) {
6952 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006953 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006955 }
6956 }
6957#endif /* MBEDTLS_SSL_CLI_C */
6958#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6960 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006961 /* Should never happen because we shouldn't have picked the
6962 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006964 }
6965 }
6966#endif
6967
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006969
6970 /*
6971 * 0 . 0 handshake type
6972 * 1 . 3 handshake length
6973 * 4 . 6 length of all certs
6974 * 7 . 9 length of cert. 1
6975 * 10 . n-1 peer certificate
6976 * n . n+2 length of cert. 2
6977 * n+3 . ... upper level cert, etc.
6978 */
6979 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006980 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006981
Gilles Peskine449bd832023-01-11 14:50:10 +01006982 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006983 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6985 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6986 " > %" MBEDTLS_PRINTF_SIZET,
6987 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6988 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006989 }
6990
Gilles Peskine449bd832023-01-11 14:50:10 +01006991 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6992 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6993 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006994
Gilles Peskine449bd832023-01-11 14:50:10 +01006995 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006996 i += n; crt = crt->next;
6997 }
6998
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7000 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7001 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007002
7003 ssl->out_msglen = i;
7004 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7005 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7006
7007 ssl->state++;
7008
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7010 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7011 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007012 }
7013
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007015
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007017}
7018
7019#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7020
7021#if defined(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 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7028
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 if (peer_crt == NULL) {
7030 return -1;
7031 }
Jerry Yud9526692022-02-17 14:23:47 +08007032
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 if (peer_crt->raw.len != crt_buf_len) {
7034 return -1;
7035 }
Jerry Yud9526692022-02-17 14:23:47 +08007036
Gilles Peskine449bd832023-01-11 14:50:10 +01007037 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007038}
7039#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007040MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007041static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7042 unsigned char *crt_buf,
7043 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007044{
7045 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7046 unsigned char const * const peer_cert_digest =
7047 ssl->session->peer_cert_digest;
7048 mbedtls_md_type_t const peer_cert_digest_type =
7049 ssl->session->peer_cert_digest_type;
7050 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007052 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7053 size_t digest_len;
7054
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 if (peer_cert_digest == NULL || digest_info == NULL) {
7056 return -1;
7057 }
Jerry Yud9526692022-02-17 14:23:47 +08007058
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 digest_len = mbedtls_md_get_size(digest_info);
7060 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7061 return -1;
7062 }
Jerry Yud9526692022-02-17 14:23:47 +08007063
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7065 if (ret != 0) {
7066 return -1;
7067 }
Jerry Yud9526692022-02-17 14:23:47 +08007068
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007070}
7071#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7072#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7073
7074/*
7075 * Once the certificate message is read, parse it into a cert chain and
7076 * perform basic checks, but leave actual verification to the caller
7077 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007078MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007079static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7080 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007081{
7082 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7083#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007085#endif
7086 size_t i, n;
7087 uint8_t alert;
7088
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7090 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7091 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7092 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7093 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007094 }
7095
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7097 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7098 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7099 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007100 }
7101
Gilles Peskine449bd832023-01-11 14:50:10 +01007102 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7103 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7104 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7105 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7106 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007107 }
7108
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007110
7111 /*
7112 * Same message structure as in mbedtls_ssl_write_certificate()
7113 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007115
Gilles Peskine449bd832023-01-11 14:50:10 +01007116 if (ssl->in_msg[i] != 0 ||
7117 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7118 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7119 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7120 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7121 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007122 }
7123
7124 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7125 i += 3;
7126
7127 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007129 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 if (i + 3 > ssl->in_hslen) {
7131 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7132 mbedtls_ssl_send_alert_message(ssl,
7133 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7134 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7135 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007136 }
7137 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7138 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 if (ssl->in_msg[i] != 0) {
7140 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7141 mbedtls_ssl_send_alert_message(ssl,
7142 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7143 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7144 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007145 }
7146
7147 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007149 | (unsigned int) ssl->in_msg[i + 2];
7150 i += 3;
7151
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 if (n < 128 || i + n > ssl->in_hslen) {
7153 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7154 mbedtls_ssl_send_alert_message(ssl,
7155 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7156 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7157 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007158 }
7159
7160 /* Check if we're handling the first CRT in the chain. */
7161#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007163 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007164 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007165 /* During client-side renegotiation, check that the server's
7166 * end-CRTs hasn't changed compared to the initial handshake,
7167 * mitigating the triple handshake attack. On success, reuse
7168 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7170 if (ssl_check_peer_crt_unchanged(ssl,
7171 &ssl->in_msg[i],
7172 n) != 0) {
7173 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7174 mbedtls_ssl_send_alert_message(ssl,
7175 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7176 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7177 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007178 }
7179
7180 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007181 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007182 }
7183#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7184
7185 /* Parse the next certificate in the chain. */
7186#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007187 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007188#else
7189 /* If we don't need to store the CRT chain permanently, parse
7190 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007192#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007194 case 0: /*ok*/
7195 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7196 /* Ignore certificate with an unknown algorithm: maybe a
7197 prior certificate was already trusted. */
7198 break;
7199
7200 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7201 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7202 goto crt_parse_der_failed;
7203
7204 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7205 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7206 goto crt_parse_der_failed;
7207
7208 default:
7209 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007210crt_parse_der_failed:
7211 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7212 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7213 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007214 }
7215
7216 i += n;
7217 }
7218
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7220 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007221}
7222
7223#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007224MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007225static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007226{
Gilles Peskine449bd832023-01-11 14:50:10 +01007227 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7228 return -1;
7229 }
Jerry Yud9526692022-02-17 14:23:47 +08007230
Gilles Peskine449bd832023-01-11 14:50:10 +01007231 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007232 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7233 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007234 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7235 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7236 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007237 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007238 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007239}
7240#endif /* MBEDTLS_SSL_SRV_C */
7241
7242/* Check if a certificate message is expected.
7243 * Return either
7244 * - SSL_CERTIFICATE_EXPECTED, or
7245 * - SSL_CERTIFICATE_SKIP
7246 * indicating whether a Certificate message is expected or not.
7247 */
7248#define SSL_CERTIFICATE_EXPECTED 0
7249#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007250MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007251static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7252 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007253{
7254 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7255 ssl->handshake->ciphersuite_info;
7256
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7258 return SSL_CERTIFICATE_SKIP;
7259 }
Jerry Yud9526692022-02-17 14:23:47 +08007260
7261#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7263 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7264 return SSL_CERTIFICATE_SKIP;
7265 }
Jerry Yud9526692022-02-17 14:23:47 +08007266
Gilles Peskine449bd832023-01-11 14:50:10 +01007267 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007268 ssl->session_negotiate->verify_result =
7269 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007271 }
7272 }
7273#else
7274 ((void) authmode);
7275#endif /* MBEDTLS_SSL_SRV_C */
7276
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007278}
7279
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007280MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007281static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7282 int authmode,
7283 mbedtls_x509_crt *chain,
7284 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007285{
7286 int ret = 0;
7287 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7288 ssl->handshake->ciphersuite_info;
7289 int have_ca_chain = 0;
7290
7291 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7292 void *p_vrfy;
7293
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7295 return 0;
7296 }
Jerry Yud9526692022-02-17 14:23:47 +08007297
Gilles Peskine449bd832023-01-11 14:50:10 +01007298 if (ssl->f_vrfy != NULL) {
7299 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007300 f_vrfy = ssl->f_vrfy;
7301 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 } else {
7303 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007304 f_vrfy = ssl->conf->f_vrfy;
7305 p_vrfy = ssl->conf->p_vrfy;
7306 }
7307
7308 /*
7309 * Main check: verify certificate
7310 */
7311#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007312 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007313 ((void) rs_ctx);
7314 have_ca_chain = 1;
7315
Gilles Peskine449bd832023-01-11 14:50:10 +01007316 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007317 ret = mbedtls_x509_crt_verify_with_ca_cb(
7318 chain,
7319 ssl->conf->f_ca_cb,
7320 ssl->conf->p_ca_cb,
7321 ssl->conf->cert_profile,
7322 ssl->hostname,
7323 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007324 f_vrfy, p_vrfy);
7325 } else
Jerry Yud9526692022-02-17 14:23:47 +08007326#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7327 {
7328 mbedtls_x509_crt *ca_chain;
7329 mbedtls_x509_crl *ca_crl;
7330
7331#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007332 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007333 ca_chain = ssl->handshake->sni_ca_chain;
7334 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 } else
Jerry Yud9526692022-02-17 14:23:47 +08007336#endif
7337 {
7338 ca_chain = ssl->conf->ca_chain;
7339 ca_crl = ssl->conf->ca_crl;
7340 }
7341
Gilles Peskine449bd832023-01-11 14:50:10 +01007342 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007343 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 }
Jerry Yud9526692022-02-17 14:23:47 +08007345
7346 ret = mbedtls_x509_crt_verify_restartable(
7347 chain,
7348 ca_chain, ca_crl,
7349 ssl->conf->cert_profile,
7350 ssl->hostname,
7351 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007353 }
7354
Gilles Peskine449bd832023-01-11 14:50:10 +01007355 if (ret != 0) {
7356 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007357 }
7358
7359#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7361 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7362 }
Jerry Yud9526692022-02-17 14:23:47 +08007363#endif
7364
7365 /*
7366 * Secondary checks: always done, but change 'ret' only if it was 0
7367 */
7368
Valerio Setti6c496a12023-04-07 15:53:51 +02007369#if defined(MBEDTLS_ECP_LIGHT)
Jerry Yud9526692022-02-17 14:23:47 +08007370 {
7371 const mbedtls_pk_context *pk = &chain->pk;
7372
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007373 /* If certificate uses an EC key, make sure the curve is OK.
7374 * This is a public key, so it can't be opaque, so can_do() is a good
7375 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007377 /* and in the unlikely case the above assumption no longer holds
7378 * we are making sure that pk_ec() here does not return a NULL
7379 */
Valerio Settid0405092023-05-24 13:16:40 +02007380 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7381 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7382 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007383 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007384 }
Valerio Setti97207782023-05-18 18:59:06 +02007385 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007386 ssl->session_negotiate->verify_result |=
7387 MBEDTLS_X509_BADCERT_BAD_KEY;
7388
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7390 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007391 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007393 }
Jerry Yud9526692022-02-17 14:23:47 +08007394 }
7395 }
Valerio Setti6c496a12023-04-07 15:53:51 +02007396#endif /* MBEDTLS_ECP_LIGHT */
Jerry Yud9526692022-02-17 14:23:47 +08007397
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 if (mbedtls_ssl_check_cert_usage(chain,
7399 ciphersuite_info,
7400 !ssl->conf->endpoint,
7401 &ssl->session_negotiate->verify_result) != 0) {
7402 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7403 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007404 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 }
Jerry Yud9526692022-02-17 14:23:47 +08007406 }
7407
7408 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7409 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7410 * with details encoded in the verification flags. All other kinds
7411 * of error codes, including those from the user provided f_vrfy
7412 * functions, are treated as fatal and lead to a failure of
7413 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7415 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7416 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007417 ret = 0;
7418 }
7419
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7421 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007422 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7423 }
7424
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007426 uint8_t alert;
7427
7428 /* The certificate may have been rejected for several reasons.
7429 Pick one and send the corresponding alert. Which alert to send
7430 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007432 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007434 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007436 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007438 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007440 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007442 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007444 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007446 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007448 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007450 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007452 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 }
7454 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7455 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007456 }
7457
7458#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 if (ssl->session_negotiate->verify_result != 0) {
7460 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7461 (unsigned int) ssl->session_negotiate->verify_result));
7462 } else {
7463 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007464 }
7465#endif /* MBEDTLS_DEBUG_C */
7466
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007468}
7469
7470#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007471MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007472static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7473 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007474{
7475 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7476 /* Remember digest of the peer's end-CRT. */
7477 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7479 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7480 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7481 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7482 mbedtls_ssl_send_alert_message(ssl,
7483 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7484 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007485
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007487 }
7488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 ret = mbedtls_md(mbedtls_md_info_from_type(
7490 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7491 start, len,
7492 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007493
7494 ssl->session_negotiate->peer_cert_digest_type =
7495 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7496 ssl->session_negotiate->peer_cert_digest_len =
7497 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7498
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007500}
7501
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007502MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007503static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7504 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007505{
7506 unsigned char *end = start + len;
7507 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7508
7509 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7511 ret = mbedtls_pk_parse_subpubkey(&start, end,
7512 &ssl->handshake->peer_pubkey);
7513 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007514 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007516 }
7517
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007519}
7520#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7521
Gilles Peskine449bd832023-01-11 14:50:10 +01007522int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007523{
7524 int ret = 0;
7525 int crt_expected;
7526#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7527 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7528 ? ssl->handshake->sni_authmode
7529 : ssl->conf->authmode;
7530#else
7531 const int authmode = ssl->conf->authmode;
7532#endif
7533 void *rs_ctx = NULL;
7534 mbedtls_x509_crt *chain = NULL;
7535
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007537
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7539 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7540 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007541 goto exit;
7542 }
7543
7544#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 if (ssl->handshake->ecrs_enabled &&
7546 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007547 chain = ssl->handshake->ecrs_peer_cert;
7548 ssl->handshake->ecrs_peer_cert = NULL;
7549 goto crt_verify;
7550 }
7551#endif
7552
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007554 /* mbedtls_ssl_read_record may have sent an alert already. We
7555 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007557 goto exit;
7558 }
7559
7560#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007562 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7563
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007565 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 }
Jerry Yud9526692022-02-17 14:23:47 +08007567
7568 goto exit;
7569 }
7570#endif /* MBEDTLS_SSL_SRV_C */
7571
7572 /* Clear existing peer CRT structure in case we tried to
7573 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007575
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7577 if (chain == NULL) {
7578 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7579 sizeof(mbedtls_x509_crt)));
7580 mbedtls_ssl_send_alert_message(ssl,
7581 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7582 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007583
7584 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7585 goto exit;
7586 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007588
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 ret = ssl_parse_certificate_chain(ssl, chain);
7590 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007591 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 }
Jerry Yud9526692022-02-17 14:23:47 +08007593
7594#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007595 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007596 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 }
Jerry Yud9526692022-02-17 14:23:47 +08007598
7599crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007601 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 }
Jerry Yud9526692022-02-17 14:23:47 +08007603#endif
7604
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 ret = ssl_parse_certificate_verify(ssl, authmode,
7606 chain, rs_ctx);
7607 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007608 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 }
Jerry Yud9526692022-02-17 14:23:47 +08007610
7611#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7612 {
7613 unsigned char *crt_start, *pk_start;
7614 size_t crt_len, pk_len;
7615
7616 /* We parse the CRT chain without copying, so
7617 * these pointers point into the input buffer,
7618 * and are hence still valid after freeing the
7619 * CRT chain. */
7620
7621 crt_start = chain->raw.p;
7622 crt_len = chain->raw.len;
7623
7624 pk_start = chain->pk_raw.p;
7625 pk_len = chain->pk_raw.len;
7626
7627 /* Free the CRT structures before computing
7628 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 mbedtls_x509_crt_free(chain);
7630 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007631 chain = NULL;
7632
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7634 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007635 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 }
Jerry Yud9526692022-02-17 14:23:47 +08007637
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7639 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007640 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 }
Jerry Yud9526692022-02-17 14:23:47 +08007642 }
7643#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7644 /* Pass ownership to session structure. */
7645 ssl->session_negotiate->peer_cert = chain;
7646 chain = NULL;
7647#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7648
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007650
7651exit:
7652
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007654 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 }
Jerry Yud9526692022-02-17 14:23:47 +08007656
7657#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007659 ssl->handshake->ecrs_peer_cert = chain;
7660 chain = NULL;
7661 }
7662#endif
7663
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 if (chain != NULL) {
7665 mbedtls_x509_crt_free(chain);
7666 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007667 }
7668
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007670}
7671#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7672
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007673#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007674static int ssl_calc_finished_tls_sha256(
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007676{
7677 int len = 12;
7678 const char *sender;
7679 unsigned char padbuf[32];
7680#if defined(MBEDTLS_USE_PSA_CRYPTO)
7681 size_t hash_size;
7682 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
7683 psa_status_t status;
7684#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007685 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007686 mbedtls_md_context_t sha256;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007687#endif
7688
7689 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007690 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007691 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007693
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007695 ? "client finished"
7696 : "server finished";
7697
7698#if defined(MBEDTLS_USE_PSA_CRYPTO)
7699 sha256_psa = psa_hash_operation_init();
7700
Gilles Peskine449bd832023-01-11 14:50:10 +01007701 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls sha256"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007702
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 status = psa_hash_clone(&ssl->handshake->fin_sha256_psa, &sha256_psa);
7704 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007705 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007706 }
7707
Gilles Peskine449bd832023-01-11 14:50:10 +01007708 status = psa_hash_finish(&sha256_psa, padbuf, sizeof(padbuf), &hash_size);
7709 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007710 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007711 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, 32);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007713#else
7714
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007715 mbedtls_md_init(&sha256);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007716
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls sha256"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007718
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007719 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
7720 if (ret != 0) {
7721 goto exit;
7722 }
7723 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
7724 if (ret != 0) {
7725 goto exit;
7726 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007727
7728 /*
7729 * TLSv1.2:
7730 * hash = PRF( master, finished_label,
7731 * Hash( handshake ) )[0.11]
7732 */
7733
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007734 ret = mbedtls_md_finish(&sha256, padbuf);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007735 if (ret != 0) {
7736 goto exit;
7737 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007738#endif /* MBEDTLS_USE_PSA_CRYPTO */
7739
Manuel Pégourié-Gonnard0ac71c02023-02-24 12:13:55 +01007740 MBEDTLS_SSL_DEBUG_BUF(4, "finished sha256 output", padbuf, 32);
7741
Gilles Peskine449bd832023-01-11 14:50:10 +01007742 ssl->handshake->tls_prf(session->master, 48, sender,
7743 padbuf, 32, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007744
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007746
Gilles Peskine449bd832023-01-11 14:50:10 +01007747 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007748
Gilles Peskine449bd832023-01-11 14:50:10 +01007749 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007750
7751exit:
7752#if defined(MBEDTLS_USE_PSA_CRYPTO)
7753 psa_hash_abort(&sha256_psa);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007754 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007755#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007756 mbedtls_md_free(&sha256);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007757 return ret;
7758#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007759}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007760#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007761
Jerry Yub7ba49e2022-02-17 14:25:53 +08007762
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007763#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007764static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007765 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007766{
7767 int len = 12;
7768 const char *sender;
7769 unsigned char padbuf[48];
7770#if defined(MBEDTLS_USE_PSA_CRYPTO)
7771 size_t hash_size;
7772 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
7773 psa_status_t status;
7774#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007775 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007776 mbedtls_md_context_t sha384;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007777#endif
7778
7779 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007780 if (!session) {
Jerry Yub7ba49e2022-02-17 14:25:53 +08007781 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007782 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007783
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007785 ? "client finished"
7786 : "server finished";
7787
7788#if defined(MBEDTLS_USE_PSA_CRYPTO)
7789 sha384_psa = psa_hash_operation_init();
7790
Gilles Peskine449bd832023-01-11 14:50:10 +01007791 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls sha384"));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007792
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 status = psa_hash_clone(&ssl->handshake->fin_sha384_psa, &sha384_psa);
7794 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007795 goto exit;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007796 }
7797
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 status = psa_hash_finish(&sha384_psa, padbuf, sizeof(padbuf), &hash_size);
7799 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007800 goto exit;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007801 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, 48);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007803#else
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007804 mbedtls_md_init(&sha384);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007805
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls sha384"));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007807
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007808 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007809 if (ret != 0) {
7810 goto exit;
7811 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007812 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007813 if (ret != 0) {
7814 goto exit;
7815 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007816
7817 /*
7818 * TLSv1.2:
7819 * hash = PRF( master, finished_label,
7820 * Hash( handshake ) )[0.11]
7821 */
7822
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007823 ret = mbedtls_md_finish(&sha384, padbuf);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007824 if (ret != 0) {
7825 goto exit;
7826 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007827#endif
7828
Manuel Pégourié-Gonnard0ac71c02023-02-24 12:13:55 +01007829 MBEDTLS_SSL_DEBUG_BUF(4, "finished sha384 output", padbuf, 48);
7830
Gilles Peskine449bd832023-01-11 14:50:10 +01007831 ssl->handshake->tls_prf(session->master, 48, sender,
7832 padbuf, 48, buf, len);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007833
Gilles Peskine449bd832023-01-11 14:50:10 +01007834 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007835
Gilles Peskine449bd832023-01-11 14:50:10 +01007836 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007837
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007839
7840exit:
7841#if defined(MBEDTLS_USE_PSA_CRYPTO)
7842 psa_hash_abort(&sha384_psa);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007843 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007844#else
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007845 mbedtls_md_free(&sha384);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007846 return ret;
7847#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yub7ba49e2022-02-17 14:25:53 +08007848}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007849#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007850
Gilles Peskine449bd832023-01-11 14:50:10 +01007851void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007852{
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007854
7855 /*
7856 * Free our handshake params
7857 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007858 mbedtls_ssl_handshake_free(ssl);
7859 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007860 ssl->handshake = NULL;
7861
7862 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007863 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007864 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007865 if (ssl->transform) {
7866 mbedtls_ssl_transform_free(ssl->transform);
7867 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007868 }
7869 ssl->transform = ssl->transform_negotiate;
7870 ssl->transform_negotiate = NULL;
7871
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007873}
7874
Gilles Peskine449bd832023-01-11 14:50:10 +01007875void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007876{
7877 int resume = ssl->handshake->resume;
7878
Gilles Peskine449bd832023-01-11 14:50:10 +01007879 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007880
7881#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007882 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007883 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7884 ssl->renego_records_seen = 0;
7885 }
7886#endif
7887
7888 /*
7889 * Free the previous session and switch in the current one
7890 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007891 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007892#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7893 /* RFC 7366 3.1: keep the EtM state */
7894 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007896#endif
7897
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 mbedtls_ssl_session_free(ssl->session);
7899 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007900 }
7901 ssl->session = ssl->session_negotiate;
7902 ssl->session_negotiate = NULL;
7903
7904 /*
7905 * Add cache entry
7906 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007908 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 resume == 0) {
7910 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7911 ssl->session->id,
7912 ssl->session->id_len,
7913 ssl->session) != 0) {
7914 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7915 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007916 }
7917
7918#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007919 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7920 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007921 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007923
7924 /* Keep last flight around in case we need to resend it:
7925 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7927 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007928#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007930
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007931 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007932
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007934}
7935
Gilles Peskine449bd832023-01-11 14:50:10 +01007936int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007937{
7938 int ret, hash_len;
7939
Gilles Peskine449bd832023-01-11 14:50:10 +01007940 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007941
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007943
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007944 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7945 if (ret != 0) {
7946 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7947 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007948
7949 /*
7950 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7951 * may define some other value. Currently (early 2016), no defined
7952 * ciphersuite does this (and this is unlikely to change as activity has
7953 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7954 */
7955 hash_len = 12;
7956
7957#if defined(MBEDTLS_SSL_RENEGOTIATION)
7958 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007960#endif
7961
7962 ssl->out_msglen = 4 + hash_len;
7963 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7964 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7965
7966 /*
7967 * In case of session resuming, invert the client and server
7968 * ChangeCipherSpec messages order.
7969 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007971#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007972 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007973 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007974 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007975#endif
7976#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007978 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007979 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007980#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007982 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007984
7985 /*
7986 * Switch to our negotiated transform and session parameters for outbound
7987 * data.
7988 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007990
7991#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007992 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007993 unsigned char i;
7994
7995 /* Remember current epoch settings for resending */
7996 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007997 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7998 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007999
8000 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008002
8003
8004 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 for (i = 2; i > 0; i--) {
8006 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008007 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 }
8009 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008010
8011 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 if (i == 0) {
8013 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8014 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008015 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008017#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008019
8020 ssl->transform_out = ssl->transform_negotiate;
8021 ssl->session_out = ssl->session_negotiate;
8022
8023#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8025 mbedtls_ssl_send_flight_completed(ssl);
8026 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008027#endif
8028
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8030 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8031 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008032 }
8033
8034#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8036 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8037 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8038 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008039 }
8040#endif
8041
Gilles Peskine449bd832023-01-11 14:50:10 +01008042 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008043
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008045}
8046
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008047#define SSL_MAX_HASH_LEN 12
8048
Gilles Peskine449bd832023-01-11 14:50:10 +01008049int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008050{
8051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8052 unsigned int hash_len = 12;
8053 unsigned char buf[SSL_MAX_HASH_LEN];
8054
Gilles Peskine449bd832023-01-11 14:50:10 +01008055 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008056
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008057 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8058 if (ret != 0) {
8059 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8060 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008061
Gilles Peskine449bd832023-01-11 14:50:10 +01008062 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8063 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008064 goto exit;
8065 }
8066
Gilles Peskine449bd832023-01-11 14:50:10 +01008067 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8068 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8069 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8070 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008071 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8072 goto exit;
8073 }
8074
Gilles Peskine449bd832023-01-11 14:50:10 +01008075 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8076 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8077 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008078 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8079 goto exit;
8080 }
8081
Gilles Peskine449bd832023-01-11 14:50:10 +01008082 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8083 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8084 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8085 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008086 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8087 goto exit;
8088 }
8089
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8091 buf, hash_len) != 0) {
8092 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8093 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8094 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008095 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8096 goto exit;
8097 }
8098
8099#if defined(MBEDTLS_SSL_RENEGOTIATION)
8100 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008102#endif
8103
Gilles Peskine449bd832023-01-11 14:50:10 +01008104 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008105#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008106 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008107 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008108 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008109#endif
8110#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008112 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008113 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008114#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008115 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008116 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008118
8119#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8121 mbedtls_ssl_recv_flight_completed(ssl);
8122 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008123#endif
8124
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008126
8127exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008128 mbedtls_platform_zeroize(buf, hash_len);
8129 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008130}
8131
Jerry Yu392112c2022-02-17 14:34:10 +08008132#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8133/*
8134 * Helper to get TLS 1.2 PRF from ciphersuite
8135 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8136 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008137static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008138{
Jerry Yu392112c2022-02-17 14:34:10 +08008139 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008140 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008141#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8143 return tls_prf_sha384;
8144 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008145#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008146#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008147 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008148 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8149 return tls_prf_sha256;
8150 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008151 }
8152#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008153#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8154 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008155 (void) ciphersuite_info;
8156#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008157
Gilles Peskine449bd832023-01-11 14:50:10 +01008158 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008159}
8160#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008161
Gilles Peskine449bd832023-01-11 14:50:10 +01008162static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008163{
8164 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008165#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008166 if (tls_prf == tls_prf_sha384) {
8167 return MBEDTLS_SSL_TLS_PRF_SHA384;
8168 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008169#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008170#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008171 if (tls_prf == tls_prf_sha256) {
8172 return MBEDTLS_SSL_TLS_PRF_SHA256;
8173 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008174#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008175 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008176}
8177
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008178/*
8179 * Populate a transform structure with session keys and all the other
8180 * necessary information.
8181 *
8182 * Parameters:
8183 * - [in/out]: transform: structure to populate
8184 * [in] must be just initialised with mbedtls_ssl_transform_init()
8185 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8186 * - [in] ciphersuite
8187 * - [in] master
8188 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008189 * - [in] tls_prf: pointer to PRF to use for key derivation
8190 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008191 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008192 * - [in] endpoint: client or server
8193 * - [in] ssl: used for:
8194 * - ssl->conf->{f,p}_export_keys
8195 * [in] optionally used for:
8196 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8197 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008198MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008199static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8200 int ciphersuite,
8201 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008202#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008203 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008204#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008205 ssl_tls_prf_t tls_prf,
8206 const unsigned char randbytes[64],
8207 mbedtls_ssl_protocol_version tls_version,
8208 unsigned endpoint,
8209 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008210{
8211 int ret = 0;
8212 unsigned char keyblk[256];
8213 unsigned char *key1;
8214 unsigned char *key2;
8215 unsigned char *mac_enc;
8216 unsigned char *mac_dec;
8217 size_t mac_key_len = 0;
8218 size_t iv_copy_len;
8219 size_t keylen;
8220 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008221 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008222#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008223 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008224 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008225#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008226
8227#if defined(MBEDTLS_USE_PSA_CRYPTO)
8228 psa_key_type_t key_type;
8229 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8230 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008231 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008232 size_t key_bits;
8233 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8234#endif
8235
8236#if !defined(MBEDTLS_DEBUG_C) && \
8237 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008239 ssl = NULL; /* make sure we don't use it except for these cases */
8240 (void) ssl;
8241 }
8242#endif
8243
8244 /*
8245 * Some data just needs copying into the structure
8246 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008247#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008248 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008249#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008250 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008251
8252#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008253 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008254#endif
8255
8256#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008257 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008258 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8259 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008260 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008261 }
8262#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8263
8264 /*
8265 * Get various info structures
8266 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8268 if (ciphersuite_info == NULL) {
8269 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8270 ciphersuite));
8271 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008272 }
8273
Neil Armstrongab555e02022-04-04 11:07:59 +02008274 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008275#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008276 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008277#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008278 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008279
Gilles Peskine449bd832023-01-11 14:50:10 +01008280 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008281 transform->taglen =
8282 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008283 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008284
8285#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 if ((status = mbedtls_ssl_cipher_to_psa(ciphersuite_info->cipher,
8287 transform->taglen,
8288 &alg,
8289 &key_type,
8290 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008291 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008293 goto end;
8294 }
8295#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008296 cipher_info = mbedtls_cipher_info_from_type(ciphersuite_info->cipher);
8297 if (cipher_info == NULL) {
8298 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8299 ciphersuite_info->cipher));
8300 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008301 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008302#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008303
Neil Armstronge4512952022-03-08 09:08:22 +01008304#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008305 mac_alg = mbedtls_md_psa_alg_from_type(ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008306 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008307 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 (unsigned) ciphersuite_info->mac));
8309 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008310 }
8311#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008312 md_info = mbedtls_md_info_from_type(ciphersuite_info->mac);
8313 if (md_info == NULL) {
8314 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8315 (unsigned) ciphersuite_info->mac));
8316 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008317 }
Neil Armstronge4512952022-03-08 09:08:22 +01008318#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008319
8320#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8321 /* Copy own and peer's CID if the use of the CID
8322 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008323 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8324 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008325
8326 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8328 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8329 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008330
8331 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008332 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8333 ssl->handshake->peer_cid_len);
8334 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8335 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008336 }
8337#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8338
8339 /*
8340 * Compute key block using the PRF
8341 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008342 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8343 if (ret != 0) {
8344 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8345 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008346 }
8347
Gilles Peskine449bd832023-01-11 14:50:10 +01008348 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8349 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8350 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8351 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8352 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008353
8354 /*
8355 * Determine the appropriate key, IV and MAC length.
8356 */
8357
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008358#if defined(MBEDTLS_USE_PSA_CRYPTO)
8359 keylen = PSA_BITS_TO_BYTES(key_bits);
8360#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008361 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008362#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008363
8364#if defined(MBEDTLS_GCM_C) || \
8365 defined(MBEDTLS_CCM_C) || \
8366 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008368 size_t explicit_ivlen;
8369
8370 transform->maclen = 0;
8371 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008372
8373 /* All modes haves 96-bit IVs, but the length of the static parts vary
8374 * with mode and version:
8375 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8376 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8377 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8378 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8379 * sequence number).
8380 */
8381 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008382
8383 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008384#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008385 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008386#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008387 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8388 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008389#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008390
Gilles Peskine449bd832023-01-11 14:50:10 +01008391 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008392 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008393 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008394 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008395 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008396
8397 /* Minimum length of encrypted record */
8398 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8399 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008400 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008401#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8402#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008403 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008404 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008405 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008406#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008407 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008408#else
8409 size_t block_size = cipher_info->block_size;
8410#endif /* MBEDTLS_USE_PSA_CRYPTO */
8411
8412#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008413 /* Get MAC length */
8414 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8415#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008416 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008417 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8418 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8419 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008420 goto end;
8421 }
8422
8423 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008424 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008425#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008426 transform->maclen = mac_key_len;
8427
8428 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008429#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008430 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008431#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008432 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008433#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008434
8435 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008436 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008437 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008438 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008439 /*
8440 * GenericBlockCipher:
8441 * 1. if EtM is in use: one block plus MAC
8442 * otherwise: * first multiple of blocklen greater than maclen
8443 * 2. IV
8444 */
8445#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008446 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008447 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008448 + block_size;
8449 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008450#endif
8451 {
8452 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008453 + block_size
8454 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008455 }
8456
Gilles Peskine449bd832023-01-11 14:50:10 +01008457 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008458 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 } else {
8460 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008461 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8462 goto end;
8463 }
8464 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008466#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8467 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8469 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008470 }
8471
Gilles Peskine449bd832023-01-11 14:50:10 +01008472 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8473 (unsigned) keylen,
8474 (unsigned) transform->minlen,
8475 (unsigned) transform->ivlen,
8476 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008477
8478 /*
8479 * Finally setup the cipher contexts, IVs and MAC secrets.
8480 */
8481#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008482 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008483 key1 = keyblk + mac_key_len * 2;
8484 key2 = keyblk + mac_key_len * 2 + keylen;
8485
8486 mac_enc = keyblk;
8487 mac_dec = keyblk + mac_key_len;
8488
Gilles Peskine449bd832023-01-11 14:50:10 +01008489 iv_copy_len = (transform->fixed_ivlen) ?
8490 transform->fixed_ivlen : transform->ivlen;
8491 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8492 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8493 iv_copy_len);
8494 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008495#endif /* MBEDTLS_SSL_CLI_C */
8496#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008497 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008498 key1 = keyblk + mac_key_len * 2 + keylen;
8499 key2 = keyblk + mac_key_len * 2;
8500
8501 mac_enc = keyblk + mac_key_len;
8502 mac_dec = keyblk;
8503
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 iv_copy_len = (transform->fixed_ivlen) ?
8505 transform->fixed_ivlen : transform->ivlen;
8506 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8507 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8508 iv_copy_len);
8509 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008510#endif /* MBEDTLS_SSL_SRV_C */
8511 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008512 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008513 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8514 goto end;
8515 }
8516
Gilles Peskine449bd832023-01-11 14:50:10 +01008517 if (ssl != NULL && ssl->f_export_keys != NULL) {
8518 ssl->f_export_keys(ssl->p_export_keys,
8519 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8520 master, 48,
8521 randbytes + 32,
8522 randbytes,
8523 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008524 }
8525
8526#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008527 transform->psa_alg = alg;
8528
Gilles Peskine449bd832023-01-11 14:50:10 +01008529 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8530 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8531 psa_set_key_algorithm(&attributes, alg);
8532 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008533
Gilles Peskine449bd832023-01-11 14:50:10 +01008534 if ((status = psa_import_key(&attributes,
8535 key1,
8536 PSA_BITS_TO_BYTES(key_bits),
8537 &transform->psa_key_enc)) != PSA_SUCCESS) {
8538 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008539 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008540 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008541 goto end;
8542 }
8543
Gilles Peskine449bd832023-01-11 14:50:10 +01008544 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008545
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 if ((status = psa_import_key(&attributes,
8547 key2,
8548 PSA_BITS_TO_BYTES(key_bits),
8549 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008550 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008552 goto end;
8553 }
8554 }
8555#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008556 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8557 cipher_info)) != 0) {
8558 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008559 goto end;
8560 }
8561
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8563 cipher_info)) != 0) {
8564 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008565 goto end;
8566 }
8567
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8569 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8570 MBEDTLS_ENCRYPT)) != 0) {
8571 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008572 goto end;
8573 }
8574
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8576 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8577 MBEDTLS_DECRYPT)) != 0) {
8578 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008579 goto end;
8580 }
8581
8582#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008583 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8584 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8585 MBEDTLS_PADDING_NONE)) != 0) {
8586 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008587 goto end;
8588 }
8589
Gilles Peskine449bd832023-01-11 14:50:10 +01008590 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8591 MBEDTLS_PADDING_NONE)) != 0) {
8592 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008593 goto end;
8594 }
8595 }
8596#endif /* MBEDTLS_CIPHER_MODE_CBC */
8597#endif /* MBEDTLS_USE_PSA_CRYPTO */
8598
Neil Armstrong29c0c042022-03-17 17:47:28 +01008599#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8600 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8601 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008602 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008603#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008605
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8607 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8608 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008609
Gilles Peskine449bd832023-01-11 14:50:10 +01008610 if ((status = psa_import_key(&attributes,
8611 mac_enc, mac_key_len,
8612 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008613 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008615 goto end;
8616 }
8617
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8619 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008620#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008621 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008622#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008623 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008624 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8626 PSA_KEY_USAGE_VERIFY_HASH);
8627 } else {
8628 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8629 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008630
Gilles Peskine449bd832023-01-11 14:50:10 +01008631 if ((status = psa_import_key(&attributes,
8632 mac_dec, mac_key_len,
8633 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008634 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008635 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008636 goto end;
8637 }
8638#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008639 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8640 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008641 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 }
8643 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8644 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008645 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008647#endif /* MBEDTLS_USE_PSA_CRYPTO */
8648 }
8649#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8650
8651 ((void) mac_dec);
8652 ((void) mac_enc);
8653
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008654end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008655 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8656 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008657}
8658
Valerio Settia08b1a42022-11-17 15:10:02 +01008659#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8660 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008661int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008662 psa_pake_operation_t *pake_ctx,
8663 const unsigned char *buf,
8664 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008665{
8666 psa_status_t status;
8667 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008668 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008669 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8670 * At round two perform a single cycle
8671 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008672 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008673
Gilles Peskine449bd832023-01-11 14:50:10 +01008674 for (; remaining_steps > 0; remaining_steps--) {
8675 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008676 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008678 /* Length is stored at the first byte */
8679 size_t length = buf[input_offset];
8680 input_offset += 1;
8681
Gilles Peskine449bd832023-01-11 14:50:10 +01008682 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008683 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8684 }
8685
Gilles Peskine449bd832023-01-11 14:50:10 +01008686 status = psa_pake_input(pake_ctx, step,
8687 buf + input_offset, length);
8688 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008689 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008690 }
8691
8692 input_offset += length;
8693 }
8694 }
8695
Gilles Peskine449bd832023-01-11 14:50:10 +01008696 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008697 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008698 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008699
Gilles Peskine449bd832023-01-11 14:50:10 +01008700 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008701}
8702
Valerio Setti6b3dab02022-11-17 17:14:54 +01008703int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 psa_pake_operation_t *pake_ctx,
8705 unsigned char *buf,
8706 size_t len, size_t *olen,
8707 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008708{
8709 psa_status_t status;
8710 size_t output_offset = 0;
8711 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008712 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008713 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8714 * At round two perform a single cycle
8715 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008716 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008717
Gilles Peskine449bd832023-01-11 14:50:10 +01008718 for (; remaining_steps > 0; remaining_steps--) {
8719 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8720 step <= PSA_PAKE_STEP_ZK_PROOF;
8721 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008722 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008723 * For each step, prepend 1 byte with the length of the data as
8724 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008725 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008726 status = psa_pake_output(pake_ctx, step,
8727 buf + output_offset + 1,
8728 len - output_offset - 1,
8729 &output_len);
8730 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008731 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008732 }
8733
Valerio Setti99d88c12022-11-22 16:03:43 +01008734 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008735
8736 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008737 }
8738 }
8739
8740 *olen = output_offset;
8741
Gilles Peskine449bd832023-01-11 14:50:10 +01008742 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008743}
Valerio Settia08b1a42022-11-17 15:10:02 +01008744#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8745
Jerry Yuee40f9d2022-02-17 14:55:16 +08008746#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008747int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8748 unsigned char *hash, size_t *hashlen,
8749 unsigned char *data, size_t data_len,
8750 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008751{
8752 psa_status_t status;
8753 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008754 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008755
Gilles Peskine449bd832023-01-11 14:50:10 +01008756 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008757
Gilles Peskine449bd832023-01-11 14:50:10 +01008758 if ((status = psa_hash_setup(&hash_operation,
8759 hash_alg)) != PSA_SUCCESS) {
8760 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008761 goto exit;
8762 }
8763
Gilles Peskine449bd832023-01-11 14:50:10 +01008764 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8765 64)) != PSA_SUCCESS) {
8766 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008767 goto exit;
8768 }
8769
Gilles Peskine449bd832023-01-11 14:50:10 +01008770 if ((status = psa_hash_update(&hash_operation,
8771 data, data_len)) != PSA_SUCCESS) {
8772 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008773 goto exit;
8774 }
8775
Gilles Peskine449bd832023-01-11 14:50:10 +01008776 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8777 hashlen)) != PSA_SUCCESS) {
8778 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8779 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008780 }
8781
8782exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008783 if (status != PSA_SUCCESS) {
8784 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8785 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8786 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008787 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008788 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008789 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8790 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008791 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008792 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008793 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008794 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008795 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008796 }
8797 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008798 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008799}
8800
8801#else
8802
Gilles Peskine449bd832023-01-11 14:50:10 +01008803int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8804 unsigned char *hash, size_t *hashlen,
8805 unsigned char *data, size_t data_len,
8806 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008807{
8808 int ret = 0;
8809 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008810 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8811 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008812
Gilles Peskine449bd832023-01-11 14:50:10 +01008813 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008814
Gilles Peskine449bd832023-01-11 14:50:10 +01008815 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008816
8817 /*
8818 * digitally-signed struct {
8819 * opaque client_random[32];
8820 * opaque server_random[32];
8821 * ServerDHParams params;
8822 * };
8823 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008824 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8825 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008826 goto exit;
8827 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008828 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8829 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008830 goto exit;
8831 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008832 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8833 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008834 goto exit;
8835 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008836 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8837 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008838 goto exit;
8839 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008840 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8841 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008842 goto exit;
8843 }
8844
8845exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008846 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008847
Gilles Peskine449bd832023-01-11 14:50:10 +01008848 if (ret != 0) {
8849 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8850 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8851 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008852
Gilles Peskine449bd832023-01-11 14:50:10 +01008853 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008854}
8855#endif /* MBEDTLS_USE_PSA_CRYPTO */
8856
Jerry Yud9d91da2022-02-17 14:57:06 +08008857#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8858
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008859/* Find the preferred hash for a given signature algorithm. */
8860unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008861 mbedtls_ssl_context *ssl,
8862 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008863{
Gabor Mezei078e8032022-04-27 21:17:56 +02008864 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008865 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008866
Gilles Peskine449bd832023-01-11 14:50:10 +01008867 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8868 return MBEDTLS_SSL_HASH_NONE;
8869 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008870
Gilles Peskine449bd832023-01-11 14:50:10 +01008871 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008872 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008873 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8874 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008875 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008876 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8877 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008878
Gilles Peskine449bd832023-01-11 14:50:10 +01008879 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008880#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008881 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008882 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008883 mbedtls_md_psa_alg_from_type(hash_alg_received);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008884
Gilles Peskine449bd832023-01-11 14:50:10 +01008885 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8886 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8887 PSA_ALG_ECDSA(psa_hash_alg),
8888 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008889 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008890 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008891
Gilles Peskine449bd832023-01-11 14:50:10 +01008892 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8893 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8894 PSA_ALG_RSA_PKCS1V15_SIGN(
8895 psa_hash_alg),
8896 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008897 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008898 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008899 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008900#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008901
Gilles Peskine449bd832023-01-11 14:50:10 +01008902 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008903 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008904 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008905
Gilles Peskine449bd832023-01-11 14:50:10 +01008906 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008907}
8908
8909#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8910
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008911/* Serialization of TLS 1.2 sessions:
8912 *
8913 * struct {
8914 * uint64 start_time;
8915 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008916 * uint8 session_id_len; // at most 32
8917 * opaque session_id[32];
8918 * opaque master[48]; // fixed length in the standard
8919 * uint32 verify_result;
8920 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8921 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8922 * uint32 ticket_lifetime;
8923 * uint8 mfl_code; // up to 255 according to standard
8924 * uint8 encrypt_then_mac; // 0 or 1
8925 * } serialized_session_tls12;
8926 *
8927 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008928static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8929 unsigned char *buf,
8930 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008931{
8932 unsigned char *p = buf;
8933 size_t used = 0;
8934
8935#if defined(MBEDTLS_HAVE_TIME)
8936 uint64_t start;
8937#endif
8938#if defined(MBEDTLS_X509_CRT_PARSE_C)
8939#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8940 size_t cert_len;
8941#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8942#endif /* MBEDTLS_X509_CRT_PARSE_C */
8943
8944 /*
8945 * Time
8946 */
8947#if defined(MBEDTLS_HAVE_TIME)
8948 used += 8;
8949
Gilles Peskine449bd832023-01-11 14:50:10 +01008950 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008951 start = (uint64_t) session->start;
8952
Gilles Peskine449bd832023-01-11 14:50:10 +01008953 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008954 p += 8;
8955 }
8956#endif /* MBEDTLS_HAVE_TIME */
8957
8958 /*
8959 * Basic mandatory fields
8960 */
8961 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008962 + 1 /* id_len */
8963 + sizeof(session->id)
8964 + sizeof(session->master)
8965 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008966
Gilles Peskine449bd832023-01-11 14:50:10 +01008967 if (used <= buf_len) {
8968 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008969 p += 2;
8970
Gilles Peskine449bd832023-01-11 14:50:10 +01008971 *p++ = MBEDTLS_BYTE_0(session->id_len);
8972 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008973 p += 32;
8974
Gilles Peskine449bd832023-01-11 14:50:10 +01008975 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008976 p += 48;
8977
Gilles Peskine449bd832023-01-11 14:50:10 +01008978 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008979 p += 4;
8980 }
8981
8982 /*
8983 * Peer's end-entity certificate
8984 */
8985#if defined(MBEDTLS_X509_CRT_PARSE_C)
8986#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008987 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008988 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008989 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008990 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008991 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008992
8993 used += 3 + cert_len;
8994
Gilles Peskine449bd832023-01-11 14:50:10 +01008995 if (used <= buf_len) {
8996 *p++ = MBEDTLS_BYTE_2(cert_len);
8997 *p++ = MBEDTLS_BYTE_1(cert_len);
8998 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008999
Gilles Peskine449bd832023-01-11 14:50:10 +01009000 if (session->peer_cert != NULL) {
9001 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009002 p += cert_len;
9003 }
9004 }
9005#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01009006 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009007 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009008 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009009 *p++ = (unsigned char) session->peer_cert_digest_type;
9010 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009011 memcpy(p, session->peer_cert_digest,
9012 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009013 p += session->peer_cert_digest_len;
9014 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009015 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009016 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009018 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9019 *p++ = 0;
9020 }
9021 }
9022#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9023#endif /* MBEDTLS_X509_CRT_PARSE_C */
9024
9025 /*
9026 * Session ticket if any, plus associated data
9027 */
9028#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9029 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9030
Gilles Peskine449bd832023-01-11 14:50:10 +01009031 if (used <= buf_len) {
9032 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9033 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9034 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009035
Gilles Peskine449bd832023-01-11 14:50:10 +01009036 if (session->ticket != NULL) {
9037 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009038 p += session->ticket_len;
9039 }
9040
Gilles Peskine449bd832023-01-11 14:50:10 +01009041 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009042 p += 4;
9043 }
9044#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9045
9046 /*
9047 * Misc extension-related info
9048 */
9049#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9050 used += 1;
9051
Gilles Peskine449bd832023-01-11 14:50:10 +01009052 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009053 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009054 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009055#endif
9056
9057#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9058 used += 1;
9059
Gilles Peskine449bd832023-01-11 14:50:10 +01009060 if (used <= buf_len) {
9061 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9062 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009063#endif
9064
Gilles Peskine449bd832023-01-11 14:50:10 +01009065 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009066}
9067
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009068MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009069static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9070 const unsigned char *buf,
9071 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009072{
9073#if defined(MBEDTLS_HAVE_TIME)
9074 uint64_t start;
9075#endif
9076#if defined(MBEDTLS_X509_CRT_PARSE_C)
9077#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9078 size_t cert_len;
9079#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9080#endif /* MBEDTLS_X509_CRT_PARSE_C */
9081
9082 const unsigned char *p = buf;
9083 const unsigned char * const end = buf + len;
9084
9085 /*
9086 * Time
9087 */
9088#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009089 if (8 > (size_t) (end - p)) {
9090 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9091 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009092
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009093 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009094 p += 8;
9095
9096 session->start = (time_t) start;
9097#endif /* MBEDTLS_HAVE_TIME */
9098
9099 /*
9100 * Basic mandatory fields
9101 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009102 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9103 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9104 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009105
Gilles Peskine449bd832023-01-11 14:50:10 +01009106 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009107 p += 2;
9108
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009109 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009110 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009111 p += 32;
9112
Gilles Peskine449bd832023-01-11 14:50:10 +01009113 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009114 p += 48;
9115
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009116 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009117 p += 4;
9118
9119 /* Immediately clear invalid pointer values that have been read, in case
9120 * we exit early before we replaced them with valid ones. */
9121#if defined(MBEDTLS_X509_CRT_PARSE_C)
9122#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9123 session->peer_cert = NULL;
9124#else
9125 session->peer_cert_digest = NULL;
9126#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9127#endif /* MBEDTLS_X509_CRT_PARSE_C */
9128#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9129 session->ticket = NULL;
9130#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9131
9132 /*
9133 * Peer certificate
9134 */
9135#if defined(MBEDTLS_X509_CRT_PARSE_C)
9136#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9137 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009138 if (3 > (size_t) (end - p)) {
9139 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9140 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009141
Gilles Peskine449bd832023-01-11 14:50:10 +01009142 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009143 p += 3;
9144
Gilles Peskine449bd832023-01-11 14:50:10 +01009145 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009146 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9147
Gilles Peskine449bd832023-01-11 14:50:10 +01009148 if (cert_len > (size_t) (end - p)) {
9149 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9150 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009151
Gilles Peskine449bd832023-01-11 14:50:10 +01009152 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009153
Gilles Peskine449bd832023-01-11 14:50:10 +01009154 if (session->peer_cert == NULL) {
9155 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9156 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009157
Gilles Peskine449bd832023-01-11 14:50:10 +01009158 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009159
Gilles Peskine449bd832023-01-11 14:50:10 +01009160 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9161 p, cert_len)) != 0) {
9162 mbedtls_x509_crt_free(session->peer_cert);
9163 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009164 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009165 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009166 }
9167
9168 p += cert_len;
9169 }
9170#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9171 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009172 if (2 > (size_t) (end - p)) {
9173 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9174 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009175
9176 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9177 session->peer_cert_digest_len = (size_t) *p++;
9178
Gilles Peskine449bd832023-01-11 14:50:10 +01009179 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009180 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009181 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9182 if (md_info == NULL) {
9183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9184 }
9185 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9186 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9187 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009188
Gilles Peskine449bd832023-01-11 14:50:10 +01009189 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9190 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9191 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009192
9193 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009194 mbedtls_calloc(1, session->peer_cert_digest_len);
9195 if (session->peer_cert_digest == NULL) {
9196 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9197 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009198
Gilles Peskine449bd832023-01-11 14:50:10 +01009199 memcpy(session->peer_cert_digest, p,
9200 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009201 p += session->peer_cert_digest_len;
9202 }
9203#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9204#endif /* MBEDTLS_X509_CRT_PARSE_C */
9205
9206 /*
9207 * Session ticket and associated data
9208 */
9209#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 if (3 > (size_t) (end - p)) {
9211 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9212 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009213
Gilles Peskine449bd832023-01-11 14:50:10 +01009214 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009215 p += 3;
9216
Gilles Peskine449bd832023-01-11 14:50:10 +01009217 if (session->ticket_len != 0) {
9218 if (session->ticket_len > (size_t) (end - p)) {
9219 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9220 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009221
Gilles Peskine449bd832023-01-11 14:50:10 +01009222 session->ticket = mbedtls_calloc(1, session->ticket_len);
9223 if (session->ticket == NULL) {
9224 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9225 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009226
Gilles Peskine449bd832023-01-11 14:50:10 +01009227 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009228 p += session->ticket_len;
9229 }
9230
Gilles Peskine449bd832023-01-11 14:50:10 +01009231 if (4 > (size_t) (end - p)) {
9232 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9233 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009234
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009235 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009236 p += 4;
9237#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9238
9239 /*
9240 * Misc extension-related info
9241 */
9242#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009243 if (1 > (size_t) (end - p)) {
9244 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9245 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009246
9247 session->mfl_code = *p++;
9248#endif
9249
9250#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009251 if (1 > (size_t) (end - p)) {
9252 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9253 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009254
9255 session->encrypt_then_mac = *p++;
9256#endif
9257
9258 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009259 if (p != end) {
9260 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9261 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009262
Gilles Peskine449bd832023-01-11 14:50:10 +01009263 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009264}
Jerry Yudc7bd172022-02-17 13:44:15 +08009265#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9266
XiaokangQian75d40ef2022-04-20 11:05:24 +00009267int mbedtls_ssl_validate_ciphersuite(
9268 const mbedtls_ssl_context *ssl,
9269 const mbedtls_ssl_ciphersuite_t *suite_info,
9270 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009271 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009272{
9273 (void) ssl;
9274
Gilles Peskine449bd832023-01-11 14:50:10 +01009275 if (suite_info == NULL) {
9276 return -1;
9277 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009278
Gilles Peskine449bd832023-01-11 14:50:10 +01009279 if ((suite_info->min_tls_version > max_tls_version) ||
9280 (suite_info->max_tls_version < min_tls_version)) {
9281 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009282 }
9283
XiaokangQian060d8672022-04-21 09:24:56 +00009284#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009285#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009286#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009287 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9288 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009289#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009290 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9291 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009292#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009293 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009294 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009295 }
9296#endif
9297
9298 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9299#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009300 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9301 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9302 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009303 }
9304#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9305#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9306
Gilles Peskine449bd832023-01-11 14:50:10 +01009307 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009308}
9309
Ronald Crone68ab4f2022-10-05 12:46:29 +02009310#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009311/*
9312 * Function for writing a signature algorithm extension.
9313 *
9314 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9315 * value (TLS 1.3 RFC8446):
9316 * enum {
9317 * ....
9318 * ecdsa_secp256r1_sha256( 0x0403 ),
9319 * ecdsa_secp384r1_sha384( 0x0503 ),
9320 * ecdsa_secp521r1_sha512( 0x0603 ),
9321 * ....
9322 * } SignatureScheme;
9323 *
9324 * struct {
9325 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9326 * } SignatureSchemeList;
9327 *
9328 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9329 * value (TLS 1.2 RFC5246):
9330 * enum {
9331 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9332 * sha512(6), (255)
9333 * } HashAlgorithm;
9334 *
9335 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9336 * SignatureAlgorithm;
9337 *
9338 * struct {
9339 * HashAlgorithm hash;
9340 * SignatureAlgorithm signature;
9341 * } SignatureAndHashAlgorithm;
9342 *
9343 * SignatureAndHashAlgorithm
9344 * supported_signature_algorithms<2..2^16-2>;
9345 *
9346 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9347 * generalization of the TLS 1.2 signature algorithm extension.
9348 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9349 * `SignatureScheme` field of TLS 1.3
9350 *
9351 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009352int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9353 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009354{
9355 unsigned char *p = buf;
9356 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9357 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9358
9359 *out_len = 0;
9360
Gilles Peskine449bd832023-01-11 14:50:10 +01009361 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009362
9363 /* Check if we have space for header and length field:
9364 * - extension_type (2 bytes)
9365 * - extension_data_length (2 bytes)
9366 * - supported_signature_algorithms_length (2 bytes)
9367 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009368 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009369 p += 6;
9370
9371 /*
9372 * Write supported_signature_algorithms
9373 */
9374 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009375 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9376 if (sig_alg == NULL) {
9377 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9378 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009379
Gilles Peskine449bd832023-01-11 14:50:10 +01009380 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9381 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9382 *sig_alg,
9383 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9384 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009385 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009386 }
9387 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9388 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009389 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009390 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9391 *sig_alg,
9392 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009393 }
9394
9395 /* Length of supported_signature_algorithms */
9396 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009397 if (supported_sig_alg_len == 0) {
9398 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9399 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009400 }
9401
Gilles Peskine449bd832023-01-11 14:50:10 +01009402 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9403 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9404 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009405
XiaokangQianeaf36512022-04-24 09:07:44 +00009406 *out_len = p - buf;
9407
9408#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009409 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009410#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009411
Gilles Peskine449bd832023-01-11 14:50:10 +01009412 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009413}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009414#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009415
XiaokangQian40a35232022-05-07 09:02:40 +00009416#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009417/*
9418 * mbedtls_ssl_parse_server_name_ext
9419 *
9420 * Structure of server_name extension:
9421 *
9422 * enum {
9423 * host_name(0), (255)
9424 * } NameType;
9425 * opaque HostName<1..2^16-1>;
9426 *
9427 * struct {
9428 * NameType name_type;
9429 * select (name_type) {
9430 * case host_name: HostName;
9431 * } name;
9432 * } ServerName;
9433 * struct {
9434 * ServerName server_name_list<1..2^16-1>
9435 * } ServerNameList;
9436 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009437MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009438int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9439 const unsigned char *buf,
9440 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009441{
9442 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9443 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009444 size_t server_name_list_len, hostname_len;
9445 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009446
Gilles Peskine449bd832023-01-11 14:50:10 +01009447 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009448
Gilles Peskine449bd832023-01-11 14:50:10 +01009449 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9450 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009451 p += 2;
9452
Gilles Peskine449bd832023-01-11 14:50:10 +01009453 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009454 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009455 while (p < server_name_list_end) {
9456 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9457 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9458 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9459 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009460
Gilles Peskine449bd832023-01-11 14:50:10 +01009461 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009462 /* sni_name is intended to be used only during the parsing of the
9463 * ClientHello message (it is reset to NULL before the end of
9464 * the message parsing). Thus it is ok to just point to the
9465 * reception buffer and not make a copy of it.
9466 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009467 ssl->handshake->sni_name = p + 3;
9468 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009469 if (ssl->conf->f_sni == NULL) {
9470 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009471 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009472 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9473 ssl, p + 3, hostname_len);
9474 if (ret != 0) {
9475 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9476 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9477 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9478 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9479 }
9480 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009481 }
9482
9483 p += hostname_len + 3;
9484 }
9485
Gilles Peskine449bd832023-01-11 14:50:10 +01009486 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009487}
9488#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9489
XiaokangQianacb39922022-06-17 10:18:48 +00009490#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009491MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009492int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9493 const unsigned char *buf,
9494 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009495{
9496 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009497 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009498 const unsigned char *protocol_name_list;
9499 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009500 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009501
9502 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009503 if (ssl->conf->alpn_list == NULL) {
9504 return 0;
9505 }
XiaokangQianacb39922022-06-17 10:18:48 +00009506
9507 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009508 * RFC7301, section 3.1
9509 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009510 *
XiaokangQianc7403452022-06-23 03:24:12 +00009511 * struct {
9512 * ProtocolName protocol_name_list<2..2^16-1>
9513 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009514 */
9515
XiaokangQianc7403452022-06-23 03:24:12 +00009516 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009517 * protocol_name_list_len 2 bytes
9518 * protocol_name_len 1 bytes
9519 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009520 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009521 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009522
Gilles Peskine449bd832023-01-11 14:50:10 +01009523 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009524 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009525 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009526 protocol_name_list = p;
9527 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009528
9529 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009530 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009531 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009532 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9533 protocol_name_len);
9534 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009535 MBEDTLS_SSL_PEND_FATAL_ALERT(
9536 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009537 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9538 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009539 }
9540
9541 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009542 }
9543
9544 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009545 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9546 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009547 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009548 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009549 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009550 if (protocol_name_len == alpn_len &&
9551 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009552 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009553 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009554 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009555
9556 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009557 }
9558 }
9559
XiaokangQian95d5f542022-06-24 02:29:26 +00009560 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009561 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009562 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9563 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9564 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009565}
9566
Gilles Peskine449bd832023-01-11 14:50:10 +01009567int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9568 unsigned char *buf,
9569 unsigned char *end,
9570 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009571{
9572 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009573 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009574 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009575
Gilles Peskine449bd832023-01-11 14:50:10 +01009576 if (ssl->alpn_chosen == NULL) {
9577 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009578 }
9579
Gilles Peskine449bd832023-01-11 14:50:10 +01009580 protocol_name_len = strlen(ssl->alpn_chosen);
9581 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009582
Gilles Peskine449bd832023-01-11 14:50:10 +01009583 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009584 /*
9585 * 0 . 1 ext identifier
9586 * 2 . 3 ext length
9587 * 4 . 5 protocol list length
9588 * 6 . 6 protocol name length
9589 * 7 . 7+n protocol name
9590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009591 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009592
XiaokangQian95d5f542022-06-24 02:29:26 +00009593 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009594
Gilles Peskine449bd832023-01-11 14:50:10 +01009595 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9596 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009597 /* Note: the length of the chosen protocol has been checked to be less
9598 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9599 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009600 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009601
Gilles Peskine449bd832023-01-11 14:50:10 +01009602 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009603
9604#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009605 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009606#endif
9607
Gilles Peskine449bd832023-01-11 14:50:10 +01009608 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009609}
9610#endif /* MBEDTLS_SSL_ALPN */
9611
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009612#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009613 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009614 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009615 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009616int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9617 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009618{
9619 /* Initialize to suppress unnecessary compiler warning */
9620 size_t hostname_len = 0;
9621
9622 /* Check if new hostname is valid before
9623 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009624 if (hostname != NULL) {
9625 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009626
Gilles Peskine449bd832023-01-11 14:50:10 +01009627 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9628 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9629 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009630 }
9631
9632 /* Now it's clear that we will overwrite the old hostname,
9633 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009634 if (session->hostname != NULL) {
9635 mbedtls_platform_zeroize(session->hostname,
9636 strlen(session->hostname));
9637 mbedtls_free(session->hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009638 }
9639
9640 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009641 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009642 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009643 } else {
9644 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9645 if (session->hostname == NULL) {
9646 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9647 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009648
Gilles Peskine449bd832023-01-11 14:50:10 +01009649 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009650 }
9651
Gilles Peskine449bd832023-01-11 14:50:10 +01009652 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009653}
Xiaokang Qian03409292022-10-12 02:49:52 +00009654#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9655 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009656 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009657 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009658
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009659#endif /* MBEDTLS_SSL_TLS_C */