blob: 7f35c7457116334edbba28448c18c36ce50c8aef [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
SimonBd5800b72016-04-26 07:43:27 +010028#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010029
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000030#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010031#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010032#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000033#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040034
Janos Follath73c616b2019-12-18 15:07:04 +000035#include "mbedtls/debug.h"
36#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050037#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010038#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020039#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020040
Rich Evans00ab4702015-02-06 13:43:58 +000041#include <string.h>
42
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050043#if defined(MBEDTLS_USE_PSA_CRYPTO)
44#include "mbedtls/psa_util.h"
45#include "psa/crypto.h"
46#endif
47
Janos Follath23bdca02016-10-07 14:47:14 +010048#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000049#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020050#endif
51
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#define PSA_TO_MBEDTLS_ERR(status) PSA_TO_MBEDTLS_ERR_LIST(status, \
54 psa_to_ssl_errors, \
55 psa_generic_status_to_mbedtls)
Andrzej Kurekdaf5b562023-03-03 05:52:28 -050056#define PSA_TO_MD_ERR(status) PSA_TO_MBEDTLS_ERR_LIST(status, \
57 psa_to_md_errors, \
58 psa_generic_status_to_mbedtls)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050059#endif
60
Ronald Cronad8c17b2022-06-10 17:18:09 +020061#if defined(MBEDTLS_TEST_HOOKS)
62static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
63
64void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010065 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
67 chk_buf_ptr_fail_args.cur = cur;
68 chk_buf_ptr_fail_args.end = end;
69 chk_buf_ptr_fail_args.need = need;
70}
71
Gilles Peskine449bd832023-01-11 14:50:10 +010072void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020073{
Gilles Peskine449bd832023-01-11 14:50:10 +010074 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020075}
76
Gilles Peskine449bd832023-01-11 14:50:10 +010077int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020078{
Gilles Peskine449bd832023-01-11 14:50:10 +010079 return (chk_buf_ptr_fail_args.cur != args->cur) ||
80 (chk_buf_ptr_fail_args.end != args->end) ||
81 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020082}
83#endif /* MBEDTLS_TEST_HOOKS */
84
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020085#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010086
Hanno Beckera0e20d02019-05-15 14:03:01 +010087#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010088/* Top-level Connection ID API */
89
Gilles Peskine449bd832023-01-11 14:50:10 +010090int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
91 size_t len,
92 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010093{
Gilles Peskine449bd832023-01-11 14:50:10 +010094 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
95 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
96 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010097
Gilles Peskine449bd832023-01-11 14:50:10 +010098 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
99 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
100 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +0100101 }
102
103 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100104 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100105 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100106}
107
Gilles Peskine449bd832023-01-11 14:50:10 +0100108int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
109 int enable,
110 unsigned char const *own_cid,
111 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100112{
Gilles Peskine449bd832023-01-11 14:50:10 +0100113 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
114 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
115 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100116
Hanno Beckerca092242019-04-25 16:01:49 +0100117 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 if (enable == MBEDTLS_SSL_CID_DISABLED) {
119 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
120 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100121 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100122 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
123 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 if (own_cid_len != ssl->conf->cid_len) {
126 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
127 (unsigned) own_cid_len,
128 (unsigned) ssl->conf->cid_len));
129 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100130 }
131
Gilles Peskine449bd832023-01-11 14:50:10 +0100132 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100133 /* Truncation is not an issue here because
134 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
135 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100136
Gilles Peskine449bd832023-01-11 14:50:10 +0100137 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100138}
139
Gilles Peskine449bd832023-01-11 14:50:10 +0100140int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
141 int *enabled,
142 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
143 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000144{
145 *enabled = MBEDTLS_SSL_CID_DISABLED;
146
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
148 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
149 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000150
151 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
152 * zero as this is indistinguishable from not requesting to use
153 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100154 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
155 return 0;
156 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000157
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000159 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 if (own_cid != NULL) {
161 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
162 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000163 }
164
165 *enabled = MBEDTLS_SSL_CID_ENABLED;
166
Gilles Peskine449bd832023-01-11 14:50:10 +0100167 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000168}
169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
171 int *enabled,
172 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
173 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100174{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100175 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100176
Gilles Peskine449bd832023-01-11 14:50:10 +0100177 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
178 mbedtls_ssl_is_handshake_over(ssl) == 0) {
179 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100180 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181
Hanno Beckerc5f24222019-05-03 12:54:52 +0100182 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
183 * were used, but client and server requested the empty CID.
184 * This is indistinguishable from not using the CID extension
185 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 if (ssl->transform_in->in_cid_len == 0 &&
187 ssl->transform_in->out_cid_len == 0) {
188 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100189 }
190
Gilles Peskine449bd832023-01-11 14:50:10 +0100191 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100192 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 if (peer_cid != NULL) {
194 memcpy(peer_cid, ssl->transform_in->out_cid,
195 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100196 }
197 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100198
199 *enabled = MBEDTLS_SSL_CID_ENABLED;
200
Gilles Peskine449bd832023-01-11 14:50:10 +0100201 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100202}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100203#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100204
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200205#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200207#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200208/*
209 * Convert max_fragment_length codes to length.
210 * RFC 6066 says:
211 * enum{
212 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
213 * } MaxFragmentLength;
214 * and we add 0 -> extension unused
215 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100216static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200217{
Gilles Peskine449bd832023-01-11 14:50:10 +0100218 switch (mfl) {
219 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
220 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
221 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
222 return 512;
223 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
224 return 1024;
225 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
226 return 2048;
227 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
228 return 4096;
229 default:
230 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000231 }
232}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200233#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200234
Gilles Peskine449bd832023-01-11 14:50:10 +0100235int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
236 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200237{
Gilles Peskine449bd832023-01-11 14:50:10 +0100238 mbedtls_ssl_session_free(dst);
239 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800240#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
241 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000242#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
243 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000244 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800245#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000246#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800247
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200248#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000249
250#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000252 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200253
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
255 if (dst->peer_cert == NULL) {
256 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
257 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200260
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
262 src->peer_cert->raw.len)) != 0) {
263 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200266 }
267 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000268#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000270 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 mbedtls_calloc(1, src->peer_cert_digest_len);
272 if (dst->peer_cert_digest == NULL) {
273 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
274 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000275
Gilles Peskine449bd832023-01-11 14:50:10 +0100276 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
277 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000278 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000279 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000280 }
281#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
282
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200283#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200284
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200285#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100286 if (src->ticket != NULL) {
287 dst->ticket = mbedtls_calloc(1, src->ticket_len);
288 if (dst->ticket == NULL) {
289 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
290 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200291
Gilles Peskine449bd832023-01-11 14:50:10 +0100292 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200293 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000294
295#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
296 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100297 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000298 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
300 if (ret != 0) {
301 return ret;
302 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000303 }
304#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
305 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200306#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200307
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200309}
310
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500311#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200312MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100313static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500314{
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
316 if (resized_buffer == NULL) {
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500317 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500319
320 /* We want to copy len_new bytes when downsizing the buffer, and
321 * len_old bytes when upsizing, so we choose the smaller of two sizes,
322 * to fit one buffer into another. Size checks, ensuring that no data is
323 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 memcpy(resized_buffer, *buffer,
325 (len_new < *len_old) ? len_new : *len_old);
326 mbedtls_platform_zeroize(*buffer, *len_old);
327 mbedtls_free(*buffer);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500328
329 *buffer = resized_buffer;
330 *len_old = len_new;
331
332 return 0;
333}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200334
Gilles Peskine449bd832023-01-11 14:50:10 +0100335static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
336 size_t in_buf_new_len,
337 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200338{
339 int modified = 0;
340 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
341 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200343 written_in = ssl->in_msg - ssl->in_buf;
344 iv_offset_in = ssl->in_iv - ssl->in_buf;
345 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200347 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 ssl->in_buf_len < in_buf_new_len) {
349 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
350 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
351 } else {
352 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
353 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200354 modified = 1;
355 }
356 }
357 }
358
Gilles Peskine449bd832023-01-11 14:50:10 +0100359 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200360 written_out = ssl->out_msg - ssl->out_buf;
361 iv_offset_out = ssl->out_iv - ssl->out_buf;
362 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200364 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 ssl->out_buf_len < out_buf_new_len) {
366 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
367 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
368 } else {
369 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
370 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200371 modified = 1;
372 }
373 }
374 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100375 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200376 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200378 /* Fields below might not be properly updated with record
379 * splitting or with CID, so they are manually updated here. */
380 ssl->out_msg = ssl->out_buf + written_out;
381 ssl->out_len = ssl->out_buf + len_offset_out;
382 ssl->out_iv = ssl->out_buf + iv_offset_out;
383
384 ssl->in_msg = ssl->in_buf + written_in;
385 ssl->in_len = ssl->in_buf + len_offset_in;
386 ssl->in_iv = ssl->in_buf + iv_offset_in;
387 }
388}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500389#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
390
Jerry Yudb8c48a2022-01-27 14:54:54 +0800391#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800392
393#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100394typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
395 const char *label,
396 const unsigned char *random, size_t rlen,
397 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800398
Gilles Peskine449bd832023-01-11 14:50:10 +0100399static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800400
401#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
402
403/* Type for the TLS PRF */
404typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
405 const unsigned char *, size_t,
406 unsigned char *, size_t);
407
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200408MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100409static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
410 int ciphersuite,
411 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200412#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200414#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 ssl_tls_prf_t tls_prf,
416 const unsigned char randbytes[64],
417 mbedtls_ssl_protocol_version tls_version,
418 unsigned endpoint,
419 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800420
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100421#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200422MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100423static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300424 const char *label,
425 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100426 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100427static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
428static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100429
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100430#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100431
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100432#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100433MBEDTLS_CHECK_RETURN_CRITICAL
434static int tls_prf_sha384(const unsigned char *secret, size_t slen,
435 const char *label,
436 const unsigned char *random, size_t rlen,
437 unsigned char *dstbuf, size_t dlen);
438
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100439static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
440static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100441#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100442
443static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
444 unsigned char *buf,
445 size_t buf_len);
446
447MBEDTLS_CHECK_RETURN_CRITICAL
448static int ssl_tls12_session_load(mbedtls_ssl_session *session,
449 const unsigned char *buf,
450 size_t len);
451#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
452
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100453static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100454
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100455#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100456static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100457#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100458
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100459#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100460static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100461#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100462
463int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
464 const unsigned char *secret, size_t slen,
465 const char *label,
466 const unsigned char *random, size_t rlen,
467 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300468{
469 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
470
Gilles Peskine449bd832023-01-11 14:50:10 +0100471 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300472#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100473#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300474 case MBEDTLS_SSL_TLS_PRF_SHA384:
475 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100477#endif /* MBEDTLS_MD_CAN_SHA384*/
478#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300479 case MBEDTLS_SSL_TLS_PRF_SHA256:
480 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100482#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300483#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 default:
485 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300486 }
487
Gilles Peskine449bd832023-01-11 14:50:10 +0100488 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300489}
490
Jerry Yuc73c6182022-02-08 20:29:25 +0800491#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100492static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800493{
494#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100495 if (session->peer_cert != NULL) {
496 mbedtls_x509_crt_free(session->peer_cert);
497 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800498 session->peer_cert = NULL;
499 }
500#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100501 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800502 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800504 session->peer_cert_digest = NULL;
505 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
506 session->peer_cert_digest_len = 0;
507 }
508#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
509}
510#endif /* MBEDTLS_X509_CRT_PARSE_C */
511
Gilles Peskine449bd832023-01-11 14:50:10 +0100512uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800513{
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800515 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800517
518 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
584 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800592
Jan Bruckner151f6422023-02-10 12:45:19 +0100593 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
594 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
595
Jerry Yu7a485c12022-10-31 13:08:18 +0800596 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100597 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800598
599 }
600
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800602}
603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800605{
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800607}
608
Jerry Yud25cab02022-10-31 12:48:30 +0800609#if defined(MBEDTLS_DEBUG_C)
610static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800611 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800612 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
613 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
614 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
615 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
616 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
617 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
618 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
619 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
620 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
621 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
622 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
623 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
624 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
625 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
626 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
627 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
628 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
629 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
630 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
631 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
632 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
633 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
634 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
635 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
636 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
637 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100638 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
639 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800640};
641
Gilles Peskine449bd832023-01-11 14:50:10 +0100642static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800643 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
644 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
645 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
646 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
647 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
648 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
649 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
650 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
651 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
652 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
653 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
654 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
655 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
656 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
657 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
658 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
659 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
660 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
661 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
662 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
663 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
664 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
665 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
666 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
667 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
668 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
669 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100670 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
671 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800672};
673
Gilles Peskine449bd832023-01-11 14:50:10 +0100674const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800675{
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 return extension_name_table[
677 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800678}
679
Gilles Peskine449bd832023-01-11 14:50:10 +0100680static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800681{
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800683 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800685 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800687 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800689 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800691 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800693 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800695 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800697 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800699}
700
Gilles Peskine449bd832023-01-11 14:50:10 +0100701void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
702 int level, const char *file, int line,
703 int hs_msg_type, unsigned int extension_type,
704 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800705{
706 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800708 mbedtls_debug_print_msg(
709 ssl, level, file, line,
710 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 ssl_tls13_get_hs_msg_name(hs_msg_type),
712 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800713 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800715 return;
716 }
717
718 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100719 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800720 mbedtls_debug_print_msg(
721 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
723 mbedtls_ssl_get_extension_name(extension_type), extension_type,
724 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800725 return;
726 }
727
728 mbedtls_debug_print_msg(
729 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100730 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
731 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800732}
733
Gilles Peskine449bd832023-01-11 14:50:10 +0100734void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
735 int level, const char *file, int line,
736 int hs_msg_type, uint32_t extensions_mask,
737 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800738{
739
Gilles Peskine449bd832023-01-11 14:50:10 +0100740 for (unsigned i = 0;
741 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
742 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800743 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800744 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800746 }
747}
748
Pengyu Lvee455c02023-01-12 14:37:24 +0800749#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
750#define ARRAY_LENGTH(a) (sizeof(a) / sizeof(*(a)))
751
752static const char *ticket_flag_name_table[] =
753{
754 [0] = "ALLOW_PSK_RESUMPTION",
755 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
756 [3] = "ALLOW_EARLY_DATA",
757};
758
Pengyu Lv4938a562023-01-16 11:28:49 +0800759void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
760 int level, const char *file, int line,
761 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800762{
763 size_t i;
764
765 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800766 "print ticket_flags (0x%02x)", flags);
767
768 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800769
770 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800771 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800772 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
773 ticket_flag_name_table[i]);
774 }
775 }
776}
777#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
778
Jerry Yud25cab02022-10-31 12:48:30 +0800779#endif /* MBEDTLS_DEBUG_C */
780
Gilles Peskine449bd832023-01-11 14:50:10 +0100781void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
782 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800783{
784 ((void) ciphersuite_info);
785
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100786#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800788 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800790#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100791#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800793 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800795#endif
796 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100797 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800798 return;
799 }
800}
801
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100802int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100803 unsigned hs_type,
804 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100805{
806 unsigned char hs_hdr[4];
807
808 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
810 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
811 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
812 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100813
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100814 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100815}
816
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100817int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100818 unsigned hs_type,
819 unsigned char const *msg,
820 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100821{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100822 int ret;
823 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100824 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100825 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100826 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100827 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100828}
829
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100830int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800831{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100832#if defined(MBEDTLS_MD_CAN_SHA256) || \
833 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100834#if defined(MBEDTLS_USE_PSA_CRYPTO)
835 psa_status_t status;
836#else
837 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
838#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100839#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800840 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100841#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100842#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800843#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100844 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
845 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500846 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100847 }
848 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
849 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500850 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100851 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800852#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100853 mbedtls_md_free(&ssl->handshake->fin_sha256);
854 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100855 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
856 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
857 0);
858 if (ret != 0) {
859 return ret;
860 }
861 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100862 if (ret != 0) {
863 return ret;
864 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800865#endif
866#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100867#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800868#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100869 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
870 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500871 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100872 }
873 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
874 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500875 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100876 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800877#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100878 mbedtls_md_free(&ssl->handshake->fin_sha384);
879 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100880 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
881 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
882 if (ret != 0) {
883 return ret;
884 }
885 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100886 if (ret != 0) {
887 return ret;
888 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800889#endif
890#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100891 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800892}
893
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100894static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100895 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800896{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100897#if defined(MBEDTLS_MD_CAN_SHA256) || \
898 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100899#if defined(MBEDTLS_USE_PSA_CRYPTO)
900 psa_status_t status;
901#else
902 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
903#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100904#else /* SHA-256 or SHA-384 */
905 ((void) ssl);
906 (void) buf;
907 (void) len;
908#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100909#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800910#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100911 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
912 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500913 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100914 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800915#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100916 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100917 if (ret != 0) {
918 return ret;
919 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800920#endif
921#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100922#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800923#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100924 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
925 if (status != PSA_SUCCESS) {
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500926 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100927 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800928#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100929 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100930 if (ret != 0) {
931 return ret;
932 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800933#endif
934#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100935 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800936}
937
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100938#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100939static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100940 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800941{
942#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500943 return PSA_TO_MD_ERR(psa_hash_update(
944 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800945#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100946 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800947#endif
948}
949#endif
950
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100951#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100952static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100953 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800954{
955#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurekdaf5b562023-03-03 05:52:28 -0500956 return PSA_TO_MD_ERR(psa_hash_update(
957 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800958#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100959 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800960#endif
961}
962#endif
963
Gilles Peskine449bd832023-01-11 14:50:10 +0100964static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200965{
Gilles Peskine449bd832023-01-11 14:50:10 +0100966 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200967
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100968#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500969#if defined(MBEDTLS_USE_PSA_CRYPTO)
970 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500971#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100972 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200973#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500974#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100975#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500976#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500977 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500978#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100979 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200980#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500981#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200982
983 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200987#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200988#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100989 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200990#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200991#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200992#if defined(MBEDTLS_USE_PSA_CRYPTO)
993 handshake->psa_pake_ctx = psa_pake_operation_init();
994 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
995#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100996 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200997#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200998#if defined(MBEDTLS_SSL_CLI_C)
999 handshake->ecjpake_cache = NULL;
1000 handshake->ecjpake_cache_len = 0;
1001#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001002#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001003
Gilles Peskineeccd8882020-03-10 12:19:08 +01001004#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001005 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001006#endif
1007
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001008#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1009 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1010#endif
Hanno Becker75173122019-02-06 16:18:31 +00001011
1012#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1013 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001015#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001016}
1017
Gilles Peskine449bd832023-01-11 14:50:10 +01001018void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001019{
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001021
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001022#if defined(MBEDTLS_USE_PSA_CRYPTO)
1023 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1024 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001025#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001026 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1027 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001028#endif
1029
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001030#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001031#if defined(MBEDTLS_USE_PSA_CRYPTO)
1032 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1033 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001034#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 mbedtls_md_init(&transform->md_ctx_enc);
1036 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001037#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001038#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001039}
1040
Gilles Peskine449bd832023-01-11 14:50:10 +01001041void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001042{
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001044}
1045
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001046MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001047static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001048{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001049 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1050
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001051 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001052#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 if (ssl->transform_negotiate) {
1054 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1055 }
Jerry Yu2e199812022-12-01 18:57:19 +08001056#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 if (ssl->session_negotiate) {
1058 mbedtls_ssl_session_free(ssl->session_negotiate);
1059 }
1060 if (ssl->handshake) {
1061 mbedtls_ssl_handshake_free(ssl);
1062 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001063
Jerry Yu2e199812022-12-01 18:57:19 +08001064#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001065 /*
1066 * Either the pointers are now NULL or cleared properly and can be freed.
1067 * Now allocate missing structures.
1068 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 if (ssl->transform_negotiate == NULL) {
1070 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001071 }
Jerry Yu2e199812022-12-01 18:57:19 +08001072#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001073
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 if (ssl->session_negotiate == NULL) {
1075 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001076 }
Paul Bakker48916f92012-09-16 19:57:18 +00001077
Gilles Peskine449bd832023-01-11 14:50:10 +01001078 if (ssl->handshake == NULL) {
1079 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001080 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001081#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1082 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001083
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1085 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001086#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001087
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001088 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001090#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001091 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001092#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 ssl->session_negotiate == NULL) {
1094 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001095
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001097 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001098
1099#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001101 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001102#endif
1103
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001105 ssl->session_negotiate = NULL;
1106
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001108 }
1109
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001110 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 mbedtls_ssl_session_init(ssl->session_negotiate);
1112 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001113
Jerry Yu2e199812022-12-01 18:57:19 +08001114#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001116#endif
1117
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001118 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001119 ret = mbedtls_ssl_reset_checksum(ssl);
1120 if (ret != 0) {
1121 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1122 return ret;
1123 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001124
Jerry Yud0766ec2022-09-22 10:46:57 +08001125#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1126 defined(MBEDTLS_SSL_SRV_C) && \
1127 defined(MBEDTLS_SSL_SESSION_TICKETS)
1128 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001130#endif
1131
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001132#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001134 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001135
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001137 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001139 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001141
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001143 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001144#endif
1145
Brett Warrene0edc842021-08-17 09:53:13 +01001146/*
1147 * curve_list is translated to IANA TLS group identifiers here because
1148 * mbedtls_ssl_conf_curves returns void and so can't return
1149 * any error codes.
1150 */
Valerio Setti6c496a12023-04-07 15:53:51 +02001151#if defined(MBEDTLS_ECP_LIGHT)
Brett Warrene0edc842021-08-17 09:53:13 +01001152#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1153 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001155 size_t length;
1156 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1157
Thomas Daubney850a0792023-05-22 12:05:03 +01001158 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 }
Brett Warrene0edc842021-08-17 09:53:13 +01001160
1161 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1163 if (group_list == NULL) {
1164 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1165 }
Brett Warrene0edc842021-08-17 09:53:13 +01001166
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001168 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 curve_list[i]);
1170 if (tls_id == 0) {
1171 mbedtls_free(group_list);
1172 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001173 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001174 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001175 }
1176
1177 group_list[length] = 0;
1178
1179 ssl->handshake->group_list = group_list;
1180 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001182 ssl->handshake->group_list = ssl->conf->group_list;
1183 ssl->handshake->group_list_heap_allocated = 0;
1184 }
1185#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6c496a12023-04-07 15:53:51 +02001186#endif /* MBEDTLS_ECP_LIGHT */
Brett Warrene0edc842021-08-17 09:53:13 +01001187
Ronald Crone68ab4f2022-10-05 12:46:29 +02001188#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001189#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001190#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001191 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1192 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001193 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1194 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001195 const int *md;
1196 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001197 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001198 uint16_t *p;
1199
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001200 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1201 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1202 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001203
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1205 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001206 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 }
Valerio Setti75fba322023-02-23 17:35:09 +01001208#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001210#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001211
Jerry Yub476a442022-01-21 18:14:45 +08001212#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001214#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1216 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1217 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001218 }
1219
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1221 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1222 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001223
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1225 sizeof(uint16_t));
1226 if (ssl->handshake->sig_algs == NULL) {
1227 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1228 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001229
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 p = (uint16_t *) ssl->handshake->sig_algs;
1231 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1232 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1233 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001234 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 }
Valerio Setti75fba322023-02-23 17:35:09 +01001236#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001238 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001239#endif
1240#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001241 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001242 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001243#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001244 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001245 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001248#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001249 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001250 ssl->handshake->sig_algs_heap_allocated = 0;
1251 }
Jerry Yucc539102022-06-27 16:27:35 +08001252#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001253#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001255}
1256
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001257#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001258/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001259MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001260static int ssl_cookie_write_dummy(void *ctx,
1261 unsigned char **p, unsigned char *end,
1262 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001263{
1264 ((void) ctx);
1265 ((void) p);
1266 ((void) end);
1267 ((void) cli_id);
1268 ((void) cli_id_len);
1269
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001271}
1272
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001273MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001274static int ssl_cookie_check_dummy(void *ctx,
1275 const unsigned char *cookie, size_t cookie_len,
1276 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001277{
1278 ((void) ctx);
1279 ((void) cookie);
1280 ((void) cookie_len);
1281 ((void) cli_id);
1282 ((void) cli_id_len);
1283
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001285}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001286#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001287
Paul Bakker5121ce52009-01-03 21:22:43 +00001288/*
1289 * Initialize an SSL context
1290 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001291void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001292{
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001294}
1295
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001296MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001297static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001298{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001299 const mbedtls_ssl_config *conf = ssl->conf;
1300
Ronald Cron6f135e12021-12-08 16:57:54 +01001301#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001302 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1303 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1304 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1305 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001306 }
1307
Gilles Peskine449bd832023-01-11 14:50:10 +01001308 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1309 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001310 }
1311#endif
1312
1313#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1315 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1316 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001317 }
1318#endif
1319
Ronald Cron6f135e12021-12-08 16:57:54 +01001320#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1322 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1323 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1324 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001325 }
1326
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1328 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001329 }
1330#endif
1331
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1333 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001334}
1335
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001336MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001337static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1338{
1339 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001340 ret = ssl_conf_version_check(ssl);
1341 if (ret != 0) {
1342 return ret;
1343 }
Jerry Yu60835a82021-08-04 10:13:52 +08001344
Jerry Yudef7ae42022-10-30 14:13:19 +08001345#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1346 /* RFC 8446 section 4.4.3
1347 *
1348 * If the verification fails, the receiver MUST terminate the handshake with
1349 * a "decrypt_error" alert.
1350 *
1351 * If the client is configured as TLS 1.3 only with optional verify, return
1352 * bad config.
1353 *
1354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1356 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001357 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1358 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1359 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001361 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 1, ("Optional verify auth mode "
1363 "is not available for TLS 1.3 client"));
1364 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001365 }
1366#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1367
Jerry Yu60835a82021-08-04 10:13:52 +08001368 /* Space for further checks */
1369
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001371}
1372
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001373/*
1374 * Setup an SSL context
1375 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001376
Gilles Peskine449bd832023-01-11 14:50:10 +01001377int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1378 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001379{
Janos Follath865b3eb2019-12-16 11:46:15 +00001380 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001381 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1382 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001383
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001384 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001385
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 if ((ret = ssl_conf_check(ssl)) != 0) {
1387 return ret;
1388 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001389 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001390
Paul Bakker62f2dee2012-09-28 07:31:51 +00001391 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001392 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001393 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001394
1395 /* Set to NULL in case of an error condition */
1396 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001397
Darryl Greenb33cc762019-11-28 14:29:44 +00001398#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1399 ssl->in_buf_len = in_buf_len;
1400#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1402 if (ssl->in_buf == NULL) {
1403 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001404 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001405 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001406 }
1407
Darryl Greenb33cc762019-11-28 14:29:44 +00001408#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1409 ssl->out_buf_len = out_buf_len;
1410#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1412 if (ssl->out_buf == NULL) {
1413 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_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;
Paul Bakker5121ce52009-01-03 21:22:43 +00001416 }
1417
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001419
Johan Pascalb62bb512015-12-03 21:56:45 +01001420#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001422#endif
1423
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001425 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001427
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001429
1430error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 mbedtls_free(ssl->in_buf);
1432 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001433
1434 ssl->conf = NULL;
1435
Darryl Greenb33cc762019-11-28 14:29:44 +00001436#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1437 ssl->in_buf_len = 0;
1438 ssl->out_buf_len = 0;
1439#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001440 ssl->in_buf = NULL;
1441 ssl->out_buf = NULL;
1442
1443 ssl->in_hdr = NULL;
1444 ssl->in_ctr = NULL;
1445 ssl->in_len = NULL;
1446 ssl->in_iv = NULL;
1447 ssl->in_msg = NULL;
1448
1449 ssl->out_hdr = NULL;
1450 ssl->out_ctr = NULL;
1451 ssl->out_len = NULL;
1452 ssl->out_iv = NULL;
1453 ssl->out_msg = NULL;
1454
Gilles Peskine449bd832023-01-11 14:50:10 +01001455 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001456}
1457
1458/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001459 * Reset an initialized and used SSL context for re-use while retaining
1460 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001461 *
1462 * If partial is non-zero, keep data in the input buffer and client ID.
1463 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001465void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1466 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001467{
Darryl Greenb33cc762019-11-28 14:29:44 +00001468#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1469 size_t in_buf_len = ssl->in_buf_len;
1470 size_t out_buf_len = ssl->out_buf_len;
1471#else
1472 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1473 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1474#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001475
Hanno Beckerb0302c42021-08-03 09:39:42 +01001476#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1477 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001478#endif
1479
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001480 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001481 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001482
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001484
1485 /* Reset incoming message parsing */
1486 ssl->in_offt = NULL;
1487 ssl->nb_zero = 0;
1488 ssl->in_msgtype = 0;
1489 ssl->in_msglen = 0;
1490 ssl->in_hslen = 0;
1491 ssl->keep_current_message = 0;
1492 ssl->transform_in = NULL;
1493
1494#if defined(MBEDTLS_SSL_PROTO_DTLS)
1495 ssl->next_record_offset = 0;
1496 ssl->in_epoch = 0;
1497#endif
1498
1499 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001501 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 }
1504
Ronald Cronad8c17b2022-06-10 17:18:09 +02001505 ssl->send_alert = 0;
1506
Hanno Beckerb0302c42021-08-03 09:39:42 +01001507 /* Reset outgoing message writing */
1508 ssl->out_msgtype = 0;
1509 ssl->out_msglen = 0;
1510 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 memset(ssl->out_buf, 0, out_buf_len);
1512 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001513 ssl->transform_out = NULL;
1514
1515#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001517#endif
1518
XiaokangQian2b01dc32022-01-21 02:53:13 +00001519#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 if (ssl->transform) {
1521 mbedtls_ssl_transform_free(ssl->transform);
1522 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001523 ssl->transform = NULL;
1524 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001525#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1526
XiaokangQian2b01dc32022-01-21 02:53:13 +00001527#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 mbedtls_ssl_transform_free(ssl->transform_application);
1529 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001530 ssl->transform_application = NULL;
1531
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001533#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1535 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001536 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001537#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001538
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1540 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001541 ssl->handshake->transform_handshake = NULL;
1542 }
1543
XiaokangQian2b01dc32022-01-21 02:53:13 +00001544#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001545}
1546
Gilles Peskine449bd832023-01-11 14:50:10 +01001547int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001548{
1549 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1550
1551 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1552
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001554
1555 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556#if defined(MBEDTLS_SSL_RENEGOTIATION)
1557 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001558 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001559
1560 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001561 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1562 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001563#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001565
Hanno Beckerb0302c42021-08-03 09:39:42 +01001566 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001567 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 if (ssl->session) {
1569 mbedtls_ssl_session_free(ssl->session);
1570 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001571 ssl->session = NULL;
1572 }
1573
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001574#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001575 ssl->alpn_chosen = NULL;
1576#endif
1577
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001578#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001579 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001580#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001581 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001582#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 if (free_cli_id) {
1584 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001585 ssl->cli_id = NULL;
1586 ssl->cli_id_len = 0;
1587 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001588#endif
1589
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 if ((ret = ssl_handshake_init(ssl)) != 0) {
1591 return ret;
1592 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001593
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001595}
1596
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001597/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001598 * Reset an initialized and used SSL context for re-use while retaining
1599 * all application-set variables, function pointers and data.
1600 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001601int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001602{
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001604}
1605
1606/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001607 * SSL set accessors
1608 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001609void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001610{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001611 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001612}
1613
Gilles Peskine449bd832023-01-11 14:50:10 +01001614void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001615{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001616 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001617}
1618
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001619#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001620void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001621{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001622 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001623}
1624#endif
1625
Gilles Peskine449bd832023-01-11 14:50:10 +01001626void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001627{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001628 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001629}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001630
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001632
Gilles Peskine449bd832023-01-11 14:50:10 +01001633void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1634 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001635{
1636 ssl->disable_datagram_packing = !allow_packing;
1637}
1638
Gilles Peskine449bd832023-01-11 14:50:10 +01001639void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1640 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001641{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001642 conf->hs_timeout_min = min;
1643 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001644}
1645#endif
1646
Gilles Peskine449bd832023-01-11 14:50:10 +01001647void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001648{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001649 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001650}
1651
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001652#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001653void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1654 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1655 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001656{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001657 conf->f_vrfy = f_vrfy;
1658 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001659}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001660#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001661
Gilles Peskine449bd832023-01-11 14:50:10 +01001662void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1663 int (*f_rng)(void *, unsigned char *, size_t),
1664 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001665{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001666 conf->f_rng = f_rng;
1667 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001668}
1669
Gilles Peskine449bd832023-01-11 14:50:10 +01001670void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1671 void (*f_dbg)(void *, int, const char *, int, const char *),
1672 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001673{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001674 conf->f_dbg = f_dbg;
1675 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001676}
1677
Gilles Peskine449bd832023-01-11 14:50:10 +01001678void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1679 void *p_bio,
1680 mbedtls_ssl_send_t *f_send,
1681 mbedtls_ssl_recv_t *f_recv,
1682 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001683{
1684 ssl->p_bio = p_bio;
1685 ssl->f_send = f_send;
1686 ssl->f_recv = f_recv;
1687 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001688}
1689
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001690#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001691void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001692{
1693 ssl->mtu = mtu;
1694}
1695#endif
1696
Gilles Peskine449bd832023-01-11 14:50:10 +01001697void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001698{
1699 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001700}
1701
Gilles Peskine449bd832023-01-11 14:50:10 +01001702void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1703 void *p_timer,
1704 mbedtls_ssl_set_timer_t *f_set_timer,
1705 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001706{
1707 ssl->p_timer = p_timer;
1708 ssl->f_set_timer = f_set_timer;
1709 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001710
1711 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001713}
1714
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001716void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1717 void *p_cache,
1718 mbedtls_ssl_cache_get_t *f_get_cache,
1719 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001720{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001721 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001722 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001723 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001724}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001726
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001728int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001729{
Janos Follath865b3eb2019-12-16 11:46:15 +00001730 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001731
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001733 session == NULL ||
1734 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1736 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001737 }
1738
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 if (ssl->handshake->resume == 1) {
1740 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1741 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001742
Jerry Yu21092062022-10-10 21:21:31 +08001743#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001745 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001747
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001749 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1751 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1752 session->ciphersuite));
1753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001754 }
Jerry Yu40afab62022-10-08 10:42:13 +08001755 }
Jerry Yu21092062022-10-10 21:21:31 +08001756#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001757
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1759 session)) != 0) {
1760 return ret;
1761 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001762
Paul Bakker0a597072012-09-25 21:55:46 +00001763 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001764
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001766}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001768
Gilles Peskine449bd832023-01-11 14:50:10 +01001769void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1770 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001771{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001772 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001773}
1774
Ronald Cron6f135e12021-12-08 16:57:54 +01001775#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001776void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1777 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001778{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001779 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001780}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001781
1782#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001783void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
1784 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001785{
1786 conf->early_data_enabled = early_data_enabled;
1787}
Jerry Yucc4e0072022-11-22 17:22:22 +08001788
1789#if defined(MBEDTLS_SSL_SRV_C)
1790void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001792{
Jerry Yu39da9852022-12-06 16:58:36 +08001793 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001794}
1795#endif /* MBEDTLS_SSL_SRV_C */
1796
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001797#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001798#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001799
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001800#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001801void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1802 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001803{
1804 conf->cert_profile = profile;
1805}
1806
Gilles Peskine449bd832023-01-11 14:50:10 +01001807static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001808{
1809 mbedtls_ssl_key_cert *cur = key_cert, *next;
1810
Gilles Peskine449bd832023-01-11 14:50:10 +01001811 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001812 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001814 cur = next;
1815 }
1816}
1817
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001818/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001819MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001820static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1821 mbedtls_x509_crt *cert,
1822 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001823{
niisato8ee24222018-06-25 19:05:48 +09001824 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001825
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001827 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001829 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001831 }
1832
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1834 if (new_cert == NULL) {
1835 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1836 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001837
niisato8ee24222018-06-25 19:05:48 +09001838 new_cert->cert = cert;
1839 new_cert->key = key;
1840 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001841
Glenn Strauss36872db2022-01-22 05:06:31 -05001842 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001844 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001846 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001848 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 }
niisato8ee24222018-06-25 19:05:48 +09001850 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001851 }
1852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001854}
1855
Gilles Peskine449bd832023-01-11 14:50:10 +01001856int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001857 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001858 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001859{
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001861}
1862
Gilles Peskine449bd832023-01-11 14:50:10 +01001863void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001864 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001866{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001867 conf->ca_chain = ca_chain;
1868 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001869
1870#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1871 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1872 * cannot be used together. */
1873 conf->f_ca_cb = NULL;
1874 conf->p_ca_cb = NULL;
1875#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001876}
Hanno Becker5adaad92019-03-27 16:54:37 +00001877
1878#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001879void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1880 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1881 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001882{
1883 conf->f_ca_cb = f_ca_cb;
1884 conf->p_ca_cb = p_ca_cb;
1885
1886 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1887 * cannot be used together. */
1888 conf->ca_chain = NULL;
1889 conf->ca_crl = NULL;
1890}
1891#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001893
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001894#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001895const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1896 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001897{
1898 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001900}
1901
Gilles Peskine449bd832023-01-11 14:50:10 +01001902int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1903 mbedtls_x509_crt *own_cert,
1904 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001905{
Gilles Peskine449bd832023-01-11 14:50:10 +01001906 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1907 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001908}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001909
Gilles Peskine449bd832023-01-11 14:50:10 +01001910void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1911 mbedtls_x509_crt *ca_chain,
1912 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001913{
1914 ssl->handshake->sni_ca_chain = ca_chain;
1915 ssl->handshake->sni_ca_crl = ca_crl;
1916}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001917
Glenn Strauss999ef702022-03-11 01:37:23 -05001918#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001919void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1920 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001921{
1922 ssl->handshake->dn_hints = crt;
1923}
1924#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1925
Gilles Peskine449bd832023-01-11 14:50:10 +01001926void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1927 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001928{
1929 ssl->handshake->sni_authmode = authmode;
1930}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001931#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1932
Hanno Becker8927c832019-04-03 12:52:50 +01001933#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001934void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1935 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1936 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001937{
1938 ssl->f_vrfy = f_vrfy;
1939 ssl->p_vrfy = p_vrfy;
1940}
1941#endif
1942
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001943#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001944
Valerio Setti016f6822022-12-09 14:17:50 +01001945#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001946static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1947static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1948
Valerio Setti016f6822022-12-09 14:17:50 +01001949static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 mbedtls_ssl_context *ssl,
1951 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001952{
1953 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001954 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001955 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001956 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001957 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001958 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1960 psa_pake_cs_set_primitive(&cipher_suite,
1961 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1962 PSA_ECC_FAMILY_SECP_R1,
1963 256));
1964 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001965
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1967 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001968 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001970
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001972 user = jpake_server_id;
1973 user_len = sizeof(jpake_server_id);
1974 peer = jpake_client_id;
1975 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001977 user = jpake_client_id;
1978 user_len = sizeof(jpake_client_id);
1979 peer = jpake_server_id;
1980 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001982
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001983 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1984 if (status != PSA_SUCCESS) {
1985 return status;
1986 }
1987
1988 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001990 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 }
Valerio Setti016f6822022-12-09 14:17:50 +01001992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1994 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001995 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 }
Valerio Setti016f6822022-12-09 14:17:50 +01001997
1998 ssl->handshake->psa_pake_ctx_is_ok = 1;
1999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002001}
2002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2004 const unsigned char *pw,
2005 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002006{
2007 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2008 psa_status_t status;
2009
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 if (ssl->handshake == NULL || ssl->conf == NULL) {
2011 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002012 }
2013
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 /* Empty password is not valid */
2015 if ((pw == NULL) || (pw_len == 0)) {
2016 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2017 }
2018
2019 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2020 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2021 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2022
2023 status = psa_import_key(&attributes, pw, pw_len,
2024 &ssl->handshake->psa_pake_password);
2025 if (status != PSA_SUCCESS) {
2026 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2027 }
2028
2029 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2030 ssl->handshake->psa_pake_password);
2031 if (status != PSA_SUCCESS) {
2032 psa_destroy_key(ssl->handshake->psa_pake_password);
2033 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2034 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2035 }
2036
2037 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002038}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2041 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002042{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002043 psa_status_t status;
2044
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 if (ssl->handshake == NULL || ssl->conf == NULL) {
2046 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002047 }
2048
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 if (mbedtls_svc_key_id_is_null(pwd)) {
2050 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2051 }
2052
2053 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2054 if (status != PSA_SUCCESS) {
2055 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2056 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2057 }
2058
2059 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002060}
2061#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002062int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2063 const unsigned char *pw,
2064 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002065{
2066 mbedtls_ecjpake_role role;
2067
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 if (ssl->handshake == NULL || ssl->conf == NULL) {
2069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2070 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002071
Valerio Settic689ed82022-12-07 14:40:38 +01002072 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 if ((pw == NULL) || (pw_len == 0)) {
2074 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2075 }
Valerio Settic689ed82022-12-07 14:40:38 +01002076
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002078 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002080 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002082
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2084 role,
2085 MBEDTLS_MD_SHA256,
2086 MBEDTLS_ECP_DP_SECP256R1,
2087 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002088}
Valerio Setti02c25b52022-11-15 14:08:42 +01002089#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002090#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002091
Ronald Cron73fe8df2022-10-05 14:31:43 +02002092#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002093int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002094{
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 if (conf->psk_identity == NULL ||
2096 conf->psk_identity_len == 0) {
2097 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002098 }
2099
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002100#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2102 return 1;
2103 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002104#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002105
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 if (conf->psk != NULL && conf->psk_len != 0) {
2107 return 1;
2108 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002111}
2112
Gilles Peskine449bd832023-01-11 14:50:10 +01002113static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002114{
2115 /* Remove reference to existing PSK, if any. */
2116#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002118 /* The maintenance of the PSK key slot is the
2119 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002120 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002121 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 if (conf->psk != NULL) {
2124 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002125
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 mbedtls_free(conf->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002127 conf->psk = NULL;
2128 conf->psk_len = 0;
2129 }
2130
2131 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 if (conf->psk_identity != NULL) {
2133 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002134 conf->psk_identity = NULL;
2135 conf->psk_identity_len = 0;
2136 }
2137}
2138
Hanno Becker7390c712018-11-15 13:33:04 +00002139/* This function assumes that PSK identity in the SSL config is unset.
2140 * It checks that the provided identity is well-formed and attempts
2141 * to make a copy of it in the SSL config.
2142 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002143MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002144static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2145 unsigned char const *psk_identity,
2146 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002147{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002148 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002150 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 (psk_identity_len >> 16) != 0 ||
2152 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2153 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002154 }
2155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2157 if (conf->psk_identity == NULL) {
2158 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2159 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002160
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002161 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002163
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002165}
2166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2168 const unsigned char *psk, size_t psk_len,
2169 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002170{
Janos Follath865b3eb2019-12-16 11:46:15 +00002171 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002172
2173 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2175 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2176 }
Hanno Becker7390c712018-11-15 13:33:04 +00002177
2178 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 if (psk == NULL) {
2180 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2181 }
2182 if (psk_len == 0) {
2183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2184 }
2185 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2186 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2187 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2190 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2191 }
Hanno Becker7390c712018-11-15 13:33:04 +00002192 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002194
2195 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2197 if (ret != 0) {
2198 ssl_conf_remove_psk(conf);
2199 }
Hanno Becker7390c712018-11-15 13:33:04 +00002200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002202}
2203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002205{
2206#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002208 /* The maintenance of the external PSK key slot is the
2209 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 if (ssl->handshake->psk_opaque_is_internal) {
2211 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002212 ssl->handshake->psk_opaque_is_internal = 0;
2213 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002214 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002215 }
Neil Armstronge952a302022-05-03 10:22:14 +02002216#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 if (ssl->handshake->psk != NULL) {
2218 mbedtls_platform_zeroize(ssl->handshake->psk,
2219 ssl->handshake->psk_len);
2220 mbedtls_free(ssl->handshake->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002221 ssl->handshake->psk_len = 0;
2222 }
Neil Armstronge952a302022-05-03 10:22:14 +02002223#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002224}
2225
Gilles Peskine449bd832023-01-11 14:50:10 +01002226int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2227 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002228{
Neil Armstrong501c9322022-05-03 09:35:09 +02002229#if defined(MBEDTLS_USE_PSA_CRYPTO)
2230 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002231 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002232 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002233 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002234#endif /* MBEDTLS_USE_PSA_CRYPTO */
2235
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 if (psk == NULL || ssl->handshake == NULL) {
2237 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2238 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2241 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2242 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002243
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002245
Neil Armstrong501c9322022-05-03 09:35:09 +02002246#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002247#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2249 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2250 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2251 } else {
2252 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2253 }
2254 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002255 }
2256#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002257
Jerry Yu568ec252022-07-22 21:27:34 +08002258#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2260 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2261 psa_set_key_usage_flags(&key_attributes,
2262 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002263 }
2264#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2265
Gilles Peskine449bd832023-01-11 14:50:10 +01002266 psa_set_key_algorithm(&key_attributes, alg);
2267 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2270 if (status != PSA_SUCCESS) {
2271 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2272 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002273
2274 /* Allow calling psa_destroy_key() on psk remove */
2275 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002277#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2279 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2280 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002281
2282 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002284
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002286#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002287}
2288
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002289#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002290int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2291 mbedtls_svc_key_id_t psk,
2292 const unsigned char *psk_identity,
2293 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002294{
Janos Follath865b3eb2019-12-16 11:46:15 +00002295 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002296
2297 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2299 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2300 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002301
Hanno Becker7390c712018-11-15 13:33:04 +00002302 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 if (mbedtls_svc_key_id_is_null(psk)) {
2304 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2305 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002306 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002307
2308 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2310 psk_identity_len);
2311 if (ret != 0) {
2312 ssl_conf_remove_psk(conf);
2313 }
Hanno Becker7390c712018-11-15 13:33:04 +00002314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002316}
2317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2319 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002320{
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 if ((mbedtls_svc_key_id_is_null(psk)) ||
2322 (ssl->handshake == NULL)) {
2323 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2324 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002325
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002327 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002329}
2330#endif /* MBEDTLS_USE_PSA_CRYPTO */
2331
Jerry Yu8897c072022-08-12 13:56:53 +08002332#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002333void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2334 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2335 size_t),
2336 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002337{
2338 conf->f_psk = f_psk;
2339 conf->p_psk = p_psk;
2340}
Jerry Yu8897c072022-08-12 13:56:53 +08002341#endif /* MBEDTLS_SSL_SRV_C */
2342
Ronald Cron73fe8df2022-10-05 14:31:43 +02002343#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002344
2345#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002346static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002348{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002349#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 if (alg == PSA_ALG_CBC_NO_PADDING) {
2351 return MBEDTLS_SSL_MODE_CBC;
2352 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002353#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 if (PSA_ALG_IS_AEAD(alg)) {
2355 return MBEDTLS_SSL_MODE_AEAD;
2356 }
2357 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002358}
2359
2360#else /* MBEDTLS_USE_PSA_CRYPTO */
2361
2362static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002364{
2365#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 if (mode == MBEDTLS_MODE_CBC) {
2367 return MBEDTLS_SSL_MODE_CBC;
2368 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002369#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2370
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002371#if defined(MBEDTLS_GCM_C) || \
2372 defined(MBEDTLS_CCM_C) || \
2373 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002375 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 mode == MBEDTLS_MODE_CHACHAPOLY) {
2377 return MBEDTLS_SSL_MODE_AEAD;
2378 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002379#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002380
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002382}
Gilles Peskine301711e2022-04-26 16:57:05 +02002383#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002384
Gilles Peskinee108d982022-04-26 16:50:40 +02002385static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2386 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002388{
2389#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2391 base_mode == MBEDTLS_SSL_MODE_CBC) {
2392 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002393 }
2394#else
2395 (void) encrypt_then_mac;
2396#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002398}
2399
Neil Armstrongab555e02022-04-04 11:07:59 +02002400mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002402{
Gilles Peskinee108d982022-04-26 16:50:40 +02002403 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002404#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002406#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002408#endif
2409 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002410
Gilles Peskinee108d982022-04-26 16:50:40 +02002411 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002412#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002413 encrypt_then_mac = transform->encrypt_then_mac;
2414#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002416}
2417
Neil Armstrongab555e02022-04-04 11:07:59 +02002418mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002419#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002421#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002423{
Gilles Peskinee108d982022-04-26 16:50:40 +02002424 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2425
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002426#if defined(MBEDTLS_USE_PSA_CRYPTO)
2427 psa_status_t status;
2428 psa_algorithm_t alg;
2429 psa_key_type_t type;
2430 size_t size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002431 status = mbedtls_ssl_cipher_to_psa(suite->cipher, 0, &alg, &type, &size);
2432 if (status == PSA_SUCCESS) {
2433 base_mode = mbedtls_ssl_get_base_mode(alg);
2434 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002435#else
2436 const mbedtls_cipher_info_t *cipher =
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 mbedtls_cipher_info_from_type(suite->cipher);
2438 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002439 base_mode =
2440 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002442 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002443#endif /* MBEDTLS_USE_PSA_CRYPTO */
2444
Gilles Peskinee108d982022-04-26 16:50:40 +02002445#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2446 int encrypt_then_mac = 0;
2447#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002449}
2450
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002451#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002452
2453#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002454/* Serialization of TLS 1.3 sessions:
2455 *
2456 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002457 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002458 * uint64 ticket_received;
2459 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002460 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002461 * } ClientOnlyData;
2462 *
2463 * struct {
2464 * uint8 endpoint;
2465 * uint8 ciphersuite[2];
2466 * uint32 ticket_age_add;
2467 * uint8 ticket_flags;
2468 * opaque resumption_key<0..255>;
2469 * select ( endpoint ) {
2470 * case client: ClientOnlyData;
2471 * case server: uint64 start_time;
2472 * };
2473 * } serialized_session_tls13;
2474 *
2475 */
2476#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002477MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002478static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2479 unsigned char *buf,
2480 size_t buf_len,
2481 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002482{
2483 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002484#if defined(MBEDTLS_SSL_CLI_C) && \
2485 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 size_t hostname_len = (session->hostname == NULL) ?
2487 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002488#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002489 size_t needed = 1 /* endpoint */
2490 + 2 /* ciphersuite */
2491 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002492 + 1 /* ticket_flags */
2493 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002494 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2497 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2498 }
Jerry Yu34191072022-08-18 10:32:09 +08002499 needed += session->resumption_key_len; /* resumption_key */
2500
Jerry Yu438ddd82022-07-07 06:55:50 +00002501#if defined(MBEDTLS_HAVE_TIME)
2502 needed += 8; /* start_time or ticket_received */
2503#endif
2504
2505#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002507#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002508 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002510#endif
2511
Jerry Yu438ddd82022-07-07 06:55:50 +00002512 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002513 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002514
2515 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 if (session->ticket_len > SIZE_MAX - needed) {
2517 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2518 }
Jerry Yu34191072022-08-18 10:32:09 +08002519
Jerry Yue28d9742022-08-18 15:44:03 +08002520 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002521 }
2522#endif /* MBEDTLS_SSL_CLI_C */
2523
Jerry Yue36fdd62022-08-17 21:31:36 +08002524 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 if (needed > buf_len) {
2526 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2527 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002528
2529 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2531 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002532 p[7] = session->ticket_flags;
2533
2534 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002535 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002536 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002537 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002538 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002539
2540#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2542 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002543 p += 8;
2544 }
2545#endif /* MBEDTLS_HAVE_TIME */
2546
2547#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002549#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002551 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002553 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002555 p += hostname_len;
2556 }
2557#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2558
Jerry Yu438ddd82022-07-07 06:55:50 +00002559#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002561 p += 8;
2562#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002564 p += 4;
2565
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002567 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002568
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 if (session->ticket != NULL && session->ticket_len > 0) {
2570 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002571 p += session->ticket_len;
2572 }
2573 }
2574#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002576}
2577
2578MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002579static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2580 const unsigned char *buf,
2581 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002582{
2583 const unsigned char *p = buf;
2584 const unsigned char *end = buf + len;
2585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 if (end - p < 9) {
2587 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2588 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002589 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2591 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002592 session->ticket_flags = p[7];
2593
2594 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002595 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002596 p += 9;
2597
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 if (end - p < session->resumption_key_len) {
2599 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2600 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002601
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2603 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2604 }
2605 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002606 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002607
2608#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2610 if (end - p < 8) {
2611 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2612 }
2613 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002614 p += 8;
2615 }
2616#endif /* MBEDTLS_HAVE_TIME */
2617
2618#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002620#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002622 size_t hostname_len;
2623 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 if (end - p < 2) {
2625 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2626 }
2627 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002628 p += 2;
2629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (end - p < (long int) hostname_len) {
2631 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2632 }
2633 if (hostname_len > 0) {
2634 session->hostname = mbedtls_calloc(1, hostname_len);
2635 if (session->hostname == NULL) {
2636 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2637 }
2638 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002639 p += hostname_len;
2640 }
2641#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2642 MBEDTLS_SSL_SESSION_TICKETS */
2643
Jerry Yu438ddd82022-07-07 06:55:50 +00002644#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 if (end - p < 8) {
2646 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2647 }
2648 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002649 p += 8;
2650#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 if (end - p < 4) {
2652 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2653 }
2654 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002655 p += 4;
2656
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 if (end - p < 2) {
2658 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2659 }
2660 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002661 p += 2;
2662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 if (end - p < (long int) session->ticket_len) {
2664 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2665 }
2666 if (session->ticket_len > 0) {
2667 session->ticket = mbedtls_calloc(1, session->ticket_len);
2668 if (session->ticket == NULL) {
2669 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2670 }
2671 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002672 p += session->ticket_len;
2673 }
2674 }
2675#endif /* MBEDTLS_SSL_CLI_C */
2676
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002678
2679}
2680#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002681MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002682static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2683 unsigned char *buf,
2684 size_t buf_len,
2685 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002686{
2687 ((void) session);
2688 ((void) buf);
2689 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002690 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002692}
Jerry Yu438ddd82022-07-07 06:55:50 +00002693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2695 unsigned char *buf,
2696 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002697{
2698 ((void) session);
2699 ((void) buf);
2700 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002702}
2703#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002704#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2705
Gilles Peskine449bd832023-01-11 14:50:10 +01002706psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2707 size_t taglen,
2708 psa_algorithm_t *alg,
2709 psa_key_type_t *key_type,
2710 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002711{
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002713 case MBEDTLS_CIPHER_AES_128_CBC:
2714 *alg = PSA_ALG_CBC_NO_PADDING;
2715 *key_type = PSA_KEY_TYPE_AES;
2716 *key_size = 128;
2717 break;
2718 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002720 *key_type = PSA_KEY_TYPE_AES;
2721 *key_size = 128;
2722 break;
2723 case MBEDTLS_CIPHER_AES_128_GCM:
2724 *alg = PSA_ALG_GCM;
2725 *key_type = PSA_KEY_TYPE_AES;
2726 *key_size = 128;
2727 break;
2728 case MBEDTLS_CIPHER_AES_192_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 = 192;
2732 break;
2733 case MBEDTLS_CIPHER_AES_192_GCM:
2734 *alg = PSA_ALG_GCM;
2735 *key_type = PSA_KEY_TYPE_AES;
2736 *key_size = 192;
2737 break;
2738 case MBEDTLS_CIPHER_AES_256_CBC:
2739 *alg = PSA_ALG_CBC_NO_PADDING;
2740 *key_type = PSA_KEY_TYPE_AES;
2741 *key_size = 256;
2742 break;
2743 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002745 *key_type = PSA_KEY_TYPE_AES;
2746 *key_size = 256;
2747 break;
2748 case MBEDTLS_CIPHER_AES_256_GCM:
2749 *alg = PSA_ALG_GCM;
2750 *key_type = PSA_KEY_TYPE_AES;
2751 *key_size = 256;
2752 break;
2753 case MBEDTLS_CIPHER_ARIA_128_CBC:
2754 *alg = PSA_ALG_CBC_NO_PADDING;
2755 *key_type = PSA_KEY_TYPE_ARIA;
2756 *key_size = 128;
2757 break;
2758 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002760 *key_type = PSA_KEY_TYPE_ARIA;
2761 *key_size = 128;
2762 break;
2763 case MBEDTLS_CIPHER_ARIA_128_GCM:
2764 *alg = PSA_ALG_GCM;
2765 *key_type = PSA_KEY_TYPE_ARIA;
2766 *key_size = 128;
2767 break;
2768 case MBEDTLS_CIPHER_ARIA_192_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 = 192;
2772 break;
2773 case MBEDTLS_CIPHER_ARIA_192_GCM:
2774 *alg = PSA_ALG_GCM;
2775 *key_type = PSA_KEY_TYPE_ARIA;
2776 *key_size = 192;
2777 break;
2778 case MBEDTLS_CIPHER_ARIA_256_CBC:
2779 *alg = PSA_ALG_CBC_NO_PADDING;
2780 *key_type = PSA_KEY_TYPE_ARIA;
2781 *key_size = 256;
2782 break;
2783 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002785 *key_type = PSA_KEY_TYPE_ARIA;
2786 *key_size = 256;
2787 break;
2788 case MBEDTLS_CIPHER_ARIA_256_GCM:
2789 *alg = PSA_ALG_GCM;
2790 *key_type = PSA_KEY_TYPE_ARIA;
2791 *key_size = 256;
2792 break;
2793 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2794 *alg = PSA_ALG_CBC_NO_PADDING;
2795 *key_type = PSA_KEY_TYPE_CAMELLIA;
2796 *key_size = 128;
2797 break;
2798 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002800 *key_type = PSA_KEY_TYPE_CAMELLIA;
2801 *key_size = 128;
2802 break;
2803 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2804 *alg = PSA_ALG_GCM;
2805 *key_type = PSA_KEY_TYPE_CAMELLIA;
2806 *key_size = 128;
2807 break;
2808 case MBEDTLS_CIPHER_CAMELLIA_192_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 = 192;
2812 break;
2813 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2814 *alg = PSA_ALG_GCM;
2815 *key_type = PSA_KEY_TYPE_CAMELLIA;
2816 *key_size = 192;
2817 break;
2818 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2819 *alg = PSA_ALG_CBC_NO_PADDING;
2820 *key_type = PSA_KEY_TYPE_CAMELLIA;
2821 *key_size = 256;
2822 break;
2823 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002825 *key_type = PSA_KEY_TYPE_CAMELLIA;
2826 *key_size = 256;
2827 break;
2828 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2829 *alg = PSA_ALG_GCM;
2830 *key_type = PSA_KEY_TYPE_CAMELLIA;
2831 *key_size = 256;
2832 break;
2833 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2834 *alg = PSA_ALG_CHACHA20_POLY1305;
2835 *key_type = PSA_KEY_TYPE_CHACHA20;
2836 *key_size = 256;
2837 break;
2838 case MBEDTLS_CIPHER_NULL:
2839 *alg = MBEDTLS_SSL_NULL_CIPHER;
2840 *key_type = 0;
2841 *key_size = 0;
2842 break;
2843 default:
2844 return PSA_ERROR_NOT_SUPPORTED;
2845 }
2846
2847 return PSA_SUCCESS;
2848}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002849#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002850
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002851#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002852int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2853 const unsigned char *dhm_P, size_t P_len,
2854 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002855{
Janos Follath865b3eb2019-12-16 11:46:15 +00002856 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 mbedtls_mpi_free(&conf->dhm_P);
2859 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2862 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2863 mbedtls_mpi_free(&conf->dhm_P);
2864 mbedtls_mpi_free(&conf->dhm_G);
2865 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002866 }
2867
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002869}
Paul Bakker5121ce52009-01-03 21:22:43 +00002870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002872{
Janos Follath865b3eb2019-12-16 11:46:15 +00002873 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 mbedtls_mpi_free(&conf->dhm_P);
2876 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002877
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2879 &conf->dhm_P)) != 0 ||
2880 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2881 &conf->dhm_G)) != 0) {
2882 mbedtls_mpi_free(&conf->dhm_P);
2883 mbedtls_mpi_free(&conf->dhm_G);
2884 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002885 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002886
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002888}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002889#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002890
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002891#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2892/*
2893 * Set the minimum length for Diffie-Hellman parameters
2894 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002895void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2896 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002897{
2898 conf->dhm_min_bitlen = bitlen;
2899}
2900#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2901
Ronald Crone68ab4f2022-10-05 12:46:29 +02002902#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002903#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002904/*
2905 * Set allowed/preferred hashes for handshake signatures
2906 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002907void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2908 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002909{
2910 conf->sig_hashes = hashes;
2911}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002912#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002913
Jerry Yuf017ee42022-01-12 15:49:48 +08002914/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002915void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2916 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002917{
Jerry Yuf017ee42022-01-12 15:49:48 +08002918#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2919 conf->sig_hashes = NULL;
2920#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2921 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002922}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002923#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002924
Valerio Setti6c496a12023-04-07 15:53:51 +02002925#if defined(MBEDTLS_ECP_LIGHT)
Brett Warrene0edc842021-08-17 09:53:13 +01002926#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002927/*
2928 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002929 *
2930 * mbedtls_ssl_setup() takes the provided list
2931 * and translates it to a list of IANA TLS group identifiers,
2932 * stored in ssl->handshake->group_list.
2933 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002934 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002935void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2936 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002937{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002938 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002939 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002940}
Brett Warrene0edc842021-08-17 09:53:13 +01002941#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6c496a12023-04-07 15:53:51 +02002942#endif /* MBEDTLS_ECP_LIGHT */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002943
Brett Warrene0edc842021-08-17 09:53:13 +01002944/*
2945 * Set the allowed groups
2946 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002947void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2948 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002949{
2950#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2951 conf->curve_list = NULL;
2952#endif
2953 conf->group_list = group_list;
2954}
2955
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002956#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002957int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002958{
Hanno Becker947194e2017-04-07 13:25:49 +01002959 /* Initialize to suppress unnecessary compiler warning */
2960 size_t hostname_len = 0;
2961
2962 /* Check if new hostname is valid before
2963 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 if (hostname != NULL) {
2965 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002966
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2968 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2969 }
Hanno Becker947194e2017-04-07 13:25:49 +01002970 }
2971
2972 /* Now it's clear that we will overwrite the old hostname,
2973 * so we can free it safely */
2974
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 if (ssl->hostname != NULL) {
2976 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
2977 mbedtls_free(ssl->hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002978 }
2979
2980 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002981
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002983 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 } else {
2985 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2986 if (ssl->hostname == NULL) {
2987 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2988 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002989
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002991
Hanno Becker947194e2017-04-07 13:25:49 +01002992 ssl->hostname[hostname_len] = '\0';
2993 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002994
Gilles Peskine449bd832023-01-11 14:50:10 +01002995 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002996}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002997#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002998
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002999#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003000void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3001 int (*f_sni)(void *, mbedtls_ssl_context *,
3002 const unsigned char *, size_t),
3003 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003004{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003005 conf->f_sni = f_sni;
3006 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003007}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003009
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003011int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003012{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003013 size_t cur_len, tot_len;
3014 const char **p;
3015
3016 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003017 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3018 * MUST NOT be truncated."
3019 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003020 */
3021 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 for (p = protos; *p != NULL; p++) {
3023 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003024 tot_len += cur_len;
3025
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 if ((cur_len == 0) ||
3027 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3028 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3029 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3030 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003031 }
3032
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003033 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003034
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003036}
3037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003039{
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003041}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003043
Johan Pascalb62bb512015-12-03 21:56:45 +01003044#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003045void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3046 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003047{
3048 conf->dtls_srtp_mki_support = support_mki_value;
3049}
3050
Gilles Peskine449bd832023-01-11 14:50:10 +01003051int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3052 unsigned char *mki_value,
3053 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003054{
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003057 }
Ron Eldor591f1622018-01-22 12:30:04 +02003058
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3060 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003061 }
Ron Eldor591f1622018-01-22 12:30:04 +02003062
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003064 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003066}
3067
Gilles Peskine449bd832023-01-11 14:50:10 +01003068int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3069 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003070{
Johan Pascal253d0262020-09-22 13:04:45 +02003071 const mbedtls_ssl_srtp_profile *p;
3072 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003073
Johan Pascal253d0262020-09-22 13:04:45 +02003074 /* check the profiles list: all entry must be valid,
3075 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003076 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3077 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3078 p++) {
3079 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003080 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003082 /* unsupported value, stop parsing and set the size to an error value */
3083 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003084 }
3085 }
3086
Gilles Peskine449bd832023-01-11 14:50:10 +01003087 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3088 conf->dtls_srtp_profile_list = NULL;
3089 conf->dtls_srtp_profile_list_len = 0;
3090 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003091 }
3092
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003093 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003094 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003097}
3098
Gilles Peskine449bd832023-01-11 14:50:10 +01003099void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3100 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003101{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003102 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3103 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003105 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003107 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3109 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003110 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003111}
Johan Pascalb62bb512015-12-03 21:56:45 +01003112#endif /* MBEDTLS_SSL_DTLS_SRTP */
3113
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303114#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003115void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003116{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003117 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00003118}
3119
Gilles Peskine449bd832023-01-11 14:50:10 +01003120void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003121{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003122 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00003123}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303124#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003125
Janos Follath088ce432017-04-10 12:42:31 +01003126#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003127void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3128 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003129{
3130 conf->cert_req_ca_list = cert_req_ca_list;
3131}
3132#endif
3133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003135void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003136{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003137 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003138}
3139#endif
3140
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003141#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003142void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003143{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003144 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003145}
3146#endif
3147
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003148#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003149int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003150{
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3152 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3153 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003154 }
3155
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003156 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003157
Gilles Peskine449bd832023-01-11 14:50:10 +01003158 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003159}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003161
Gilles Peskine449bd832023-01-11 14:50:10 +01003162void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003163{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003164 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003165}
3166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003168void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003169{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003170 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003171}
3172
Gilles Peskine449bd832023-01-11 14:50:10 +01003173void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003174{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003175 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003176}
3177
Gilles Peskine449bd832023-01-11 14:50:10 +01003178void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3179 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003180{
Gilles Peskine449bd832023-01-11 14:50:10 +01003181 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003182}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003186#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003187void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003188{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003189 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003190}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003191#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003192
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003193#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003194
Jerry Yud0766ec2022-09-22 10:46:57 +08003195#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003196void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3197 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003198{
Jerry Yud0766ec2022-09-22 10:46:57 +08003199 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003200}
3201#endif
3202
Gilles Peskine449bd832023-01-11 14:50:10 +01003203void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3204 mbedtls_ssl_ticket_write_t *f_ticket_write,
3205 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3206 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003207{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003208 conf->f_ticket_write = f_ticket_write;
3209 conf->f_ticket_parse = f_ticket_parse;
3210 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003211}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003212#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003213#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003214
Gilles Peskine449bd832023-01-11 14:50:10 +01003215void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3216 mbedtls_ssl_export_keys_t *f_export_keys,
3217 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003218{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003219 ssl->f_export_keys = f_export_keys;
3220 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003221}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003222
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003223#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003224void mbedtls_ssl_conf_async_private_cb(
3225 mbedtls_ssl_config *conf,
3226 mbedtls_ssl_async_sign_t *f_async_sign,
3227 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3228 mbedtls_ssl_async_resume_t *f_async_resume,
3229 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003231{
3232 conf->f_async_sign_start = f_async_sign;
3233 conf->f_async_decrypt_start = f_async_decrypt;
3234 conf->f_async_resume = f_async_resume;
3235 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003236 conf->p_async_config_data = async_config_data;
3237}
3238
Gilles Peskine449bd832023-01-11 14:50:10 +01003239void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003240{
Gilles Peskine449bd832023-01-11 14:50:10 +01003241 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003242}
3243
Gilles Peskine449bd832023-01-11 14:50:10 +01003244void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003245{
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 if (ssl->handshake == NULL) {
3247 return NULL;
3248 } else {
3249 return ssl->handshake->user_async_ctx;
3250 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003251}
3252
Gilles Peskine449bd832023-01-11 14:50:10 +01003253void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3254 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003255{
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003257 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003259}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003260#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003261
Paul Bakker5121ce52009-01-03 21:22:43 +00003262/*
3263 * SSL get accessors
3264 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003265uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003266{
Gilles Peskine449bd832023-01-11 14:50:10 +01003267 if (ssl->session != NULL) {
3268 return ssl->session->verify_result;
3269 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003270
Gilles Peskine449bd832023-01-11 14:50:10 +01003271 if (ssl->session_negotiate != NULL) {
3272 return ssl->session_negotiate->verify_result;
3273 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003274
Gilles Peskine449bd832023-01-11 14:50:10 +01003275 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003276}
3277
Gilles Peskine449bd832023-01-11 14:50:10 +01003278int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003279{
Gilles Peskine449bd832023-01-11 14:50:10 +01003280 if (ssl == NULL || ssl->session == NULL) {
3281 return 0;
3282 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003283
Gilles Peskine449bd832023-01-11 14:50:10 +01003284 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003285}
3286
Gilles Peskine449bd832023-01-11 14:50:10 +01003287const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003288{
Gilles Peskine449bd832023-01-11 14:50:10 +01003289 if (ssl == NULL || ssl->session == NULL) {
3290 return NULL;
3291 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003292
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003294}
3295
Gilles Peskine449bd832023-01-11 14:50:10 +01003296const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003297{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003298#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3300 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003301 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003302 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003303 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003304 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003305 }
3306 }
3307#endif
3308
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003310 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003311 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003312 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003313 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003314 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003316 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003317}
3318
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003319#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003320size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003321{
David Horstmann95d516f2021-05-04 18:36:56 +01003322 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003323 size_t read_mfl;
3324
Jerry Yuddda0502022-12-01 19:43:12 +08003325#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003326 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003327 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3328 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3329 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003330 }
Jerry Yuddda0502022-12-01 19:43:12 +08003331#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003332
3333 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003334 if (ssl->session_out != NULL) {
3335 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3336 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003337 max_len = read_mfl;
3338 }
3339 }
3340
Jerry Yuddda0502022-12-01 19:43:12 +08003341 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 if (ssl->session_negotiate != NULL) {
3343 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3344 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003345 max_len = read_mfl;
3346 }
3347 }
3348
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003350}
3351
Gilles Peskine449bd832023-01-11 14:50:10 +01003352size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003353{
3354 size_t max_len;
3355
3356 /*
3357 * Assume mfl_code is correct since it was checked when set
3358 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003360
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003361 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 if (ssl->session_out != NULL &&
3363 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3364 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003365 }
3366
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003367 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 if (ssl->session_negotiate != NULL &&
3369 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3370 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003371 }
3372
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003374}
3375#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3376
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003377#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003378size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003379{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003380 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003381 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3382 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3383 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3384 return 0;
3385 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003386
Gilles Peskine449bd832023-01-11 14:50:10 +01003387 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3388 return ssl->mtu;
3389 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003390
Gilles Peskine449bd832023-01-11 14:50:10 +01003391 if (ssl->mtu == 0) {
3392 return ssl->handshake->mtu;
3393 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003394
Gilles Peskine449bd832023-01-11 14:50:10 +01003395 return ssl->mtu < ssl->handshake->mtu ?
3396 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003397}
3398#endif /* MBEDTLS_SSL_PROTO_DTLS */
3399
Gilles Peskine449bd832023-01-11 14:50:10 +01003400int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003401{
3402 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3403
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003404#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3405 !defined(MBEDTLS_SSL_PROTO_DTLS)
3406 (void) ssl;
3407#endif
3408
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003409#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003410 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003411
Gilles Peskine449bd832023-01-11 14:50:10 +01003412 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003413 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003414 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003415#endif
3416
3417#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3419 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3420 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003421 const size_t overhead = (size_t) ret;
3422
Gilles Peskine449bd832023-01-11 14:50:10 +01003423 if (ret < 0) {
3424 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003425 }
3426
Gilles Peskine449bd832023-01-11 14:50:10 +01003427 if (mtu <= overhead) {
3428 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3429 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3430 }
3431
3432 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003433 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003434 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003435 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003436#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003437
Hanno Becker0defedb2018-08-10 12:35:02 +01003438#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3439 !defined(MBEDTLS_SSL_PROTO_DTLS)
3440 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003441#endif
3442
Gilles Peskine449bd832023-01-11 14:50:10 +01003443 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003444}
3445
Gilles Peskine449bd832023-01-11 14:50:10 +01003446int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003447{
3448 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3449
3450#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3451 (void) ssl;
3452#endif
3453
3454#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003456
Gilles Peskine449bd832023-01-11 14:50:10 +01003457 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003458 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003459 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003460#endif
3461
Gilles Peskine449bd832023-01-11 14:50:10 +01003462 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003463}
3464
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003466const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003467{
Gilles Peskine449bd832023-01-11 14:50:10 +01003468 if (ssl == NULL || ssl->session == NULL) {
3469 return NULL;
3470 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003471
Hanno Beckere6824572019-02-07 13:18:46 +00003472#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003473 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003474#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003475 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003476#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003477}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003478#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003479
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003481int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3482 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003483{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003484 int ret;
3485
Gilles Peskine449bd832023-01-11 14:50:10 +01003486 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003487 dst == NULL ||
3488 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003489 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3490 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003491 }
3492
Hanno Beckere810bbc2021-05-14 16:01:05 +01003493 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3494 * idempotent: Each session can only be exported once.
3495 *
3496 * (This is in preparation for TLS 1.3 support where we will
3497 * need the ability to export multiple sessions (aka tickets),
3498 * which will be achieved by calling mbedtls_ssl_get_session()
3499 * multiple times until it fails.)
3500 *
3501 * Check whether we have already exported the current session,
3502 * and fail if so.
3503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003504 if (ssl->session->exported == 1) {
3505 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3506 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003507
Gilles Peskine449bd832023-01-11 14:50:10 +01003508 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3509 if (ret != 0) {
3510 return ret;
3511 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003512
3513 /* Remember that we've exported the session. */
3514 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003515 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003516}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003518
Paul Bakker5121ce52009-01-03 21:22:43 +00003519/*
Hanno Beckera835da52019-05-16 12:39:07 +01003520 * Define ticket header determining Mbed TLS version
3521 * and structure of the ticket.
3522 */
3523
Hanno Becker94ef3b32019-05-16 12:50:45 +01003524/*
Hanno Becker50b59662019-05-28 14:30:45 +01003525 * Define bitflag determining compile-time settings influencing
3526 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003527 */
3528
Hanno Becker50b59662019-05-28 14:30:45 +01003529#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003530#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003531#else
Hanno Becker3e088662019-05-29 11:10:18 +01003532#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003533#endif /* MBEDTLS_HAVE_TIME */
3534
3535#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003536#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003537#else
Hanno Becker3e088662019-05-29 11:10:18 +01003538#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003539#endif /* MBEDTLS_X509_CRT_PARSE_C */
3540
3541#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003542#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003543#else
Hanno Becker3e088662019-05-29 11:10:18 +01003544#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003545#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3546
3547#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003548#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003549#else
Hanno Becker3e088662019-05-29 11:10:18 +01003550#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003551#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3552
Hanno Becker94ef3b32019-05-16 12:50:45 +01003553#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003554#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003555#else
Hanno Becker3e088662019-05-29 11:10:18 +01003556#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003557#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3558
Hanno Becker94ef3b32019-05-16 12:50:45 +01003559#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3560#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3561#else
3562#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3563#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3564
Hanno Becker3e088662019-05-29 11:10:18 +01003565#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3566#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3567#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3568#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003569#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3570#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003571
Hanno Becker50b59662019-05-28 14:30:45 +01003572#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003573 ((uint16_t) ( \
3574 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3575 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3576 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3577 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3578 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3579 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3580 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003581
Hanno Beckerf8787072019-05-16 12:41:07 +01003582static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003583 MBEDTLS_VERSION_MAJOR,
3584 MBEDTLS_VERSION_MINOR,
3585 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003586 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3587 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003588};
Hanno Beckera835da52019-05-16 12:39:07 +01003589
3590/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003591 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003592 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003593 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003594 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003595 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003596 * opaque mbedtls_version[3]; // library version: major, minor, patch
3597 * opaque session_format[2]; // library-version specific 16-bit field
3598 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003599 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003600 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003601 * Note: When updating the format, remember to keep
3602 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003603 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003604 * // In this version, `session_format` determines
3605 * // the setting of those compile-time
3606 * // configuration options which influence
3607 * // the structure of mbedtls_ssl_session.
3608 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003609 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003610 * // - TLS 1.2 (0x0303)
3611 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003612 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003613 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003614 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003615 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003616 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003617 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003618 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003619 *
3620 * };
3621 *
3622 * } serialized_session;
3623 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003624 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003625
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003626MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003627static int ssl_session_save(const mbedtls_ssl_session *session,
3628 unsigned char omit_header,
3629 unsigned char *buf,
3630 size_t buf_len,
3631 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003632{
3633 unsigned char *p = buf;
3634 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003635 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003636#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3637 size_t out_len;
3638 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3639#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003640 if (session == NULL) {
3641 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3642 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003643
Gilles Peskine449bd832023-01-11 14:50:10 +01003644 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003645 /*
3646 * Add Mbed TLS version identifier
3647 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003648 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003649
Gilles Peskine449bd832023-01-11 14:50:10 +01003650 if (used <= buf_len) {
3651 memcpy(p, ssl_serialized_session_header,
3652 sizeof(ssl_serialized_session_header));
3653 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003654 }
3655 }
3656
3657 /*
3658 * TLS version identifier
3659 */
3660 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003661 if (used <= buf_len) {
3662 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003663 }
3664
3665 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003666 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003667 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003668#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003669 case MBEDTLS_SSL_VERSION_TLS1_2:
3670 used += ssl_tls12_session_save(session, p, remaining_len);
3671 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003672#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3673
Jerry Yu251a12e2022-07-13 15:15:48 +08003674#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003675 case MBEDTLS_SSL_VERSION_TLS1_3:
3676 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3677 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3678 return ret;
3679 }
3680 used += out_len;
3681 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003682#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3683
Gilles Peskine449bd832023-01-11 14:50:10 +01003684 default:
3685 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003686 }
3687
3688 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003689 if (used > buf_len) {
3690 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3691 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003692
Gilles Peskine449bd832023-01-11 14:50:10 +01003693 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003694}
3695
3696/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003697 * Public wrapper for ssl_session_save()
3698 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003699int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3700 unsigned char *buf,
3701 size_t buf_len,
3702 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003703{
Gilles Peskine449bd832023-01-11 14:50:10 +01003704 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003705}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003706
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003707/*
3708 * Deserialize session, see mbedtls_ssl_session_save() for format.
3709 *
3710 * This internal version is wrapped by a public function that cleans up in
3711 * case of error, and has an extra option omit_header.
3712 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003713MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003714static int ssl_session_load(mbedtls_ssl_session *session,
3715 unsigned char omit_header,
3716 const unsigned char *buf,
3717 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003718{
3719 const unsigned char *p = buf;
3720 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003721 size_t remaining_len;
3722
3723
Gilles Peskine449bd832023-01-11 14:50:10 +01003724 if (session == NULL) {
3725 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3726 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003727
Gilles Peskine449bd832023-01-11 14:50:10 +01003728 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003729 /*
3730 * Check Mbed TLS version identifier
3731 */
3732
Gilles Peskine449bd832023-01-11 14:50:10 +01003733 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3734 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003735 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003736
3737 if (memcmp(p, ssl_serialized_session_header,
3738 sizeof(ssl_serialized_session_header)) != 0) {
3739 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3740 }
3741 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003742 }
3743
3744 /*
3745 * TLS version identifier
3746 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003747 if (1 > (size_t) (end - p)) {
3748 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3749 }
Glenn Straussda7851c2022-03-14 13:29:48 -04003750 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003751
3752 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003753 remaining_len = (end - p);
3754 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003755#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003756 case MBEDTLS_SSL_VERSION_TLS1_2:
3757 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003758#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3759
Jerry Yu438ddd82022-07-07 06:55:50 +00003760#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003761 case MBEDTLS_SSL_VERSION_TLS1_3:
3762 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003763#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3764
Gilles Peskine449bd832023-01-11 14:50:10 +01003765 default:
3766 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003767 }
3768}
3769
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003770/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003771 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003772 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003773int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3774 const unsigned char *buf,
3775 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003776{
Gilles Peskine449bd832023-01-11 14:50:10 +01003777 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003778
Gilles Peskine449bd832023-01-11 14:50:10 +01003779 if (ret != 0) {
3780 mbedtls_ssl_session_free(session);
3781 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003782
Gilles Peskine449bd832023-01-11 14:50:10 +01003783 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003784}
3785
3786/*
Paul Bakker1961b702013-01-25 14:49:24 +01003787 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003788 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003789MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003790static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003791{
3792 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3793
Ronald Cron66dbf912022-02-02 15:33:46 +01003794 /*
3795 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003796 * that were written into the output buffer by the previous handshake step,
3797 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003798 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3799 * We proceed to the next handshake step only when all data from the
3800 * previous one have been sent to the peer, thus we make sure that this is
3801 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3802 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3803 * we have to wait before to go ahead.
3804 * In the case of TLS 1.3, handshake step handlers do not send data to the
3805 * peer. Data are only sent here and through
3806 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003807 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003808 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003809 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3810 return ret;
3811 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003812
3813#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003814 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3815 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3816 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3817 return ret;
3818 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003819 }
3820#endif /* MBEDTLS_SSL_PROTO_DTLS */
3821
Gilles Peskine449bd832023-01-11 14:50:10 +01003822 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003823}
3824
Gilles Peskine449bd832023-01-11 14:50:10 +01003825int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003826{
Hanno Becker41934dd2021-08-07 19:13:43 +01003827 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003828
Gilles Peskine449bd832023-01-11 14:50:10 +01003829 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003830 ssl->conf == NULL ||
3831 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003832 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3833 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003834 }
3835
Gilles Peskine449bd832023-01-11 14:50:10 +01003836 ret = ssl_prepare_handshake_step(ssl);
3837 if (ret != 0) {
3838 return ret;
3839 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003840
Gilles Peskine449bd832023-01-11 14:50:10 +01003841 ret = mbedtls_ssl_handle_pending_alert(ssl);
3842 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003843 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003844 }
Jerry Yue7047812021-09-13 19:26:39 +08003845
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003846 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3847 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3848 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3849
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003850#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003851 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3852 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
3853 mbedtls_ssl_states_str(ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003854
Gilles Peskine449bd832023-01-11 14:50:10 +01003855 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003856 case MBEDTLS_SSL_HELLO_REQUEST:
3857 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003858 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003859 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003860
Ronald Cron9f0fba32022-02-10 16:45:15 +01003861 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003862 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003863 break;
3864
3865 default:
3866#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003867 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3868 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3869 } else {
3870 ret = mbedtls_ssl_handshake_client_step(ssl);
3871 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003872#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003873 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003874#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003875 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003876#endif
3877 }
Jerry Yub9930e72021-08-06 17:11:51 +08003878 }
Ronald Cron6291b232023-03-08 15:51:25 +01003879#endif /* MBEDTLS_SSL_CLI_C */
3880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003881#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003882 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003883#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3884 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003885 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003886 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003887 ret = mbedtls_ssl_handshake_server_step(ssl);
3888 }
Ronald Cron6291b232023-03-08 15:51:25 +01003889#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3890 ret = mbedtls_ssl_handshake_server_step(ssl);
3891#else
3892 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003893#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003894 }
3895#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003896
Gilles Peskine449bd832023-01-11 14:50:10 +01003897 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003898 /* handshake_step return error. And it is same
3899 * with alert_reason.
3900 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003901 if (ssl->send_alert) {
3902 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003903 goto cleanup;
3904 }
3905 }
3906
3907cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003908 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003909}
3910
3911/*
3912 * Perform the SSL handshake
3913 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003914int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003915{
3916 int ret = 0;
3917
Hanno Beckera817ea42020-10-20 15:20:23 +01003918 /* Sanity checks */
3919
Gilles Peskine449bd832023-01-11 14:50:10 +01003920 if (ssl == NULL || ssl->conf == NULL) {
3921 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3922 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003923
Hanno Beckera817ea42020-10-20 15:20:23 +01003924#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003925 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3926 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3927 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3928 "mbedtls_ssl_set_timer_cb() for DTLS"));
3929 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003930 }
3931#endif /* MBEDTLS_SSL_PROTO_DTLS */
3932
Gilles Peskine449bd832023-01-11 14:50:10 +01003933 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003934
Hanno Beckera817ea42020-10-20 15:20:23 +01003935 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003936 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3937 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003938
Gilles Peskine449bd832023-01-11 14:50:10 +01003939 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003940 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003941 }
Paul Bakker1961b702013-01-25 14:49:24 +01003942 }
3943
Gilles Peskine449bd832023-01-11 14:50:10 +01003944 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003945
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003947}
3948
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003949#if defined(MBEDTLS_SSL_RENEGOTIATION)
3950#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003951/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003952 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003953 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003954MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003955static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003956{
Janos Follath865b3eb2019-12-16 11:46:15 +00003957 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003958
Gilles Peskine449bd832023-01-11 14:50:10 +01003959 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003960
3961 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003962 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3963 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003964
Gilles Peskine449bd832023-01-11 14:50:10 +01003965 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3966 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3967 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003968 }
3969
Gilles Peskine449bd832023-01-11 14:50:10 +01003970 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003971
Gilles Peskine449bd832023-01-11 14:50:10 +01003972 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003973}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003974#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003975
3976/*
3977 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003978 * - any side: calling mbedtls_ssl_renegotiate(),
3979 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3980 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003981 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003982 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003983 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003984 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003985int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003986{
Janos Follath865b3eb2019-12-16 11:46:15 +00003987 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003988
Gilles Peskine449bd832023-01-11 14:50:10 +01003989 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00003990
Gilles Peskine449bd832023-01-11 14:50:10 +01003991 if ((ret = ssl_handshake_init(ssl)) != 0) {
3992 return ret;
3993 }
Paul Bakker48916f92012-09-16 19:57:18 +00003994
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003995 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3996 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003997#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003998 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3999 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4000 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004001 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004003 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004004 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004005 }
4006#endif
4007
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004008 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4009 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004010
Gilles Peskine449bd832023-01-11 14:50:10 +01004011 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4012 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4013 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004014 }
4015
Gilles Peskine449bd832023-01-11 14:50:10 +01004016 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004017
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004019}
4020
4021/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004022 * Renegotiate current connection on client,
4023 * or request renegotiation on server
4024 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004025int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004026{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004027 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004028
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 if (ssl == NULL || ssl->conf == NULL) {
4030 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4031 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004032
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004033#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004034 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004035 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4036 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4037 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4038 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004039
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004040 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004041
4042 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 if (ssl->out_left != 0) {
4044 return mbedtls_ssl_flush_output(ssl);
4045 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004046
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004048 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004049#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004051#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004052 /*
4053 * On client, either start the renegotiation process or,
4054 * if already in progress, continue the handshake
4055 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004056 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4057 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4058 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004059 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004060
4061 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4062 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4063 return ret;
4064 }
4065 } else {
4066 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4067 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4068 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004069 }
4070 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004071#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004072
Gilles Peskine449bd832023-01-11 14:50:10 +01004073 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004074}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004075#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004076
Gilles Peskine449bd832023-01-11 14:50:10 +01004077void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004078{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004079 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4080
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004082 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004084
Valerio Setti6c496a12023-04-07 15:53:51 +02004085#if defined(MBEDTLS_ECP_LIGHT)
Brett Warrene0edc842021-08-17 09:53:13 +01004086#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004087 if (ssl->handshake->group_list_heap_allocated) {
4088 mbedtls_free((void *) handshake->group_list);
4089 }
Brett Warrene0edc842021-08-17 09:53:13 +01004090 handshake->group_list = NULL;
4091#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6c496a12023-04-07 15:53:51 +02004092#endif /* MBEDTLS_ECP_LIGHT */
Brett Warrene0edc842021-08-17 09:53:13 +01004093
Ronald Crone68ab4f2022-10-05 12:46:29 +02004094#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004095#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 if (ssl->handshake->sig_algs_heap_allocated) {
4097 mbedtls_free((void *) handshake->sig_algs);
4098 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004099 handshake->sig_algs = NULL;
4100#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004101#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004102 if (ssl->handshake->certificate_request_context) {
4103 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004104 }
4105#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004106#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004107
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004108#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4110 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004111 handshake->async_in_progress = 0;
4112 }
4113#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4114
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004115#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004116#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004117 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004118#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004119 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004120#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004121#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004122#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004123#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004125#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004126 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004127#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004128#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004129
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004130#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004131 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004132#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02004133#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004135#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004136
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004137#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004138#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004140 /*
4141 * Opaque keys are not stored in the handshake's data and it's the user
4142 * responsibility to destroy them. Clear ones, instead, are created by
4143 * the TLS library and should be destroyed at the same level
4144 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4146 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004147 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004148 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4149#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004151#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004152#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004154 handshake->ecjpake_cache = NULL;
4155 handshake->ecjpake_cache_len = 0;
4156#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004157#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004158
Janos Follath4ae5c292016-02-10 11:27:43 +00004159#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4160 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004161 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004162 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004163#endif
4164
Ronald Cron73fe8df2022-10-05 14:31:43 +02004165#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004166#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004168 /* The maintenance of the external PSK key slot is the
4169 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 if (ssl->handshake->psk_opaque_is_internal) {
4171 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004172 ssl->handshake->psk_opaque_is_internal = 0;
4173 }
4174 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4175 }
Neil Armstronge952a302022-05-03 10:22:14 +02004176#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004177 if (handshake->psk != NULL) {
4178 mbedtls_platform_zeroize(handshake->psk, handshake->psk_len);
4179 mbedtls_free(handshake->psk);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004180 }
Neil Armstronge952a302022-05-03 10:22:14 +02004181#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004182#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004184#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4185 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004186 /*
4187 * Free only the linked list wrapper, not the keys themselves
4188 * since the belong to the SNI callback
4189 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004190 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004191#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004192
Gilles Peskineeccd8882020-03-10 12:19:08 +01004193#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004194 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4195 if (handshake->ecrs_peer_cert != NULL) {
4196 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4197 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004198 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004199#endif
4200
Hanno Becker75173122019-02-06 16:18:31 +00004201#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4202 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004204#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4205
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004206#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4208 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004209#endif /* MBEDTLS_SSL_CLI_C &&
4210 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004211
4212#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 mbedtls_ssl_flight_free(handshake->flight);
4214 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004215#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004216
Valerio Setti080a22b2023-03-20 15:22:47 +01004217#if defined(PSA_WANT_ALG_ECDH) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004218 (defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4219 if (handshake->ecdh_psa_privkey_is_external == 0) {
4220 psa_destroy_key(handshake->ecdh_psa_privkey);
4221 }
Valerio Setti080a22b2023-03-20 15:22:47 +01004222#endif /* PSA_WANT_ALG_ECDH && (MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3) */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004223
Ronald Cron6f135e12021-12-08 16:57:54 +01004224#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 mbedtls_ssl_transform_free(handshake->transform_handshake);
4226 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004227#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4229 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004230#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004231#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004232
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004233
4234#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4235 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4236 * processes datagrams and the fact that a datagram is allowed to have
4237 * several records in it, it is possible that the I/O buffers are not
4238 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4240 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004241#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004242
Jerry Yuba9c7272021-10-30 11:54:10 +08004243 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 mbedtls_platform_zeroize(handshake,
4245 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004246}
4247
Gilles Peskine449bd832023-01-11 14:50:10 +01004248void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004249{
Gilles Peskine449bd832023-01-11 14:50:10 +01004250 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004251 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004252 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004253
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004254#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004256#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004257
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004258#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004259#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4260 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004262#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004264#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004265
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004267}
4268
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004269#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004270
4271#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4272#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4273#else
4274#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4275#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4276
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004277#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004278
4279#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4280#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4281#else
4282#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4283#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4284
4285#if defined(MBEDTLS_SSL_ALPN)
4286#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4287#else
4288#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4289#endif /* MBEDTLS_SSL_ALPN */
4290
4291#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4292#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4293#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4294#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4295
4296#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 ((uint32_t) ( \
4298 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4299 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4300 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4301 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4302 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4303 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4304 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4305 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004306
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004307static unsigned char ssl_serialized_context_header[] = {
4308 MBEDTLS_VERSION_MAJOR,
4309 MBEDTLS_VERSION_MINOR,
4310 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4312 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4313 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4314 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4315 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004316};
4317
Paul Bakker5121ce52009-01-03 21:22:43 +00004318/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004319 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004320 *
4321 * The format of the serialized data is:
4322 * (in the presentation language of TLS, RFC 8446 section 3)
4323 *
4324 * // header
4325 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004326 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004327 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004328 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004329 * Note: When updating the format, remember to keep these
4330 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004331 *
4332 * // session sub-structure
4333 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4334 * // transform sub-structure
4335 * uint8 random[64]; // ServerHello.random+ClientHello.random
4336 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4337 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4338 * // fields from ssl_context
4339 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4340 * uint64 in_window_top; // DTLS: last validated record seq_num
4341 * uint64 in_window; // DTLS: bitmask for replay protection
4342 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4343 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4344 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4345 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4346 *
4347 * Note that many fields of the ssl_context or sub-structures are not
4348 * serialized, as they fall in one of the following categories:
4349 *
4350 * 1. forced value (eg in_left must be 0)
4351 * 2. pointer to dynamically-allocated memory (eg session, transform)
4352 * 3. value can be re-derived from other data (eg session keys from MS)
4353 * 4. value was temporary (eg content of input buffer)
4354 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004355 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004356int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4357 unsigned char *buf,
4358 size_t buf_len,
4359 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004360{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004361 unsigned char *p = buf;
4362 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004363 size_t session_len;
4364 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004365
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004366 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004367 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4368 * this function's documentation.
4369 *
4370 * These are due to assumptions/limitations in the implementation. Some of
4371 * them are likely to stay (no handshake in progress) some might go away
4372 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004373 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004374 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4376 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4377 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004378 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 if (ssl->handshake != NULL) {
4380 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4381 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004382 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004383 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 if (ssl->transform == NULL || ssl->session == NULL) {
4385 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4386 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004387 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004388 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if (mbedtls_ssl_check_pending(ssl) != 0) {
4390 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4391 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004392 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if (ssl->out_left != 0) {
4394 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4395 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004396 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004397 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4399 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4400 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004401 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004402 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4404 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4405 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004406 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004407 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4409 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites 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 /* Renegotiation must not be enabled */
4413#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4415 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4416 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004417 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004418#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004419
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004420 /*
4421 * Version and format identifier
4422 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004424
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 if (used <= buf_len) {
4426 memcpy(p, ssl_serialized_context_header,
4427 sizeof(ssl_serialized_context_header));
4428 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004429 }
4430
4431 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004432 * Session (length + data)
4433 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4435 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4436 return ret;
4437 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004438
4439 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 if (used <= buf_len) {
4441 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004442 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004443
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 ret = ssl_session_save(ssl->session, 1,
4445 p, session_len, &session_len);
4446 if (ret != 0) {
4447 return ret;
4448 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004449
4450 p += session_len;
4451 }
4452
4453 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004454 * Transform
4455 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 used += sizeof(ssl->transform->randbytes);
4457 if (used <= buf_len) {
4458 memcpy(p, ssl->transform->randbytes,
4459 sizeof(ssl->transform->randbytes));
4460 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004461 }
4462
4463#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4464 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004466 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004468 p += ssl->transform->in_cid_len;
4469
4470 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004472 p += ssl->transform->out_cid_len;
4473 }
4474#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4475
4476 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004477 * Saved fields from top-level ssl_context structure
4478 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004479 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 if (used <= buf_len) {
4481 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004482 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004483 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004484
4485#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4486 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 if (used <= buf_len) {
4488 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004489 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004490
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004492 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004493 }
4494#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4495
4496#if defined(MBEDTLS_SSL_PROTO_DTLS)
4497 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004499 *p++ = ssl->disable_datagram_packing;
4500 }
4501#endif /* MBEDTLS_SSL_PROTO_DTLS */
4502
Jerry Yuae0b2e22021-10-08 15:21:19 +08004503 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 if (used <= buf_len) {
4505 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004506 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004507 }
4508
4509#if defined(MBEDTLS_SSL_PROTO_DTLS)
4510 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 if (used <= buf_len) {
4512 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004513 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004514 }
4515#endif /* MBEDTLS_SSL_PROTO_DTLS */
4516
4517#if defined(MBEDTLS_SSL_ALPN)
4518 {
4519 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004520 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004521 : 0;
4522
4523 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004525 *p++ = alpn_len;
4526
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (ssl->alpn_chosen != NULL) {
4528 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004529 p += alpn_len;
4530 }
4531 }
4532 }
4533#endif /* MBEDTLS_SSL_ALPN */
4534
4535 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004536 * Done
4537 */
4538 *olen = used;
4539
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 if (used > buf_len) {
4541 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4542 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004543
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004545
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004547}
4548
4549/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004550 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004551 *
4552 * This internal version is wrapped by a public function that cleans up in
4553 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004554 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004555MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004556static int ssl_context_load(mbedtls_ssl_context *ssl,
4557 const unsigned char *buf,
4558 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004559{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004560 const unsigned char *p = buf;
4561 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004562 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004563 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004564#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004565 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004566#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004567
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004568 /*
4569 * The context should have been freshly setup or reset.
4570 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004571 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004572 * renegotiating, or if the user mistakenly loaded a session first.)
4573 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4575 ssl->session != NULL) {
4576 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004577 }
4578
4579 /*
4580 * We can't check that the config matches the initial one, but we can at
4581 * least check it matches the requirements for serializing.
4582 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004584 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4585 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004586#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004587 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004588#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 0) {
4590 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004591 }
4592
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004594
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004595 /*
4596 * Check version identifier
4597 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4599 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004600 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004601
4602 if (memcmp(p, ssl_serialized_context_header,
4603 sizeof(ssl_serialized_context_header)) != 0) {
4604 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4605 }
4606 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004607
4608 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004609 * Session
4610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 if ((size_t) (end - p) < 4) {
4612 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4613 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004614
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 session_len = ((size_t) p[0] << 24) |
4616 ((size_t) p[1] << 16) |
4617 ((size_t) p[2] << 8) |
4618 ((size_t) p[3]);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004619 p += 4;
4620
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004621 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004622 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004623 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004624 ssl->session_in = ssl->session;
4625 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004626 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004627
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 if ((size_t) (end - p) < session_len) {
4629 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4630 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004631
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 ret = ssl_session_load(ssl->session, 1, p, session_len);
4633 if (ret != 0) {
4634 mbedtls_ssl_session_free(ssl->session);
4635 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004636 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004637
4638 p += session_len;
4639
4640 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004641 * Transform
4642 */
4643
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004644 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004645 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004646#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004647 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004648 ssl->transform_in = ssl->transform;
4649 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004650 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004651#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004652
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004653#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4655 if (prf_func == NULL) {
4656 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4657 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004658
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004659 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4661 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4662 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004663
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 ret = ssl_tls12_populate_transform(ssl->transform,
4665 ssl->session->ciphersuite,
4666 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004667#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004669#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 prf_func,
4671 p, /* currently pointing to randbytes */
4672 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4673 ssl->conf->endpoint,
4674 ssl);
4675 if (ret != 0) {
4676 return ret;
4677 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004678#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004680
4681#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4682 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 if ((size_t) (end - p) < 1) {
4684 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4685 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004686
4687 ssl->transform->in_cid_len = *p++;
4688
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4690 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4691 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004694 p += ssl->transform->in_cid_len;
4695
4696 ssl->transform->out_cid_len = *p++;
4697
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4700 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004701
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004703 p += ssl->transform->out_cid_len;
4704#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4705
4706 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004707 * Saved fields from top-level ssl_context structure
4708 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 if ((size_t) (end - p) < 4) {
4710 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4711 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004712
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 ssl->badmac_seen = ((uint32_t) p[0] << 24) |
4714 ((uint32_t) p[1] << 16) |
4715 ((uint32_t) p[2] << 8) |
4716 ((uint32_t) p[3]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004717 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004718
4719#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 if ((size_t) (end - p) < 16) {
4721 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4722 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004723
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 ssl->in_window_top = ((uint64_t) p[0] << 56) |
4725 ((uint64_t) p[1] << 48) |
4726 ((uint64_t) p[2] << 40) |
4727 ((uint64_t) p[3] << 32) |
4728 ((uint64_t) p[4] << 24) |
4729 ((uint64_t) p[5] << 16) |
4730 ((uint64_t) p[6] << 8) |
4731 ((uint64_t) p[7]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004732 p += 8;
4733
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 ssl->in_window = ((uint64_t) p[0] << 56) |
4735 ((uint64_t) p[1] << 48) |
4736 ((uint64_t) p[2] << 40) |
4737 ((uint64_t) p[3] << 32) |
4738 ((uint64_t) p[4] << 24) |
4739 ((uint64_t) p[5] << 16) |
4740 ((uint64_t) p[6] << 8) |
4741 ((uint64_t) p[7]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004742 p += 8;
4743#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4744
4745#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 if ((size_t) (end - p) < 1) {
4747 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4748 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004749
4750 ssl->disable_datagram_packing = *p++;
4751#endif /* MBEDTLS_SSL_PROTO_DTLS */
4752
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4755 }
4756 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4757 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004758
4759#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 if ((size_t) (end - p) < 2) {
4761 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4762 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004763
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004765 p += 2;
4766#endif /* MBEDTLS_SSL_PROTO_DTLS */
4767
4768#if defined(MBEDTLS_SSL_ALPN)
4769 {
4770 uint8_t alpn_len;
4771 const char **cur;
4772
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 if ((size_t) (end - p) < 1) {
4774 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4775 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004776
4777 alpn_len = *p++;
4778
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004780 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4782 if (strlen(*cur) == alpn_len &&
4783 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004784 ssl->alpn_chosen = *cur;
4785 break;
4786 }
4787 }
4788 }
4789
4790 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4792 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4793 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004794
4795 p += alpn_len;
4796 }
4797#endif /* MBEDTLS_SSL_ALPN */
4798
4799 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004800 * Forced fields from top-level ssl_context structure
4801 *
4802 * Most of them already set to the correct value by mbedtls_ssl_init() and
4803 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4804 */
4805 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004806 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004807
Hanno Becker361b10d2019-08-30 10:42:49 +01004808 /* Adjust pointers for header fields of outgoing records to
4809 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004811
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004812#if defined(MBEDTLS_SSL_PROTO_DTLS)
4813 ssl->in_epoch = 1;
4814#endif
4815
4816 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4817 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004818 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4819 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 if (ssl->handshake != NULL) {
4821 mbedtls_ssl_handshake_free(ssl);
4822 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004823 ssl->handshake = NULL;
4824 }
4825
4826 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004827 * Done - should have consumed entire buffer
4828 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 if (p != end) {
4830 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4831 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004834}
4835
4836/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004837 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004838 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004839int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4840 const unsigned char *buf,
4841 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004842{
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004844
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 if (ret != 0) {
4846 mbedtls_ssl_free(context);
4847 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004848
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004850}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004851#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004852
4853/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004854 * Free an SSL context
4855 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004856void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004857{
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004859 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004861
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004863
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004865#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4866 size_t out_buf_len = ssl->out_buf_len;
4867#else
4868 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4869#endif
4870
Gilles Peskine449bd832023-01-11 14:50:10 +01004871 mbedtls_platform_zeroize(ssl->out_buf, out_buf_len);
4872 mbedtls_free(ssl->out_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004873 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004874 }
4875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004877#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4878 size_t in_buf_len = ssl->in_buf_len;
4879#else
4880 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4881#endif
4882
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 mbedtls_platform_zeroize(ssl->in_buf, in_buf_len);
4884 mbedtls_free(ssl->in_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004885 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004886 }
4887
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 if (ssl->transform) {
4889 mbedtls_ssl_transform_free(ssl->transform);
4890 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004891 }
4892
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 if (ssl->handshake) {
4894 mbedtls_ssl_handshake_free(ssl);
4895 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004896
4897#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4899 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004900#endif
4901
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 mbedtls_ssl_session_free(ssl->session_negotiate);
4903 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004904 }
4905
Ronald Cron6f135e12021-12-08 16:57:54 +01004906#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 mbedtls_ssl_transform_free(ssl->transform_application);
4908 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004909#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004910
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 if (ssl->session) {
4912 mbedtls_ssl_session_free(ssl->session);
4913 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004914 }
4915
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004916#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 if (ssl->hostname != NULL) {
4918 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
4919 mbedtls_free(ssl->hostname);
Paul Bakker5121ce52009-01-03 21:22:43 +00004920 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004921#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004922
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004923#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004925#endif
4926
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004928
Paul Bakker86f04f42013-02-14 11:20:09 +01004929 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004931}
4932
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004933/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004934 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004935 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004936void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004937{
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004939}
4940
Gilles Peskineae270bf2021-06-02 00:05:29 +02004941/* The selection should be the same as mbedtls_x509_crt_profile_default in
4942 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004943 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004944 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004945 * about this list.
4946 */
Brett Warrene0edc842021-08-17 09:53:13 +01004947static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004948#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004949 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004950#endif
4951#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004952 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004953#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004954#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004955 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004956#endif
4957#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004958 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004959#endif
4960#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004961 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004962#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004963#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004964 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004965#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004966#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004967 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004968#endif
4969#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004970 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004971#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004972 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004973};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004974
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03004975static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004976 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4977 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4978 0
4979};
4980
Ronald Crone68ab4f2022-10-05 12:46:29 +02004981#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004982
Jerry Yu909df7b2022-01-22 11:56:27 +08004983/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004984 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004985 * rules SHOULD be upheld.
4986 * - No duplicate entries.
4987 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004988 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004989 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004990 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004991static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004992
Valerio Setti75fba322023-02-23 17:35:09 +01004993#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004994 defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004995 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4996 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004997#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA256 &&
Jerry Yued5e9f42022-01-26 11:21:34 +08004998 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004999
Valerio Setti75fba322023-02-23 17:35:09 +01005000#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005001 defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08005002 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5003 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005004#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu909df7b2022-01-22 11:56:27 +08005005 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
5006
Valerio Setti75fba322023-02-23 17:35:09 +01005007#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005008 defined(MBEDTLS_MD_CAN_SHA512) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08005009 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
5010 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005011#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yued5e9f42022-01-26 11:21:34 +08005012 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005013
Gilles Peskine449bd832023-01-11 14:50:10 +01005014#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005015 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005016 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005017#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005018 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005019
Gilles Peskine449bd832023-01-11 14:50:10 +01005020#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005021 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005022 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005023#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005024 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005025
Gilles Peskine449bd832023-01-11 14:50:10 +01005026#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005027 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005028 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005029#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005030 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005031
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005032#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005033 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005034#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005035
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005036#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005037 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005038#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005039
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005040#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005041 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005042#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005043
Gabor Mezei15b95a62022-05-09 16:37:58 +02005044 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005045};
5046
5047/* NOTICE: see above */
5048#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5049static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005050#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Setti75fba322023-02-23 17:35:09 +01005051#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005053#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005054#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5055 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5056#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005057#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005059#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005060#endif /* MBEDTLS_MD_CAN_SHA512*/
5061#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Setti75fba322023-02-23 17:35:09 +01005062#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005064#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005065#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5066 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5067#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005068#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005070#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005071#endif /* MBEDTLS_MD_CAN_SHA384*/
5072#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Setti75fba322023-02-23 17:35:09 +01005073#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005074 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005075#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005076#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5077 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5078#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005079#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005081#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005082#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005083 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005084};
5085#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5086/* NOTICE: see above */
5087static uint16_t ssl_preset_suiteb_sig_algs[] = {
5088
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005089#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08005090 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5091 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005092#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA256&&
Jerry Yu909df7b2022-01-22 11:56:27 +08005093 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
5094
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005095#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu53037892022-01-25 11:02:06 +08005096 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5097 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005098#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu53037892022-01-25 11:02:06 +08005099 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005100
Gilles Peskine449bd832023-01-11 14:50:10 +01005101#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005102 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005103 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005104#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005105 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005106
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005107#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005108 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005109#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005110
Gabor Mezei15b95a62022-05-09 16:37:58 +02005111 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005112};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005113
Jerry Yu909df7b2022-01-22 11:56:27 +08005114/* NOTICE: see above */
5115#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5116static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005117#if defined(MBEDTLS_MD_CAN_SHA256)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005118#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005119 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005120#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005121#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005123#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005124#endif /* MBEDTLS_MD_CAN_SHA256*/
5125#if defined(MBEDTLS_MD_CAN_SHA384)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005126#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005128#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005129#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005131#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005132#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005133 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005134};
Jerry Yu909df7b2022-01-22 11:56:27 +08005135#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5136
Ronald Crone68ab4f2022-10-05 12:46:29 +02005137#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005138
Brett Warrene0edc842021-08-17 09:53:13 +01005139static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01005140#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005141 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005142#endif
5143#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005144 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005145#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005146 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005147};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005148
Ronald Crone68ab4f2022-10-05 12:46:29 +02005149#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005150/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005151 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005152MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005153static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005154{
5155 size_t i, j;
5156 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005157
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5159 for (j = 0; j < i; j++) {
5160 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005161 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 }
5163 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5164 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5165 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005166 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005167 }
5168 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005169 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005170}
5171
Ronald Crone68ab4f2022-10-05 12:46:29 +02005172#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005173
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005174/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005175 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005176 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005177int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5178 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005179{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005180#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005181 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005182#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005183
Ronald Crone68ab4f2022-10-05 12:46:29 +02005184#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5186 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5187 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005188 }
5189
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5191 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5192 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005193 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005194
5195#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5197 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5198 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005199 }
5200
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5202 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5203 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005204 }
5205#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005206#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005207
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005208 /* Use the functions here so that they are covered in tests,
5209 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 mbedtls_ssl_conf_endpoint(conf, endpoint);
5211 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005212
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005213 /*
5214 * Things that are common to all presets
5215 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005216#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005218 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5219#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5220 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5221#endif
5222 }
5223#endif
5224
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005225#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5226 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5227#endif
5228
5229#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5230 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5231#endif
5232
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005233#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005234 conf->f_cookie_write = ssl_cookie_write_dummy;
5235 conf->f_cookie_check = ssl_cookie_check_dummy;
5236#endif
5237
5238#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5239 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5240#endif
5241
Janos Follath088ce432017-04-10 12:42:31 +01005242#if defined(MBEDTLS_SSL_SRV_C)
5243 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005244 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005245#endif
5246
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005247#if defined(MBEDTLS_SSL_PROTO_DTLS)
5248 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5249 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5250#endif
5251
5252#if defined(MBEDTLS_SSL_RENEGOTIATION)
5253 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005254 memset(conf->renego_period, 0x00, 2);
5255 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005256#endif
5257
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005258#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005260 const unsigned char dhm_p[] =
5261 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5262 const unsigned char dhm_g[] =
5263 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005264
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5266 dhm_p, sizeof(dhm_p),
5267 dhm_g, sizeof(dhm_g))) != 0) {
5268 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005269 }
5270 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005271#endif
5272
Ronald Cron6f135e12021-12-08 16:57:54 +01005273#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005274
5275#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 mbedtls_ssl_tls13_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005277#if defined(MBEDTLS_SSL_SRV_C)
5278 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005280#endif
5281#endif /* MBEDTLS_SSL_EARLY_DATA */
5282
Jerry Yud0766ec2022-09-22 10:46:57 +08005283#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005284 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005286#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005287 /*
5288 * Allow all TLS 1.3 key exchange modes by default.
5289 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005290 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005291#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005292
Gilles Peskine449bd832023-01-11 14:50:10 +01005293 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005294#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005295 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005296 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005297#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005299#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005301#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005302 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5303 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005304#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5305 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5306 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5307#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5308 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5309 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5310#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005312#endif
5313 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005314
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005315 /*
5316 * Preset-specific defaults
5317 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005319 /*
5320 * NSA Suite B
5321 */
5322 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005323
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005324 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005325
5326#if defined(MBEDTLS_X509_CRT_PARSE_C)
5327 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005328#endif
5329
Ronald Crone68ab4f2022-10-05 12:46:29 +02005330#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005331#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005333 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005335#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005337#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005338
Brett Warrene0edc842021-08-17 09:53:13 +01005339#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5340 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005341#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005342 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005343 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005344
5345 /*
5346 * Default
5347 */
5348 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005349
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005350 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005351
5352#if defined(MBEDTLS_X509_CRT_PARSE_C)
5353 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5354#endif
5355
Ronald Crone68ab4f2022-10-05 12:46:29 +02005356#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005357#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005359 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005361#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005363#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005364
Brett Warrene0edc842021-08-17 09:53:13 +01005365#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5366 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005367#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005368 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005369
5370#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5371 conf->dhm_min_bitlen = 1024;
5372#endif
5373 }
5374
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005376}
5377
5378/*
5379 * Free mbedtls_ssl_config
5380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005381void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005382{
5383#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 mbedtls_mpi_free(&conf->dhm_P);
5385 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005386#endif
5387
Ronald Cron73fe8df2022-10-05 14:31:43 +02005388#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005389#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005391 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5392 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005393#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 if (conf->psk != NULL) {
5395 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
5396 mbedtls_free(conf->psk);
Azim Khan27e8a122018-03-21 14:24:11 +00005397 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005398 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005399 }
5400
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 if (conf->psk_identity != NULL) {
5402 mbedtls_platform_zeroize(conf->psk_identity, conf->psk_identity_len);
5403 mbedtls_free(conf->psk_identity);
Azim Khan27e8a122018-03-21 14:24:11 +00005404 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005405 conf->psk_identity_len = 0;
5406 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005407#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005408
5409#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005411#endif
5412
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005414}
5415
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005416#if defined(MBEDTLS_PK_C) && \
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005417 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_CAN_ECDSA_SOME))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005418/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005419 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005420 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005421unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005422{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005423#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5425 return MBEDTLS_SSL_SIG_RSA;
5426 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005427#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005428#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5430 return MBEDTLS_SSL_SIG_ECDSA;
5431 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005432#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005434}
5435
Gilles Peskine449bd832023-01-11 14:50:10 +01005436unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005437{
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005439 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005441 case MBEDTLS_PK_ECDSA:
5442 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005444 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005446 }
5447}
5448
Gilles Peskine449bd832023-01-11 14:50:10 +01005449mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005450{
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005452#if defined(MBEDTLS_RSA_C)
5453 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005455#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005456#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005457 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005459#endif
5460 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005462 }
5463}
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005464#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_PK_CAN_ECDSA_SOME ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005465
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005466/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005467 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005468 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005469mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005470{
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005472#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005473 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005475#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005476#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005477 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005479#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005480#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005481 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005483#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005484#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005485 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005487#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005488#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005489 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005491#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005492#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005493 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005495#endif
5496 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005498 }
5499}
5500
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005501/*
5502 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005504unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005505{
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005507#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005508 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005510#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005511#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005512 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005514#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005515#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005516 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005518#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005519#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005520 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005522#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005523#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005524 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005526#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005527#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005528 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005530#endif
5531 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005533 }
5534}
5535
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005536/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005537 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005538 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005539 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005540int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005541{
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005543
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 if (group_list == NULL) {
5545 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005546 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005547
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 for (; *group_list != 0; group_list++) {
5549 if (*group_list == tls_id) {
5550 return 0;
5551 }
5552 }
5553
5554 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005555}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005556
Valerio Settid4a5d462023-04-05 18:19:01 +02005557#if defined(MBEDTLS_ECP_LIGHT)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005558/*
5559 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5560 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005561int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005562{
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005564
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005566 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005568
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005570}
Valerio Settid4a5d462023-04-05 18:19:01 +02005571#endif /* MBEDTLS_ECP_LIGHT */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005572
Gilles Peskine449bd832023-01-11 14:50:10 +01005573#if defined(MBEDTLS_DEBUG_C)
Valerio Setti67419f02023-01-04 16:12:42 +01005574#define EC_NAME(_name_) _name_
5575#else
5576#define EC_NAME(_name_) NULL
5577#endif
5578
Valerio Setti18c9fed2022-12-30 17:44:24 +01005579static const struct {
5580 uint16_t tls_id;
5581 mbedtls_ecp_group_id ecp_group_id;
5582 psa_ecc_family_t psa_family;
5583 uint16_t bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 const char *name;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005585} tls_id_match_table[] =
5586{
5587#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521, EC_NAME("secp521r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005589#endif
5590#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512, EC_NAME("brainpoolP512r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005592#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005593#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384, EC_NAME("secp384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005595#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005596#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384, EC_NAME("brainpoolP384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005598#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005599#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256, EC_NAME("secp256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005601#endif
5602#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256, EC_NAME("secp256k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005604#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005605#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256, EC_NAME("brainpoolP256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005607#endif
5608#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224, EC_NAME("secp224r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005610#endif
5611#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224, EC_NAME("secp224k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005613#endif
5614#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192, EC_NAME("secp192r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005616#endif
5617#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192, EC_NAME("secp192k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005619#endif
5620#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255, EC_NAME("x25519") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005622#endif
5623#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448, EC_NAME("x448") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005625#endif
5626 { 0, MBEDTLS_ECP_DP_NONE, 0, 0, NULL },
5627};
5628
Gilles Peskine449bd832023-01-11 14:50:10 +01005629int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
5630 psa_ecc_family_t *family,
5631 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005632{
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5634 if (tls_id_match_table[i].tls_id == tls_id) {
5635 if (family != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005636 *family = tls_id_match_table[i].psa_family;
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 }
5638 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005639 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005641 return PSA_SUCCESS;
5642 }
5643 }
5644
5645 return PSA_ERROR_NOT_SUPPORTED;
5646}
5647
Gilles Peskine449bd832023-01-11 14:50:10 +01005648mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005649{
Gilles Peskine449bd832023-01-11 14:50:10 +01005650 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5651 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005652 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005653 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005654 }
5655
5656 return MBEDTLS_ECP_DP_NONE;
5657}
5658
Gilles Peskine449bd832023-01-11 14:50:10 +01005659uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005660{
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5662 i++) {
5663 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005664 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005666 }
5667
5668 return 0;
5669}
5670
Valerio Setti67419f02023-01-04 16:12:42 +01005671#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005672const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005673{
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5675 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005676 return tls_id_match_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005678 }
5679
5680 return NULL;
5681}
Valerio Setti67419f02023-01-04 16:12:42 +01005682#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005683
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005684#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005685int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5686 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5687 int cert_endpoint,
5688 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005689{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005690 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005691 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005692 const char *ext_oid;
5693 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005694
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005696 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005698 case MBEDTLS_KEY_EXCHANGE_RSA:
5699 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005700 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005701 break;
5702
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005703 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5704 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5705 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5706 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005707 break;
5708
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005709 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5710 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005711 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005712 break;
5713
5714 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005715 case MBEDTLS_KEY_EXCHANGE_NONE:
5716 case MBEDTLS_KEY_EXCHANGE_PSK:
5717 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5718 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005719 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005720 usage = 0;
5721 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005723 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5724 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005725 }
5726
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005728 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005729 ret = -1;
5730 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005731
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005733 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5735 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005736 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005738 }
5739
Gilles Peskine449bd832023-01-11 14:50:10 +01005740 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005741 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005742 ret = -1;
5743 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005744
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005746}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005747#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005748
Jerry Yu148165c2021-09-24 23:20:59 +08005749#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005750int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5751 const mbedtls_md_type_t md,
5752 unsigned char *dst,
5753 size_t dst_len,
5754 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005755{
Ronald Cronf6893e12022-01-07 22:09:01 +01005756 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5757 psa_hash_operation_t *hash_operation_to_clone;
5758 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5759
Jerry Yu148165c2021-09-24 23:20:59 +08005760 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005761
Gilles Peskine449bd832023-01-11 14:50:10 +01005762 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005763#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 case MBEDTLS_MD_SHA384:
5765 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5766 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005767#endif
5768
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005769#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 case MBEDTLS_MD_SHA256:
5771 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5772 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005773#endif
5774
Gilles Peskine449bd832023-01-11 14:50:10 +01005775 default:
5776 goto exit;
5777 }
5778
5779 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5780 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005781 goto exit;
5782 }
5783
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5785 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005786 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005787 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005788
5789exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005790#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5791 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005792 (void) ssl;
5793#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005794 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005795}
5796#else /* MBEDTLS_USE_PSA_CRYPTO */
5797
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005798#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005799MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005800static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5801 unsigned char *dst,
5802 size_t dst_len,
5803 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005804{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005805 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005806 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005807
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 if (dst_len < 48) {
5809 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5810 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005811
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005812 mbedtls_md_init(&sha384);
5813 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005814 if (ret != 0) {
5815 goto exit;
5816 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005817 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005818 if (ret != 0) {
5819 goto exit;
5820 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005821
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005822 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005823 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005824 goto exit;
5825 }
5826
5827 *olen = 48;
5828
5829exit:
5830
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005831 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005833}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005834#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005835
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005836#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005837MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005838static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5839 unsigned char *dst,
5840 size_t dst_len,
5841 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005842{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005843 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005844 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005845
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 if (dst_len < 32) {
5847 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5848 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005849
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005850 mbedtls_md_init(&sha256);
5851 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5852 if (ret != 0) {
5853 goto exit;
5854 }
5855 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5856 if (ret != 0) {
5857 goto exit;
5858 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005859
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005860 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5861 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005862 goto exit;
5863 }
5864
5865 *olen = 32;
5866
5867exit:
5868
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005869 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005871}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005872#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005873
Gilles Peskine449bd832023-01-11 14:50:10 +01005874int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5875 const mbedtls_md_type_t md,
5876 unsigned char *dst,
5877 size_t dst_len,
5878 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005879{
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005881
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005882#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005883 case MBEDTLS_MD_SHA384:
5884 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005885#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005886
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005887#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 case MBEDTLS_MD_SHA256:
5889 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005890#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005891
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005893#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5894 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005895 (void) ssl;
5896 (void) dst;
5897 (void) dst_len;
5898 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005899#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005901 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005903}
XiaokangQian647719a2021-12-07 09:16:29 +00005904
Jerry Yu148165c2021-09-24 23:20:59 +08005905#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005906
Ronald Crone68ab4f2022-10-05 12:46:29 +02005907#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005908/* mbedtls_ssl_parse_sig_alg_ext()
5909 *
5910 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5911 * value (TLS 1.3 RFC8446):
5912 * enum {
5913 * ....
5914 * ecdsa_secp256r1_sha256( 0x0403 ),
5915 * ecdsa_secp384r1_sha384( 0x0503 ),
5916 * ecdsa_secp521r1_sha512( 0x0603 ),
5917 * ....
5918 * } SignatureScheme;
5919 *
5920 * struct {
5921 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5922 * } SignatureSchemeList;
5923 *
5924 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5925 * value (TLS 1.2 RFC5246):
5926 * enum {
5927 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5928 * sha512(6), (255)
5929 * } HashAlgorithm;
5930 *
5931 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5932 * SignatureAlgorithm;
5933 *
5934 * struct {
5935 * HashAlgorithm hash;
5936 * SignatureAlgorithm signature;
5937 * } SignatureAndHashAlgorithm;
5938 *
5939 * SignatureAndHashAlgorithm
5940 * supported_signature_algorithms<2..2^16-2>;
5941 *
5942 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5943 * generalization of the TLS 1.2 signature algorithm extension.
5944 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5945 * `SignatureScheme` field of TLS 1.3
5946 *
5947 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005948int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5949 const unsigned char *buf,
5950 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005951{
5952 const unsigned char *p = buf;
5953 size_t supported_sig_algs_len = 0;
5954 const unsigned char *supported_sig_algs_end;
5955 uint16_t sig_alg;
5956 uint32_t common_idx = 0;
5957
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5959 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005960 p += 2;
5961
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 memset(ssl->handshake->received_sig_algs, 0,
5963 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005964
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005966 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 while (p < supported_sig_algs_end) {
5968 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5969 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005970 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5972 sig_alg,
5973 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005974#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5976 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5977 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005978 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005979 }
5980#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005981
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5983 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005984
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005986 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5987 common_idx += 1;
5988 }
5989 }
5990 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 if (p != end) {
5992 MBEDTLS_SSL_DEBUG_MSG(1,
5993 ("Signature algorithms extension length misaligned"));
5994 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5995 MBEDTLS_ERR_SSL_DECODE_ERROR);
5996 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02005997 }
5998
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 if (common_idx == 0) {
6000 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6001 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6002 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6003 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006004 }
6005
Gabor Mezei15b95a62022-05-09 16:37:58 +02006006 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006008}
6009
Ronald Crone68ab4f2022-10-05 12:46:29 +02006010#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006011
Jerry Yudc7bd172022-02-17 13:44:15 +08006012#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6013
6014#if defined(MBEDTLS_USE_PSA_CRYPTO)
6015
Gilles Peskine449bd832023-01-11 14:50:10 +01006016static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6017 mbedtls_svc_key_id_t key,
6018 psa_algorithm_t alg,
6019 const unsigned char *raw_psk, size_t raw_psk_length,
6020 const unsigned char *seed, size_t seed_length,
6021 const unsigned char *label, size_t label_length,
6022 const unsigned char *other_secret,
6023 size_t other_secret_length,
6024 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006025{
6026 psa_status_t status;
6027
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 status = psa_key_derivation_setup(derivation, alg);
6029 if (status != PSA_SUCCESS) {
6030 return status;
6031 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006032
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6034 status = psa_key_derivation_input_bytes(derivation,
6035 PSA_KEY_DERIVATION_INPUT_SEED,
6036 seed, seed_length);
6037 if (status != PSA_SUCCESS) {
6038 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006039 }
6040
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 if (other_secret != NULL) {
6042 status = psa_key_derivation_input_bytes(derivation,
6043 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6044 other_secret, other_secret_length);
6045 if (status != PSA_SUCCESS) {
6046 return status;
6047 }
6048 }
6049
6050 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006051 status = psa_key_derivation_input_bytes(
6052 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 raw_psk, raw_psk_length);
6054 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006055 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006057 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 if (status != PSA_SUCCESS) {
6059 return status;
6060 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006061
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 status = psa_key_derivation_input_bytes(derivation,
6063 PSA_KEY_DERIVATION_INPUT_LABEL,
6064 label, label_length);
6065 if (status != PSA_SUCCESS) {
6066 return status;
6067 }
6068 } else {
6069 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006070 }
6071
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 status = psa_key_derivation_set_capacity(derivation, capacity);
6073 if (status != PSA_SUCCESS) {
6074 return status;
6075 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006076
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006078}
6079
Andrzej Kurek57d10632022-10-24 10:32:01 -04006080#if defined(PSA_WANT_ALG_SHA_384) || \
6081 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006082MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006083static int tls_prf_generic(mbedtls_md_type_t md_type,
6084 const unsigned char *secret, size_t slen,
6085 const char *label,
6086 const unsigned char *random, size_t rlen,
6087 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006088{
6089 psa_status_t status;
6090 psa_algorithm_t alg;
6091 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6092 psa_key_derivation_operation_t derivation =
6093 PSA_KEY_DERIVATION_OPERATION_INIT;
6094
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006096 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006098 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006100
6101 /* Normally a "secret" should be long enough to be impossible to
6102 * find by brute force, and in particular should not be empty. But
6103 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6104 * and for this use case it makes sense to have a 0-length "secret".
6105 * Since the key API doesn't allow importing a key of length 0,
6106 * keep master_key=0, which setup_psa_key_derivation() understands
6107 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006109 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6111 psa_set_key_algorithm(&key_attributes, alg);
6112 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006113
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6115 if (status != PSA_SUCCESS) {
6116 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6117 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006118 }
6119
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 status = setup_psa_key_derivation(&derivation,
6121 master_key, alg,
6122 NULL, 0,
6123 random, rlen,
6124 (unsigned char const *) label,
6125 (size_t) strlen(label),
6126 NULL, 0,
6127 dlen);
6128 if (status != PSA_SUCCESS) {
6129 psa_key_derivation_abort(&derivation);
6130 psa_destroy_key(master_key);
6131 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006132 }
6133
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6135 if (status != PSA_SUCCESS) {
6136 psa_key_derivation_abort(&derivation);
6137 psa_destroy_key(master_key);
6138 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006139 }
6140
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 status = psa_key_derivation_abort(&derivation);
6142 if (status != PSA_SUCCESS) {
6143 psa_destroy_key(master_key);
6144 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006145 }
6146
Gilles Peskine449bd832023-01-11 14:50:10 +01006147 if (!mbedtls_svc_key_id_is_null(master_key)) {
6148 status = psa_destroy_key(master_key);
6149 }
6150 if (status != PSA_SUCCESS) {
6151 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6152 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006153
Gilles Peskine449bd832023-01-11 14:50:10 +01006154 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006155}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006156#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006157#else /* MBEDTLS_USE_PSA_CRYPTO */
6158
Andrzej Kurek57d10632022-10-24 10:32:01 -04006159#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006160 (defined(MBEDTLS_MD_CAN_SHA256) || \
6161 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006162MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006163static int tls_prf_generic(mbedtls_md_type_t md_type,
6164 const unsigned char *secret, size_t slen,
6165 const char *label,
6166 const unsigned char *random, size_t rlen,
6167 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006168{
6169 size_t nb;
6170 size_t i, j, k, md_len;
6171 unsigned char *tmp;
6172 size_t tmp_len = 0;
6173 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6174 const mbedtls_md_info_t *md_info;
6175 mbedtls_md_context_t md_ctx;
6176 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6177
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6181 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6182 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006185
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 tmp_len = md_len + strlen(label) + rlen;
6187 tmp = mbedtls_calloc(1, tmp_len);
6188 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006189 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6190 goto exit;
6191 }
6192
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 nb = strlen(label);
6194 memcpy(tmp + md_len, label, nb);
6195 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006196 nb += rlen;
6197
6198 /*
6199 * Compute P_<hash>(secret, label + random)[0..dlen]
6200 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006202 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006204
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6206 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006207 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 }
6209 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
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_finish(&md_ctx, tmp);
6214 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006215 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006217
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 for (i = 0; i < dlen; i += md_len) {
6219 ret = mbedtls_md_hmac_reset(&md_ctx);
6220 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006221 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 }
6223 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6224 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006225 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 }
6227 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6228 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006229 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006231
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 ret = mbedtls_md_hmac_reset(&md_ctx);
6233 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006234 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 }
6236 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6237 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006238 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 }
6240 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6241 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006242 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006244
Gilles Peskine449bd832023-01-11 14:50:10 +01006245 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006246
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006248 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006250 }
6251
6252exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006254
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 if (tmp != NULL) {
6256 mbedtls_platform_zeroize(tmp, tmp_len);
6257 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006258
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006260
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006262
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006264}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006265#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006266#endif /* MBEDTLS_USE_PSA_CRYPTO */
6267
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006268#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006269MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006270static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6271 const char *label,
6272 const unsigned char *random, size_t rlen,
6273 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006274{
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6276 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006277}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006278#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006279
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006280#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006281MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006282static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6283 const char *label,
6284 const unsigned char *random, size_t rlen,
6285 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006286{
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6288 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006289}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006290#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006291
Jerry Yuf009d862022-02-17 14:01:37 +08006292/*
6293 * Set appropriate PRF function and other SSL / TLS1.2 functions
6294 *
6295 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006296 * - hash associated with the ciphersuite (only used by TLS 1.2)
6297 *
6298 * Outputs:
6299 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6300 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006301MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006302static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6303 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006304{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006305#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006307 handshake->tls_prf = tls_prf_sha384;
6308 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6309 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006311#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006312#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006313 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006314 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006315 handshake->tls_prf = tls_prf_sha256;
6316 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6317 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6318 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006319#else
Jerry Yuf009d862022-02-17 14:01:37 +08006320 {
Jerry Yuf009d862022-02-17 14:01:37 +08006321 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006322 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006324 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006325#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006326
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006328}
Jerry Yud6ab2352022-02-17 14:03:43 +08006329
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006330/*
6331 * Compute master secret if needed
6332 *
6333 * Parameters:
6334 * [in/out] handshake
6335 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6336 * (PSA-PSK) ciphersuite_info, psk_opaque
6337 * [out] premaster (cleared)
6338 * [out] master
6339 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6340 * debug: conf->f_dbg, conf->p_dbg
6341 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006342 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006343 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006344MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006345static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6346 unsigned char *master,
6347 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006348{
6349 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6350
6351 /* cf. RFC 5246, Section 8.1:
6352 * "The master secret is always exactly 48 bytes in length." */
6353 size_t const master_secret_len = 48;
6354
6355#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6356 unsigned char session_hash[48];
6357#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6358
6359 /* The label for the KDF used for key expansion.
6360 * This is either "master secret" or "extended master secret"
6361 * depending on whether the Extended Master Secret extension
6362 * is used. */
6363 char const *lbl = "master secret";
6364
Przemek Stekielae4ed302022-04-05 17:15:55 +02006365 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006366 * - If the Extended Master Secret extension is not used,
6367 * this is ClientHello.Random + ServerHello.Random
6368 * (see Sect. 8.1 in RFC 5246).
6369 * - If the Extended Master Secret extension is used,
6370 * this is the transcript of the handshake so far.
6371 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006372 unsigned char const *seed = handshake->randbytes;
6373 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006374
6375#if !defined(MBEDTLS_DEBUG_C) && \
6376 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6377 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006379 ssl = NULL; /* make sure we don't use it except for those cases */
6380 (void) ssl;
6381#endif
6382
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 if (handshake->resume != 0) {
6384 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6385 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006386 }
6387
6388#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006390 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006391 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006392 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6393 if (ret != 0) {
6394 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6395 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006396
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6398 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006399 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006400#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006401
Przemek Stekiel99114f32022-04-22 11:20:09 +02006402#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006403 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006405 /* Perform PSK-to-MS expansion in a single step. */
6406 psa_status_t status;
6407 psa_algorithm_t alg;
6408 mbedtls_svc_key_id_t psk;
6409 psa_key_derivation_operation_t derivation =
6410 PSA_KEY_DERIVATION_OPERATION_INIT;
6411 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6412
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006414
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006416
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006418 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006420 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006422
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006423 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006427 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006428 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006429 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006430 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006431 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006432 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006433 other_secret_len = 48;
6434 other_secret = handshake->premaster + 2;
6435 break;
6436 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006437 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006438 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6439 other_secret = handshake->premaster + 2;
6440 break;
6441 default:
6442 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006443 }
6444
Gilles Peskine449bd832023-01-11 14:50:10 +01006445 status = setup_psa_key_derivation(&derivation, psk, alg,
6446 ssl->conf->psk, ssl->conf->psk_len,
6447 seed, seed_len,
6448 (unsigned char const *) lbl,
6449 (size_t) strlen(lbl),
6450 other_secret, other_secret_len,
6451 master_secret_len);
6452 if (status != PSA_SUCCESS) {
6453 psa_key_derivation_abort(&derivation);
6454 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006455 }
6456
Gilles Peskine449bd832023-01-11 14:50:10 +01006457 status = psa_key_derivation_output_bytes(&derivation,
6458 master,
6459 master_secret_len);
6460 if (status != PSA_SUCCESS) {
6461 psa_key_derivation_abort(&derivation);
6462 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006463 }
6464
Gilles Peskine449bd832023-01-11 14:50:10 +01006465 status = psa_key_derivation_abort(&derivation);
6466 if (status != PSA_SUCCESS) {
6467 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6468 }
6469 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006470#endif
6471 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006472#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006473 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6474 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006475 psa_status_t status;
6476 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6477 psa_key_derivation_operation_t derivation =
6478 PSA_KEY_DERIVATION_OPERATION_INIT;
6479
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006481
6482 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 status = psa_key_derivation_setup(&derivation, alg);
6485 if (status != PSA_SUCCESS) {
6486 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006487 }
6488
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 status = psa_key_derivation_set_capacity(&derivation,
6490 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6491 if (status != PSA_SUCCESS) {
6492 psa_key_derivation_abort(&derivation);
6493 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006494 }
6495
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6497 &derivation);
6498 if (status != PSA_SUCCESS) {
6499 psa_key_derivation_abort(&derivation);
6500 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006501 }
6502
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 status = psa_key_derivation_output_bytes(&derivation,
6504 handshake->premaster,
6505 handshake->pmslen);
6506 if (status != PSA_SUCCESS) {
6507 psa_key_derivation_abort(&derivation);
6508 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6509 }
6510
6511 status = psa_key_derivation_abort(&derivation);
6512 if (status != PSA_SUCCESS) {
6513 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006514 }
6515 }
6516#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6518 lbl, seed, seed_len,
6519 master,
6520 master_secret_len);
6521 if (ret != 0) {
6522 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6523 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006524 }
6525
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6527 handshake->premaster,
6528 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006529
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 mbedtls_platform_zeroize(handshake->premaster,
6531 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006532 }
6533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006535}
6536
Gilles Peskine449bd832023-01-11 14:50:10 +01006537int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006538{
6539 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6540 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6541 ssl->handshake->ciphersuite_info;
6542
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006544
6545 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 ret = ssl_set_handshake_prfs(ssl->handshake,
6547 ciphersuite_info->mac);
6548 if (ret != 0) {
6549 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6550 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006551 }
6552
6553 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 ret = ssl_compute_master(ssl->handshake,
6555 ssl->session_negotiate->master,
6556 ssl);
6557 if (ret != 0) {
6558 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6559 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006560 }
6561
6562 /* Swap the client and server random values:
6563 * - MS derivation wanted client+server (RFC 5246 8.1)
6564 * - key derivation wants server+client (RFC 5246 6.3) */
6565 {
6566 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 memcpy(tmp, ssl->handshake->randbytes, 64);
6568 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6569 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6570 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006571 }
6572
6573 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6575 ssl->session_negotiate->ciphersuite,
6576 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006577#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006578 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006579#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 ssl->handshake->tls_prf,
6581 ssl->handshake->randbytes,
6582 ssl->tls_version,
6583 ssl->conf->endpoint,
6584 ssl);
6585 if (ret != 0) {
6586 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6587 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006588 }
6589
6590 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6592 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006593
Gilles Peskine449bd832023-01-11 14:50:10 +01006594 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006595
Gilles Peskine449bd832023-01-11 14:50:10 +01006596 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006597}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006598
Gilles Peskine449bd832023-01-11 14:50:10 +01006599int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006600{
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006602#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006603 case MBEDTLS_SSL_HASH_SHA384:
6604 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6605 break;
6606#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006607#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006608 case MBEDTLS_SSL_HASH_SHA256:
6609 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6610 break;
6611#endif
6612 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006613 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006614 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006615#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6616 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006617 (void) ssl;
6618#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006619 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006620}
6621
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006622#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006623int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6624 unsigned char *hash,
6625 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006626{
6627#if defined(MBEDTLS_USE_PSA_CRYPTO)
6628 size_t hash_size;
6629 psa_status_t status;
6630 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
6631
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify sha256"));
6633 status = psa_hash_clone(&ssl->handshake->fin_sha256_psa, &sha256_psa);
6634 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006635 goto exit;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006636 }
6637
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 status = psa_hash_finish(&sha256_psa, hash, 32, &hash_size);
6639 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006640 goto exit;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006641 }
6642
6643 *hlen = 32;
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6645 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006646
6647exit:
6648 psa_hash_abort(&sha256_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05006649 return PSA_TO_MD_ERR(status);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006650#else
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006651 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006652 mbedtls_md_context_t sha256;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006653
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006654 mbedtls_md_init(&sha256);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006655
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify sha256"));
Jerry Yu8392e0d2022-02-17 14:10:24 +08006657
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006658 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6659 if (ret != 0) {
6660 goto exit;
6661 }
6662 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6663 if (ret != 0) {
6664 goto exit;
6665 }
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006666
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006667 ret = mbedtls_md_finish(&sha256, hash);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006668 if (ret != 0) {
6669 goto exit;
6670 }
Jerry Yu8392e0d2022-02-17 14:10:24 +08006671
6672 *hlen = 32;
6673
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6675 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
Jerry Yu8392e0d2022-02-17 14:10:24 +08006676
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006677exit:
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006678 mbedtls_md_free(&sha256);
Manuel Pégourié-Gonnard8e176f72023-02-09 10:33:54 +01006679 return ret;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006680#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006681}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006682#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006683
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006684#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006685int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6686 unsigned char *hash,
6687 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006688{
6689#if defined(MBEDTLS_USE_PSA_CRYPTO)
6690 size_t hash_size;
6691 psa_status_t status;
6692 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
6693
Gilles Peskine449bd832023-01-11 14:50:10 +01006694 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify sha384"));
6695 status = psa_hash_clone(&ssl->handshake->fin_sha384_psa, &sha384_psa);
6696 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006697 goto exit;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006698 }
6699
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 status = psa_hash_finish(&sha384_psa, hash, 48, &hash_size);
6701 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006702 goto exit;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006703 }
6704
6705 *hlen = 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006706 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6707 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006708
6709exit:
6710 psa_hash_abort(&sha384_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05006711 return PSA_TO_MD_ERR(status);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006712#else
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006713 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006714 mbedtls_md_context_t sha384;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006715
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006716 mbedtls_md_init(&sha384);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006717
Gilles Peskine449bd832023-01-11 14:50:10 +01006718 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify sha384"));
Jerry Yuc1cb3842022-02-17 14:13:48 +08006719
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006720 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006721 if (ret != 0) {
6722 goto exit;
6723 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006724 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006725 if (ret != 0) {
6726 goto exit;
6727 }
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006728
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006729 ret = mbedtls_md_finish(&sha384, hash);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006730 if (ret != 0) {
6731 goto exit;
6732 }
Jerry Yuc1cb3842022-02-17 14:13:48 +08006733
6734 *hlen = 48;
6735
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6737 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
Jerry Yuc1cb3842022-02-17 14:13:48 +08006738
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006739exit:
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006740 mbedtls_md_free(&sha384);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006741 return ret;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006742#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006743}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006744#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006745
Neil Armstrong80f6f322022-05-03 17:56:38 +02006746#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6747 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006748int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006749{
6750 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006752 const unsigned char *psk = NULL;
6753 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006755
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006757 /*
6758 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006759 * checked before calling this function.
6760 *
6761 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006762 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006763 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6765 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6766 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006767 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006768 }
6769
6770 /*
6771 * PMS = struct {
6772 * opaque other_secret<0..2^16-1>;
6773 * opaque psk<0..2^16-1>;
6774 * };
6775 * with "other_secret" depending on the particular key exchange
6776 */
6777#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6779 if (end - p < 2) {
6780 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6781 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006782
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006784 p += 2;
6785
Gilles Peskine449bd832023-01-11 14:50:10 +01006786 if (end < p || (size_t) (end - p) < psk_len) {
6787 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6788 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006789
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006791 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006793#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6794#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006795 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006796 /*
6797 * other_secret already set by the ClientKeyExchange message,
6798 * and is 48 bytes long
6799 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 if (end - p < 2) {
6801 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6802 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006803
6804 *p++ = 0;
6805 *p++ = 48;
6806 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006808#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6809#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006811 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6812 size_t len;
6813
6814 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6816 p + 2, end - (p + 2), &len,
6817 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6818 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6819 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006820 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006822 p += 2 + len;
6823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6825 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006826#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006827#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006829 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6830 size_t zlen;
6831
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6833 p + 2, end - (p + 2),
6834 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6835 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6836 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006837 }
6838
Gilles Peskine449bd832023-01-11 14:50:10 +01006839 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006840 p += 2 + zlen;
6841
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6843 MBEDTLS_DEBUG_ECDH_Z);
6844 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006845#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006846 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6848 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006849 }
6850
6851 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 if (end - p < 2) {
6853 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6854 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006855
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006857 p += 2;
6858
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 if (end < p || (size_t) (end - p) < psk_len) {
6860 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6861 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006862
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006864 p += psk_len;
6865
6866 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6867
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006869}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006870#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006871
6872#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006873MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006874static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006875
6876#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006877int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006878{
6879 /* If renegotiation is not enforced, retransmit until we would reach max
6880 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006882 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6883 unsigned char doublings = 1;
6884
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006886 ++doublings;
6887 ratio >>= 1;
6888 }
6889
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 if (++ssl->renego_records_seen > doublings) {
6891 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6892 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006893 }
6894 }
6895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006897}
6898#endif
6899#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006900
Jerry Yud9526692022-02-17 14:23:47 +08006901/*
6902 * Handshake functions
6903 */
6904#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6905/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006906int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006907{
6908 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6909 ssl->handshake->ciphersuite_info;
6910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006912
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6914 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006915 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006917 }
6918
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6920 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006921}
6922
Gilles Peskine449bd832023-01-11 14:50:10 +01006923int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006924{
6925 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6926 ssl->handshake->ciphersuite_info;
6927
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006929
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6931 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006932 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006934 }
6935
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6937 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006938}
6939
6940#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6941/* Some certificate support -> implement write and parse */
6942
Gilles Peskine449bd832023-01-11 14:50:10 +01006943int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006944{
6945 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6946 size_t i, n;
6947 const mbedtls_x509_crt *crt;
6948 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6949 ssl->handshake->ciphersuite_info;
6950
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006952
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6954 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006955 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006957 }
6958
6959#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6961 if (ssl->handshake->client_auth == 0) {
6962 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006963 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006965 }
6966 }
6967#endif /* MBEDTLS_SSL_CLI_C */
6968#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6970 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006971 /* Should never happen because we shouldn't have picked the
6972 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006974 }
6975 }
6976#endif
6977
Gilles Peskine449bd832023-01-11 14:50:10 +01006978 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006979
6980 /*
6981 * 0 . 0 handshake type
6982 * 1 . 3 handshake length
6983 * 4 . 6 length of all certs
6984 * 7 . 9 length of cert. 1
6985 * 10 . n-1 peer certificate
6986 * n . n+2 length of cert. 2
6987 * n+3 . ... upper level cert, etc.
6988 */
6989 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006990 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006991
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006993 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6995 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6996 " > %" MBEDTLS_PRINTF_SIZET,
6997 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6998 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006999 }
7000
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7002 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7003 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007004
Gilles Peskine449bd832023-01-11 14:50:10 +01007005 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007006 i += n; crt = crt->next;
7007 }
7008
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7010 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7011 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007012
7013 ssl->out_msglen = i;
7014 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7015 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7016
7017 ssl->state++;
7018
Gilles Peskine449bd832023-01-11 14:50:10 +01007019 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7020 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7021 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007022 }
7023
Gilles Peskine449bd832023-01-11 14:50:10 +01007024 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007025
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007027}
7028
7029#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7030
7031#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007032MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007033static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7034 unsigned char *crt_buf,
7035 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007036{
7037 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7038
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 if (peer_crt == NULL) {
7040 return -1;
7041 }
Jerry Yud9526692022-02-17 14:23:47 +08007042
Gilles Peskine449bd832023-01-11 14:50:10 +01007043 if (peer_crt->raw.len != crt_buf_len) {
7044 return -1;
7045 }
Jerry Yud9526692022-02-17 14:23:47 +08007046
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007048}
7049#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007050MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007051static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7052 unsigned char *crt_buf,
7053 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007054{
7055 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7056 unsigned char const * const peer_cert_digest =
7057 ssl->session->peer_cert_digest;
7058 mbedtls_md_type_t const peer_cert_digest_type =
7059 ssl->session->peer_cert_digest_type;
7060 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007062 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7063 size_t digest_len;
7064
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 if (peer_cert_digest == NULL || digest_info == NULL) {
7066 return -1;
7067 }
Jerry Yud9526692022-02-17 14:23:47 +08007068
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 digest_len = mbedtls_md_get_size(digest_info);
7070 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7071 return -1;
7072 }
Jerry Yud9526692022-02-17 14:23:47 +08007073
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7075 if (ret != 0) {
7076 return -1;
7077 }
Jerry Yud9526692022-02-17 14:23:47 +08007078
Gilles Peskine449bd832023-01-11 14:50:10 +01007079 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007080}
7081#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7082#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7083
7084/*
7085 * Once the certificate message is read, parse it into a cert chain and
7086 * perform basic checks, but leave actual verification to the caller
7087 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007088MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007089static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7090 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007091{
7092 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7093#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007095#endif
7096 size_t i, n;
7097 uint8_t alert;
7098
Gilles Peskine449bd832023-01-11 14:50:10 +01007099 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7100 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7101 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7102 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7103 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007104 }
7105
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7107 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7108 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7109 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007110 }
7111
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7113 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7114 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7115 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7116 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007117 }
7118
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007120
7121 /*
7122 * Same message structure as in mbedtls_ssl_write_certificate()
7123 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007124 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007125
Gilles Peskine449bd832023-01-11 14:50:10 +01007126 if (ssl->in_msg[i] != 0 ||
7127 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7128 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7129 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7130 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7131 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007132 }
7133
7134 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7135 i += 3;
7136
7137 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007139 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 if (i + 3 > ssl->in_hslen) {
7141 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7142 mbedtls_ssl_send_alert_message(ssl,
7143 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7144 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7145 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007146 }
7147 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7148 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 if (ssl->in_msg[i] != 0) {
7150 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7151 mbedtls_ssl_send_alert_message(ssl,
7152 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7153 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7154 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007155 }
7156
7157 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007159 | (unsigned int) ssl->in_msg[i + 2];
7160 i += 3;
7161
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 if (n < 128 || i + n > ssl->in_hslen) {
7163 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7164 mbedtls_ssl_send_alert_message(ssl,
7165 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7166 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7167 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007168 }
7169
7170 /* Check if we're handling the first CRT in the chain. */
7171#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007173 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007175 /* During client-side renegotiation, check that the server's
7176 * end-CRTs hasn't changed compared to the initial handshake,
7177 * mitigating the triple handshake attack. On success, reuse
7178 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7180 if (ssl_check_peer_crt_unchanged(ssl,
7181 &ssl->in_msg[i],
7182 n) != 0) {
7183 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7184 mbedtls_ssl_send_alert_message(ssl,
7185 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7186 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7187 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007188 }
7189
7190 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007192 }
7193#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7194
7195 /* Parse the next certificate in the chain. */
7196#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007198#else
7199 /* If we don't need to store the CRT chain permanently, parse
7200 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007202#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007204 case 0: /*ok*/
7205 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7206 /* Ignore certificate with an unknown algorithm: maybe a
7207 prior certificate was already trusted. */
7208 break;
7209
7210 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7211 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7212 goto crt_parse_der_failed;
7213
7214 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7215 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7216 goto crt_parse_der_failed;
7217
7218 default:
7219 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007220crt_parse_der_failed:
7221 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7222 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7223 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007224 }
7225
7226 i += n;
7227 }
7228
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7230 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007231}
7232
7233#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007234MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007235static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007236{
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7238 return -1;
7239 }
Jerry Yud9526692022-02-17 14:23:47 +08007240
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007242 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7243 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007244 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7245 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7246 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007247 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007249}
7250#endif /* MBEDTLS_SSL_SRV_C */
7251
7252/* Check if a certificate message is expected.
7253 * Return either
7254 * - SSL_CERTIFICATE_EXPECTED, or
7255 * - SSL_CERTIFICATE_SKIP
7256 * indicating whether a Certificate message is expected or not.
7257 */
7258#define SSL_CERTIFICATE_EXPECTED 0
7259#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007260MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007261static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7262 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007263{
7264 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7265 ssl->handshake->ciphersuite_info;
7266
Gilles Peskine449bd832023-01-11 14:50:10 +01007267 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7268 return SSL_CERTIFICATE_SKIP;
7269 }
Jerry Yud9526692022-02-17 14:23:47 +08007270
7271#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007272 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7273 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7274 return SSL_CERTIFICATE_SKIP;
7275 }
Jerry Yud9526692022-02-17 14:23:47 +08007276
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007278 ssl->session_negotiate->verify_result =
7279 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007281 }
7282 }
7283#else
7284 ((void) authmode);
7285#endif /* MBEDTLS_SSL_SRV_C */
7286
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007288}
7289
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007290MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007291static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7292 int authmode,
7293 mbedtls_x509_crt *chain,
7294 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007295{
7296 int ret = 0;
7297 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7298 ssl->handshake->ciphersuite_info;
7299 int have_ca_chain = 0;
7300
7301 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7302 void *p_vrfy;
7303
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7305 return 0;
7306 }
Jerry Yud9526692022-02-17 14:23:47 +08007307
Gilles Peskine449bd832023-01-11 14:50:10 +01007308 if (ssl->f_vrfy != NULL) {
7309 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007310 f_vrfy = ssl->f_vrfy;
7311 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007312 } else {
7313 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007314 f_vrfy = ssl->conf->f_vrfy;
7315 p_vrfy = ssl->conf->p_vrfy;
7316 }
7317
7318 /*
7319 * Main check: verify certificate
7320 */
7321#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007323 ((void) rs_ctx);
7324 have_ca_chain = 1;
7325
Gilles Peskine449bd832023-01-11 14:50:10 +01007326 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007327 ret = mbedtls_x509_crt_verify_with_ca_cb(
7328 chain,
7329 ssl->conf->f_ca_cb,
7330 ssl->conf->p_ca_cb,
7331 ssl->conf->cert_profile,
7332 ssl->hostname,
7333 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 f_vrfy, p_vrfy);
7335 } else
Jerry Yud9526692022-02-17 14:23:47 +08007336#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7337 {
7338 mbedtls_x509_crt *ca_chain;
7339 mbedtls_x509_crl *ca_crl;
7340
7341#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007342 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007343 ca_chain = ssl->handshake->sni_ca_chain;
7344 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007345 } else
Jerry Yud9526692022-02-17 14:23:47 +08007346#endif
7347 {
7348 ca_chain = ssl->conf->ca_chain;
7349 ca_crl = ssl->conf->ca_crl;
7350 }
7351
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007353 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 }
Jerry Yud9526692022-02-17 14:23:47 +08007355
7356 ret = mbedtls_x509_crt_verify_restartable(
7357 chain,
7358 ca_chain, ca_crl,
7359 ssl->conf->cert_profile,
7360 ssl->hostname,
7361 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007363 }
7364
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 if (ret != 0) {
7366 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007367 }
7368
7369#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7371 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7372 }
Jerry Yud9526692022-02-17 14:23:47 +08007373#endif
7374
7375 /*
7376 * Secondary checks: always done, but change 'ret' only if it was 0
7377 */
7378
Valerio Setti6c496a12023-04-07 15:53:51 +02007379#if defined(MBEDTLS_ECP_LIGHT)
Jerry Yud9526692022-02-17 14:23:47 +08007380 {
7381 const mbedtls_pk_context *pk = &chain->pk;
7382
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007383 /* If certificate uses an EC key, make sure the curve is OK.
7384 * This is a public key, so it can't be opaque, so can_do() is a good
7385 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007387 /* and in the unlikely case the above assumption no longer holds
7388 * we are making sure that pk_ec() here does not return a NULL
7389 */
Valerio Setti77a75682023-05-15 11:18:46 +02007390 const mbedtls_ecp_keypair *ec = mbedtls_pk_ec_ro(*pk);
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 if (ec == NULL) {
Valerio Setti77a75682023-05-15 11:18:46 +02007392 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_pk_ec_ro() returned NULL"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007393 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007394 }
Jerry Yud9526692022-02-17 14:23:47 +08007395
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 if (mbedtls_ssl_check_curve(ssl, ec->grp.id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007397 ssl->session_negotiate->verify_result |=
7398 MBEDTLS_X509_BADCERT_BAD_KEY;
7399
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7401 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007402 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007404 }
Jerry Yud9526692022-02-17 14:23:47 +08007405 }
7406 }
Valerio Setti6c496a12023-04-07 15:53:51 +02007407#endif /* MBEDTLS_ECP_LIGHT */
Jerry Yud9526692022-02-17 14:23:47 +08007408
Gilles Peskine449bd832023-01-11 14:50:10 +01007409 if (mbedtls_ssl_check_cert_usage(chain,
7410 ciphersuite_info,
7411 !ssl->conf->endpoint,
7412 &ssl->session_negotiate->verify_result) != 0) {
7413 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7414 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007415 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 }
Jerry Yud9526692022-02-17 14:23:47 +08007417 }
7418
7419 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7420 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7421 * with details encoded in the verification flags. All other kinds
7422 * of error codes, including those from the user provided f_vrfy
7423 * functions, are treated as fatal and lead to a failure of
7424 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7426 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7427 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007428 ret = 0;
7429 }
7430
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7432 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007433 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7434 }
7435
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007437 uint8_t alert;
7438
7439 /* The certificate may have been rejected for several reasons.
7440 Pick one and send the corresponding alert. Which alert to send
7441 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007443 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007445 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007447 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007449 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007451 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007453 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007455 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007457 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007459 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007461 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007463 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 }
7465 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7466 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007467 }
7468
7469#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 if (ssl->session_negotiate->verify_result != 0) {
7471 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7472 (unsigned int) ssl->session_negotiate->verify_result));
7473 } else {
7474 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007475 }
7476#endif /* MBEDTLS_DEBUG_C */
7477
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007479}
7480
7481#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007482MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007483static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7484 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007485{
7486 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7487 /* Remember digest of the peer's end-CRT. */
7488 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7490 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7491 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7492 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7493 mbedtls_ssl_send_alert_message(ssl,
7494 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7495 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007496
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007498 }
7499
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 ret = mbedtls_md(mbedtls_md_info_from_type(
7501 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7502 start, len,
7503 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007504
7505 ssl->session_negotiate->peer_cert_digest_type =
7506 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7507 ssl->session_negotiate->peer_cert_digest_len =
7508 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7509
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007511}
7512
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007513MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007514static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7515 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007516{
7517 unsigned char *end = start + len;
7518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7519
7520 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7522 ret = mbedtls_pk_parse_subpubkey(&start, end,
7523 &ssl->handshake->peer_pubkey);
7524 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007525 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007527 }
7528
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007530}
7531#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7532
Gilles Peskine449bd832023-01-11 14:50:10 +01007533int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007534{
7535 int ret = 0;
7536 int crt_expected;
7537#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7538 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7539 ? ssl->handshake->sni_authmode
7540 : ssl->conf->authmode;
7541#else
7542 const int authmode = ssl->conf->authmode;
7543#endif
7544 void *rs_ctx = NULL;
7545 mbedtls_x509_crt *chain = NULL;
7546
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007548
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7550 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7551 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007552 goto exit;
7553 }
7554
7555#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 if (ssl->handshake->ecrs_enabled &&
7557 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007558 chain = ssl->handshake->ecrs_peer_cert;
7559 ssl->handshake->ecrs_peer_cert = NULL;
7560 goto crt_verify;
7561 }
7562#endif
7563
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007565 /* mbedtls_ssl_read_record may have sent an alert already. We
7566 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007567 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007568 goto exit;
7569 }
7570
7571#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007573 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7574
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007576 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 }
Jerry Yud9526692022-02-17 14:23:47 +08007578
7579 goto exit;
7580 }
7581#endif /* MBEDTLS_SSL_SRV_C */
7582
7583 /* Clear existing peer CRT structure in case we tried to
7584 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007586
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7588 if (chain == NULL) {
7589 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7590 sizeof(mbedtls_x509_crt)));
7591 mbedtls_ssl_send_alert_message(ssl,
7592 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7593 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007594
7595 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7596 goto exit;
7597 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007599
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 ret = ssl_parse_certificate_chain(ssl, chain);
7601 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007602 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 }
Jerry Yud9526692022-02-17 14:23:47 +08007604
7605#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007607 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 }
Jerry Yud9526692022-02-17 14:23:47 +08007609
7610crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007612 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 }
Jerry Yud9526692022-02-17 14:23:47 +08007614#endif
7615
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 ret = ssl_parse_certificate_verify(ssl, authmode,
7617 chain, rs_ctx);
7618 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007619 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007620 }
Jerry Yud9526692022-02-17 14:23:47 +08007621
7622#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7623 {
7624 unsigned char *crt_start, *pk_start;
7625 size_t crt_len, pk_len;
7626
7627 /* We parse the CRT chain without copying, so
7628 * these pointers point into the input buffer,
7629 * and are hence still valid after freeing the
7630 * CRT chain. */
7631
7632 crt_start = chain->raw.p;
7633 crt_len = chain->raw.len;
7634
7635 pk_start = chain->pk_raw.p;
7636 pk_len = chain->pk_raw.len;
7637
7638 /* Free the CRT structures before computing
7639 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 mbedtls_x509_crt_free(chain);
7641 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007642 chain = NULL;
7643
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7645 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007646 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 }
Jerry Yud9526692022-02-17 14:23:47 +08007648
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7650 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007651 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 }
Jerry Yud9526692022-02-17 14:23:47 +08007653 }
7654#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7655 /* Pass ownership to session structure. */
7656 ssl->session_negotiate->peer_cert = chain;
7657 chain = NULL;
7658#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7659
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007661
7662exit:
7663
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007665 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 }
Jerry Yud9526692022-02-17 14:23:47 +08007667
7668#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007670 ssl->handshake->ecrs_peer_cert = chain;
7671 chain = NULL;
7672 }
7673#endif
7674
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 if (chain != NULL) {
7676 mbedtls_x509_crt_free(chain);
7677 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007678 }
7679
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007681}
7682#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7683
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007684#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007685static int ssl_calc_finished_tls_sha256(
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007687{
7688 int len = 12;
7689 const char *sender;
7690 unsigned char padbuf[32];
7691#if defined(MBEDTLS_USE_PSA_CRYPTO)
7692 size_t hash_size;
7693 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
7694 psa_status_t status;
7695#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007696 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007697 mbedtls_md_context_t sha256;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007698#endif
7699
7700 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007701 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007702 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007704
Gilles Peskine449bd832023-01-11 14:50:10 +01007705 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007706 ? "client finished"
7707 : "server finished";
7708
7709#if defined(MBEDTLS_USE_PSA_CRYPTO)
7710 sha256_psa = psa_hash_operation_init();
7711
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls sha256"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007713
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 status = psa_hash_clone(&ssl->handshake->fin_sha256_psa, &sha256_psa);
7715 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007716 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007717 }
7718
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 status = psa_hash_finish(&sha256_psa, padbuf, sizeof(padbuf), &hash_size);
7720 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007721 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007722 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, 32);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007724#else
7725
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007726 mbedtls_md_init(&sha256);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007727
Gilles Peskine449bd832023-01-11 14:50:10 +01007728 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls sha256"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007729
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007730 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
7731 if (ret != 0) {
7732 goto exit;
7733 }
7734 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
7735 if (ret != 0) {
7736 goto exit;
7737 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007738
7739 /*
7740 * TLSv1.2:
7741 * hash = PRF( master, finished_label,
7742 * Hash( handshake ) )[0.11]
7743 */
7744
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007745 ret = mbedtls_md_finish(&sha256, padbuf);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007746 if (ret != 0) {
7747 goto exit;
7748 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007749#endif /* MBEDTLS_USE_PSA_CRYPTO */
7750
Manuel Pégourié-Gonnard0ac71c02023-02-24 12:13:55 +01007751 MBEDTLS_SSL_DEBUG_BUF(4, "finished sha256 output", padbuf, 32);
7752
Gilles Peskine449bd832023-01-11 14:50:10 +01007753 ssl->handshake->tls_prf(session->master, 48, sender,
7754 padbuf, 32, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007755
Gilles Peskine449bd832023-01-11 14:50:10 +01007756 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007757
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007759
Gilles Peskine449bd832023-01-11 14:50:10 +01007760 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007761
7762exit:
7763#if defined(MBEDTLS_USE_PSA_CRYPTO)
7764 psa_hash_abort(&sha256_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05007765 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007766#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007767 mbedtls_md_free(&sha256);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007768 return ret;
7769#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007770}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007771#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007772
Jerry Yub7ba49e2022-02-17 14:25:53 +08007773
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007774#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007775static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007776 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007777{
7778 int len = 12;
7779 const char *sender;
7780 unsigned char padbuf[48];
7781#if defined(MBEDTLS_USE_PSA_CRYPTO)
7782 size_t hash_size;
7783 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
7784 psa_status_t status;
7785#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007786 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007787 mbedtls_md_context_t sha384;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007788#endif
7789
7790 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007791 if (!session) {
Jerry Yub7ba49e2022-02-17 14:25:53 +08007792 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007794
Gilles Peskine449bd832023-01-11 14:50:10 +01007795 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007796 ? "client finished"
7797 : "server finished";
7798
7799#if defined(MBEDTLS_USE_PSA_CRYPTO)
7800 sha384_psa = psa_hash_operation_init();
7801
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls sha384"));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007803
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 status = psa_hash_clone(&ssl->handshake->fin_sha384_psa, &sha384_psa);
7805 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007806 goto exit;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007807 }
7808
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 status = psa_hash_finish(&sha384_psa, padbuf, sizeof(padbuf), &hash_size);
7810 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007811 goto exit;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007812 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, 48);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007814#else
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007815 mbedtls_md_init(&sha384);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007816
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls sha384"));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007818
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007819 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007820 if (ret != 0) {
7821 goto exit;
7822 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007823 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007824 if (ret != 0) {
7825 goto exit;
7826 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007827
7828 /*
7829 * TLSv1.2:
7830 * hash = PRF( master, finished_label,
7831 * Hash( handshake ) )[0.11]
7832 */
7833
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007834 ret = mbedtls_md_finish(&sha384, padbuf);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007835 if (ret != 0) {
7836 goto exit;
7837 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007838#endif
7839
Manuel Pégourié-Gonnard0ac71c02023-02-24 12:13:55 +01007840 MBEDTLS_SSL_DEBUG_BUF(4, "finished sha384 output", padbuf, 48);
7841
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 ssl->handshake->tls_prf(session->master, 48, sender,
7843 padbuf, 48, buf, len);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007844
Gilles Peskine449bd832023-01-11 14:50:10 +01007845 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007846
Gilles Peskine449bd832023-01-11 14:50:10 +01007847 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007848
Gilles Peskine449bd832023-01-11 14:50:10 +01007849 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007850
7851exit:
7852#if defined(MBEDTLS_USE_PSA_CRYPTO)
7853 psa_hash_abort(&sha384_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05007854 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007855#else
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007856 mbedtls_md_free(&sha384);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007857 return ret;
7858#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yub7ba49e2022-02-17 14:25:53 +08007859}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007860#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007861
Gilles Peskine449bd832023-01-11 14:50:10 +01007862void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007863{
Gilles Peskine449bd832023-01-11 14:50:10 +01007864 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007865
7866 /*
7867 * Free our handshake params
7868 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007869 mbedtls_ssl_handshake_free(ssl);
7870 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007871 ssl->handshake = NULL;
7872
7873 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007874 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007875 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007876 if (ssl->transform) {
7877 mbedtls_ssl_transform_free(ssl->transform);
7878 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007879 }
7880 ssl->transform = ssl->transform_negotiate;
7881 ssl->transform_negotiate = NULL;
7882
Gilles Peskine449bd832023-01-11 14:50:10 +01007883 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007884}
7885
Gilles Peskine449bd832023-01-11 14:50:10 +01007886void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007887{
7888 int resume = ssl->handshake->resume;
7889
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007891
7892#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007894 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7895 ssl->renego_records_seen = 0;
7896 }
7897#endif
7898
7899 /*
7900 * Free the previous session and switch in the current one
7901 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007902 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007903#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7904 /* RFC 7366 3.1: keep the EtM state */
7905 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007907#endif
7908
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 mbedtls_ssl_session_free(ssl->session);
7910 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007911 }
7912 ssl->session = ssl->session_negotiate;
7913 ssl->session_negotiate = NULL;
7914
7915 /*
7916 * Add cache entry
7917 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007919 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 resume == 0) {
7921 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7922 ssl->session->id,
7923 ssl->session->id_len,
7924 ssl->session) != 0) {
7925 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7926 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007927 }
7928
7929#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7931 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007932 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007934
7935 /* Keep last flight around in case we need to resend it:
7936 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7938 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007939#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007940 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007941
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007942 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007943
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007945}
7946
Gilles Peskine449bd832023-01-11 14:50:10 +01007947int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007948{
7949 int ret, hash_len;
7950
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007952
Gilles Peskine449bd832023-01-11 14:50:10 +01007953 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007954
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007955 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7956 if (ret != 0) {
7957 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7958 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007959
7960 /*
7961 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7962 * may define some other value. Currently (early 2016), no defined
7963 * ciphersuite does this (and this is unlikely to change as activity has
7964 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7965 */
7966 hash_len = 12;
7967
7968#if defined(MBEDTLS_SSL_RENEGOTIATION)
7969 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007971#endif
7972
7973 ssl->out_msglen = 4 + hash_len;
7974 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7975 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7976
7977 /*
7978 * In case of session resuming, invert the client and server
7979 * ChangeCipherSpec messages order.
7980 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007982#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007984 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007985 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007986#endif
7987#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007989 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007991#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007992 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007993 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007995
7996 /*
7997 * Switch to our negotiated transform and session parameters for outbound
7998 * data.
7999 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008001
8002#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008004 unsigned char i;
8005
8006 /* Remember current epoch settings for resending */
8007 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8009 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008010
8011 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008013
8014
8015 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 for (i = 2; i > 0; i--) {
8017 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008018 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 }
8020 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008021
8022 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 if (i == 0) {
8024 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8025 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008026 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008028#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008030
8031 ssl->transform_out = ssl->transform_negotiate;
8032 ssl->session_out = ssl->session_negotiate;
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 mbedtls_ssl_send_flight_completed(ssl);
8037 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008038#endif
8039
Gilles Peskine449bd832023-01-11 14:50:10 +01008040 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8041 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8042 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008043 }
8044
8045#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8047 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8048 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8049 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008050 }
8051#endif
8052
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008054
Gilles Peskine449bd832023-01-11 14:50:10 +01008055 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008056}
8057
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008058#define SSL_MAX_HASH_LEN 12
8059
Gilles Peskine449bd832023-01-11 14:50:10 +01008060int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008061{
8062 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8063 unsigned int hash_len = 12;
8064 unsigned char buf[SSL_MAX_HASH_LEN];
8065
Gilles Peskine449bd832023-01-11 14:50:10 +01008066 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008067
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008068 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8069 if (ret != 0) {
8070 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8071 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008072
Gilles Peskine449bd832023-01-11 14:50:10 +01008073 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8074 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008075 goto exit;
8076 }
8077
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8079 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8080 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8081 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008082 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8083 goto exit;
8084 }
8085
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8087 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8088 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008089 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8090 goto exit;
8091 }
8092
Gilles Peskine449bd832023-01-11 14:50:10 +01008093 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8094 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8095 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8096 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008097 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8098 goto exit;
8099 }
8100
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8102 buf, hash_len) != 0) {
8103 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8104 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8105 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008106 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8107 goto exit;
8108 }
8109
8110#if defined(MBEDTLS_SSL_RENEGOTIATION)
8111 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008112 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008113#endif
8114
Gilles Peskine449bd832023-01-11 14:50:10 +01008115 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008116#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008118 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008119 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008120#endif
8121#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008122 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008123 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008124 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008125#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008126 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008127 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008128 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008129
8130#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008131 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8132 mbedtls_ssl_recv_flight_completed(ssl);
8133 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008134#endif
8135
Gilles Peskine449bd832023-01-11 14:50:10 +01008136 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008137
8138exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008139 mbedtls_platform_zeroize(buf, hash_len);
8140 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008141}
8142
Jerry Yu392112c2022-02-17 14:34:10 +08008143#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8144/*
8145 * Helper to get TLS 1.2 PRF from ciphersuite
8146 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8147 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008148static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008149{
Jerry Yu392112c2022-02-17 14:34:10 +08008150 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008152#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008153 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8154 return tls_prf_sha384;
8155 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008156#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008157#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008158 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008159 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8160 return tls_prf_sha256;
8161 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008162 }
8163#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008164#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8165 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008166 (void) ciphersuite_info;
8167#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008168
Gilles Peskine449bd832023-01-11 14:50:10 +01008169 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008170}
8171#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008172
Gilles Peskine449bd832023-01-11 14:50:10 +01008173static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008174{
8175 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008176#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008177 if (tls_prf == tls_prf_sha384) {
8178 return MBEDTLS_SSL_TLS_PRF_SHA384;
8179 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008180#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008181#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008182 if (tls_prf == tls_prf_sha256) {
8183 return MBEDTLS_SSL_TLS_PRF_SHA256;
8184 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008185#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008186 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008187}
8188
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008189/*
8190 * Populate a transform structure with session keys and all the other
8191 * necessary information.
8192 *
8193 * Parameters:
8194 * - [in/out]: transform: structure to populate
8195 * [in] must be just initialised with mbedtls_ssl_transform_init()
8196 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8197 * - [in] ciphersuite
8198 * - [in] master
8199 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008200 * - [in] tls_prf: pointer to PRF to use for key derivation
8201 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008202 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008203 * - [in] endpoint: client or server
8204 * - [in] ssl: used for:
8205 * - ssl->conf->{f,p}_export_keys
8206 * [in] optionally used for:
8207 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8208 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008209MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008210static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8211 int ciphersuite,
8212 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008213#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008214 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008215#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008216 ssl_tls_prf_t tls_prf,
8217 const unsigned char randbytes[64],
8218 mbedtls_ssl_protocol_version tls_version,
8219 unsigned endpoint,
8220 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008221{
8222 int ret = 0;
8223 unsigned char keyblk[256];
8224 unsigned char *key1;
8225 unsigned char *key2;
8226 unsigned char *mac_enc;
8227 unsigned char *mac_dec;
8228 size_t mac_key_len = 0;
8229 size_t iv_copy_len;
8230 size_t keylen;
8231 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008232 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008233#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008234 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008235 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008236#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008237
8238#if defined(MBEDTLS_USE_PSA_CRYPTO)
8239 psa_key_type_t key_type;
8240 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8241 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008242 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008243 size_t key_bits;
8244 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8245#endif
8246
8247#if !defined(MBEDTLS_DEBUG_C) && \
8248 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008249 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008250 ssl = NULL; /* make sure we don't use it except for these cases */
8251 (void) ssl;
8252 }
8253#endif
8254
8255 /*
8256 * Some data just needs copying into the structure
8257 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008258#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008259 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008260#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008261 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008262
8263#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008264 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008265#endif
8266
8267#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008268 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008269 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8270 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008272 }
8273#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8274
8275 /*
8276 * Get various info structures
8277 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008278 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8279 if (ciphersuite_info == NULL) {
8280 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8281 ciphersuite));
8282 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008283 }
8284
Neil Armstrongab555e02022-04-04 11:07:59 +02008285 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008286#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008287 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008288#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008289 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008290
Gilles Peskine449bd832023-01-11 14:50:10 +01008291 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008292 transform->taglen =
8293 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008294 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008295
8296#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 if ((status = mbedtls_ssl_cipher_to_psa(ciphersuite_info->cipher,
8298 transform->taglen,
8299 &alg,
8300 &key_type,
8301 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008302 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008304 goto end;
8305 }
8306#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 cipher_info = mbedtls_cipher_info_from_type(ciphersuite_info->cipher);
8308 if (cipher_info == NULL) {
8309 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8310 ciphersuite_info->cipher));
8311 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008312 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008313#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008314
Neil Armstronge4512952022-03-08 09:08:22 +01008315#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008316 mac_alg = mbedtls_hash_info_psa_from_md(ciphersuite_info->mac);
8317 if (mac_alg == 0) {
8318 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_hash_info_psa_from_md for %u not found",
8319 (unsigned) ciphersuite_info->mac));
8320 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008321 }
8322#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008323 md_info = mbedtls_md_info_from_type(ciphersuite_info->mac);
8324 if (md_info == NULL) {
8325 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8326 (unsigned) ciphersuite_info->mac));
8327 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008328 }
Neil Armstronge4512952022-03-08 09:08:22 +01008329#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008330
8331#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8332 /* Copy own and peer's CID if the use of the CID
8333 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008334 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8335 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008336
8337 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8339 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8340 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008341
8342 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008343 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8344 ssl->handshake->peer_cid_len);
8345 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8346 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008347 }
8348#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8349
8350 /*
8351 * Compute key block using the PRF
8352 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008353 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8354 if (ret != 0) {
8355 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8356 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008357 }
8358
Gilles Peskine449bd832023-01-11 14:50:10 +01008359 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8360 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8361 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8362 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8363 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008364
8365 /*
8366 * Determine the appropriate key, IV and MAC length.
8367 */
8368
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008369#if defined(MBEDTLS_USE_PSA_CRYPTO)
8370 keylen = PSA_BITS_TO_BYTES(key_bits);
8371#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008372 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008373#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008374
8375#if defined(MBEDTLS_GCM_C) || \
8376 defined(MBEDTLS_CCM_C) || \
8377 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008378 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008379 size_t explicit_ivlen;
8380
8381 transform->maclen = 0;
8382 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008383
8384 /* All modes haves 96-bit IVs, but the length of the static parts vary
8385 * with mode and version:
8386 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8387 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8388 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8389 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8390 * sequence number).
8391 */
8392 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008393
8394 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008395#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008396 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008397#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008398 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8399 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008400#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008401
Gilles Peskine449bd832023-01-11 14:50:10 +01008402 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008403 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008404 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008405 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008406 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008407
8408 /* Minimum length of encrypted record */
8409 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8410 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008411 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008412#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8413#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008414 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008415 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008416 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008417#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008418 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008419#else
8420 size_t block_size = cipher_info->block_size;
8421#endif /* MBEDTLS_USE_PSA_CRYPTO */
8422
8423#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008424 /* Get MAC length */
8425 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8426#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008427 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8429 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8430 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008431 goto end;
8432 }
8433
8434 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008436#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008437 transform->maclen = mac_key_len;
8438
8439 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008440#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008441 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008442#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008443 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008444#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008445
8446 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008447 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008448 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008449 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008450 /*
8451 * GenericBlockCipher:
8452 * 1. if EtM is in use: one block plus MAC
8453 * otherwise: * first multiple of blocklen greater than maclen
8454 * 2. IV
8455 */
8456#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008457 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008458 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 + block_size;
8460 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008461#endif
8462 {
8463 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008464 + block_size
8465 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008466 }
8467
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008469 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008470 } else {
8471 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008472 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8473 goto end;
8474 }
8475 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008477#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8478 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008479 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8480 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008481 }
8482
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8484 (unsigned) keylen,
8485 (unsigned) transform->minlen,
8486 (unsigned) transform->ivlen,
8487 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008488
8489 /*
8490 * Finally setup the cipher contexts, IVs and MAC secrets.
8491 */
8492#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008493 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008494 key1 = keyblk + mac_key_len * 2;
8495 key2 = keyblk + mac_key_len * 2 + keylen;
8496
8497 mac_enc = keyblk;
8498 mac_dec = keyblk + mac_key_len;
8499
Gilles Peskine449bd832023-01-11 14:50:10 +01008500 iv_copy_len = (transform->fixed_ivlen) ?
8501 transform->fixed_ivlen : transform->ivlen;
8502 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8503 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8504 iv_copy_len);
8505 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008506#endif /* MBEDTLS_SSL_CLI_C */
8507#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008508 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008509 key1 = keyblk + mac_key_len * 2 + keylen;
8510 key2 = keyblk + mac_key_len * 2;
8511
8512 mac_enc = keyblk + mac_key_len;
8513 mac_dec = keyblk;
8514
Gilles Peskine449bd832023-01-11 14:50:10 +01008515 iv_copy_len = (transform->fixed_ivlen) ?
8516 transform->fixed_ivlen : transform->ivlen;
8517 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8518 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8519 iv_copy_len);
8520 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008521#endif /* MBEDTLS_SSL_SRV_C */
8522 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008524 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8525 goto end;
8526 }
8527
Gilles Peskine449bd832023-01-11 14:50:10 +01008528 if (ssl != NULL && ssl->f_export_keys != NULL) {
8529 ssl->f_export_keys(ssl->p_export_keys,
8530 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8531 master, 48,
8532 randbytes + 32,
8533 randbytes,
8534 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008535 }
8536
8537#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008538 transform->psa_alg = alg;
8539
Gilles Peskine449bd832023-01-11 14:50:10 +01008540 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8541 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8542 psa_set_key_algorithm(&attributes, alg);
8543 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008544
Gilles Peskine449bd832023-01-11 14:50:10 +01008545 if ((status = psa_import_key(&attributes,
8546 key1,
8547 PSA_BITS_TO_BYTES(key_bits),
8548 &transform->psa_key_enc)) != PSA_SUCCESS) {
8549 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
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
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008556
Gilles Peskine449bd832023-01-11 14:50:10 +01008557 if ((status = psa_import_key(&attributes,
8558 key2,
8559 PSA_BITS_TO_BYTES(key_bits),
8560 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008561 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008563 goto end;
8564 }
8565 }
8566#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008567 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8568 cipher_info)) != 0) {
8569 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008570 goto end;
8571 }
8572
Gilles Peskine449bd832023-01-11 14:50:10 +01008573 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8574 cipher_info)) != 0) {
8575 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008576 goto end;
8577 }
8578
Gilles Peskine449bd832023-01-11 14:50:10 +01008579 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8580 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8581 MBEDTLS_ENCRYPT)) != 0) {
8582 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008583 goto end;
8584 }
8585
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8587 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8588 MBEDTLS_DECRYPT)) != 0) {
8589 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008590 goto end;
8591 }
8592
8593#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8595 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8596 MBEDTLS_PADDING_NONE)) != 0) {
8597 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008598 goto end;
8599 }
8600
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8602 MBEDTLS_PADDING_NONE)) != 0) {
8603 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008604 goto end;
8605 }
8606 }
8607#endif /* MBEDTLS_CIPHER_MODE_CBC */
8608#endif /* MBEDTLS_USE_PSA_CRYPTO */
8609
Neil Armstrong29c0c042022-03-17 17:47:28 +01008610#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8611 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8612 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008613 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008614#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008615 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008616
Gilles Peskine449bd832023-01-11 14:50:10 +01008617 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8618 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8619 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008620
Gilles Peskine449bd832023-01-11 14:50:10 +01008621 if ((status = psa_import_key(&attributes,
8622 mac_enc, mac_key_len,
8623 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008624 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008626 goto end;
8627 }
8628
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8630 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008631#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008632 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008633#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008634 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008635 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008636 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8637 PSA_KEY_USAGE_VERIFY_HASH);
8638 } else {
8639 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8640 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008641
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 if ((status = psa_import_key(&attributes,
8643 mac_dec, mac_key_len,
8644 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008645 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008647 goto end;
8648 }
8649#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008650 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8651 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008652 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008653 }
8654 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8655 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008656 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008657 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008658#endif /* MBEDTLS_USE_PSA_CRYPTO */
8659 }
8660#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8661
8662 ((void) mac_dec);
8663 ((void) mac_enc);
8664
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008665end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008666 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8667 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008668}
8669
Valerio Settia08b1a42022-11-17 15:10:02 +01008670#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8671 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008672int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008673 psa_pake_operation_t *pake_ctx,
8674 const unsigned char *buf,
8675 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008676{
8677 psa_status_t status;
8678 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008679 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008680 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8681 * At round two perform a single cycle
8682 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008683 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008684
Gilles Peskine449bd832023-01-11 14:50:10 +01008685 for (; remaining_steps > 0; remaining_steps--) {
8686 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008687 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008689 /* Length is stored at the first byte */
8690 size_t length = buf[input_offset];
8691 input_offset += 1;
8692
Gilles Peskine449bd832023-01-11 14:50:10 +01008693 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008694 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8695 }
8696
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 status = psa_pake_input(pake_ctx, step,
8698 buf + input_offset, length);
8699 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008700 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008701 }
8702
8703 input_offset += length;
8704 }
8705 }
8706
Gilles Peskine449bd832023-01-11 14:50:10 +01008707 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008708 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008709 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008710
Gilles Peskine449bd832023-01-11 14:50:10 +01008711 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008712}
8713
Valerio Setti6b3dab02022-11-17 17:14:54 +01008714int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008715 psa_pake_operation_t *pake_ctx,
8716 unsigned char *buf,
8717 size_t len, size_t *olen,
8718 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008719{
8720 psa_status_t status;
8721 size_t output_offset = 0;
8722 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008723 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008724 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8725 * At round two perform a single cycle
8726 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008727 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008728
Gilles Peskine449bd832023-01-11 14:50:10 +01008729 for (; remaining_steps > 0; remaining_steps--) {
8730 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8731 step <= PSA_PAKE_STEP_ZK_PROOF;
8732 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008733 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008734 * For each step, prepend 1 byte with the length of the data as
8735 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008736 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008737 status = psa_pake_output(pake_ctx, step,
8738 buf + output_offset + 1,
8739 len - output_offset - 1,
8740 &output_len);
8741 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008742 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008743 }
8744
Valerio Setti99d88c12022-11-22 16:03:43 +01008745 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008746
8747 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008748 }
8749 }
8750
8751 *olen = output_offset;
8752
Gilles Peskine449bd832023-01-11 14:50:10 +01008753 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008754}
Valerio Settia08b1a42022-11-17 15:10:02 +01008755#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8756
Jerry Yuee40f9d2022-02-17 14:55:16 +08008757#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008758int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8759 unsigned char *hash, size_t *hashlen,
8760 unsigned char *data, size_t data_len,
8761 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008762{
8763 psa_status_t status;
8764 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008765 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008766
Gilles Peskine449bd832023-01-11 14:50:10 +01008767 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008768
Gilles Peskine449bd832023-01-11 14:50:10 +01008769 if ((status = psa_hash_setup(&hash_operation,
8770 hash_alg)) != PSA_SUCCESS) {
8771 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008772 goto exit;
8773 }
8774
Gilles Peskine449bd832023-01-11 14:50:10 +01008775 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8776 64)) != PSA_SUCCESS) {
8777 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008778 goto exit;
8779 }
8780
Gilles Peskine449bd832023-01-11 14:50:10 +01008781 if ((status = psa_hash_update(&hash_operation,
8782 data, data_len)) != PSA_SUCCESS) {
8783 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008784 goto exit;
8785 }
8786
Gilles Peskine449bd832023-01-11 14:50:10 +01008787 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8788 hashlen)) != PSA_SUCCESS) {
8789 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8790 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008791 }
8792
8793exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008794 if (status != PSA_SUCCESS) {
8795 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8796 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8797 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008798 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008799 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008800 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8801 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008802 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008803 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008804 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008805 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008806 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008807 }
8808 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008809 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008810}
8811
8812#else
8813
Gilles Peskine449bd832023-01-11 14:50:10 +01008814int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8815 unsigned char *hash, size_t *hashlen,
8816 unsigned char *data, size_t data_len,
8817 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008818{
8819 int ret = 0;
8820 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008821 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8822 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008823
Gilles Peskine449bd832023-01-11 14:50:10 +01008824 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008825
Gilles Peskine449bd832023-01-11 14:50:10 +01008826 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008827
8828 /*
8829 * digitally-signed struct {
8830 * opaque client_random[32];
8831 * opaque server_random[32];
8832 * ServerDHParams params;
8833 * };
8834 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8836 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008837 goto exit;
8838 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008839 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8840 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008841 goto exit;
8842 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008843 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8844 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008845 goto exit;
8846 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008847 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8848 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008849 goto exit;
8850 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008851 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8852 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008853 goto exit;
8854 }
8855
8856exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008857 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008858
Gilles Peskine449bd832023-01-11 14:50:10 +01008859 if (ret != 0) {
8860 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8861 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8862 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008863
Gilles Peskine449bd832023-01-11 14:50:10 +01008864 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008865}
8866#endif /* MBEDTLS_USE_PSA_CRYPTO */
8867
Jerry Yud9d91da2022-02-17 14:57:06 +08008868#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8869
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008870/* Find the preferred hash for a given signature algorithm. */
8871unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008872 mbedtls_ssl_context *ssl,
8873 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008874{
Gabor Mezei078e8032022-04-27 21:17:56 +02008875 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008876 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008877
Gilles Peskine449bd832023-01-11 14:50:10 +01008878 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8879 return MBEDTLS_SSL_HASH_NONE;
8880 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008881
Gilles Peskine449bd832023-01-11 14:50:10 +01008882 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008883 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008884 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8885 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008886 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008887 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8888 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008889
Gilles Peskine449bd832023-01-11 14:50:10 +01008890 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008891#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008892 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008893 psa_algorithm_t psa_hash_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +01008894 mbedtls_hash_info_psa_from_md(hash_alg_received);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008895
Gilles Peskine449bd832023-01-11 14:50:10 +01008896 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8897 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8898 PSA_ALG_ECDSA(psa_hash_alg),
8899 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008900 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008901 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008902
Gilles Peskine449bd832023-01-11 14:50:10 +01008903 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8904 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8905 PSA_ALG_RSA_PKCS1V15_SIGN(
8906 psa_hash_alg),
8907 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008908 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008909 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008910 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008911#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008912
Gilles Peskine449bd832023-01-11 14:50:10 +01008913 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008914 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008915 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008916
Gilles Peskine449bd832023-01-11 14:50:10 +01008917 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008918}
8919
8920#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8921
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008922/* Serialization of TLS 1.2 sessions:
8923 *
8924 * struct {
8925 * uint64 start_time;
8926 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008927 * uint8 session_id_len; // at most 32
8928 * opaque session_id[32];
8929 * opaque master[48]; // fixed length in the standard
8930 * uint32 verify_result;
8931 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8932 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8933 * uint32 ticket_lifetime;
8934 * uint8 mfl_code; // up to 255 according to standard
8935 * uint8 encrypt_then_mac; // 0 or 1
8936 * } serialized_session_tls12;
8937 *
8938 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008939static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8940 unsigned char *buf,
8941 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008942{
8943 unsigned char *p = buf;
8944 size_t used = 0;
8945
8946#if defined(MBEDTLS_HAVE_TIME)
8947 uint64_t start;
8948#endif
8949#if defined(MBEDTLS_X509_CRT_PARSE_C)
8950#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8951 size_t cert_len;
8952#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8953#endif /* MBEDTLS_X509_CRT_PARSE_C */
8954
8955 /*
8956 * Time
8957 */
8958#if defined(MBEDTLS_HAVE_TIME)
8959 used += 8;
8960
Gilles Peskine449bd832023-01-11 14:50:10 +01008961 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008962 start = (uint64_t) session->start;
8963
Gilles Peskine449bd832023-01-11 14:50:10 +01008964 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008965 p += 8;
8966 }
8967#endif /* MBEDTLS_HAVE_TIME */
8968
8969 /*
8970 * Basic mandatory fields
8971 */
8972 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008973 + 1 /* id_len */
8974 + sizeof(session->id)
8975 + sizeof(session->master)
8976 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008977
Gilles Peskine449bd832023-01-11 14:50:10 +01008978 if (used <= buf_len) {
8979 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008980 p += 2;
8981
Gilles Peskine449bd832023-01-11 14:50:10 +01008982 *p++ = MBEDTLS_BYTE_0(session->id_len);
8983 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008984 p += 32;
8985
Gilles Peskine449bd832023-01-11 14:50:10 +01008986 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008987 p += 48;
8988
Gilles Peskine449bd832023-01-11 14:50:10 +01008989 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008990 p += 4;
8991 }
8992
8993 /*
8994 * Peer's end-entity certificate
8995 */
8996#if defined(MBEDTLS_X509_CRT_PARSE_C)
8997#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008998 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008999 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01009000 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009001 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009002 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009003
9004 used += 3 + cert_len;
9005
Gilles Peskine449bd832023-01-11 14:50:10 +01009006 if (used <= buf_len) {
9007 *p++ = MBEDTLS_BYTE_2(cert_len);
9008 *p++ = MBEDTLS_BYTE_1(cert_len);
9009 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009010
Gilles Peskine449bd832023-01-11 14:50:10 +01009011 if (session->peer_cert != NULL) {
9012 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009013 p += cert_len;
9014 }
9015 }
9016#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009018 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009020 *p++ = (unsigned char) session->peer_cert_digest_type;
9021 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009022 memcpy(p, session->peer_cert_digest,
9023 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009024 p += session->peer_cert_digest_len;
9025 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009026 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009027 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009028 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009029 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9030 *p++ = 0;
9031 }
9032 }
9033#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9034#endif /* MBEDTLS_X509_CRT_PARSE_C */
9035
9036 /*
9037 * Session ticket if any, plus associated data
9038 */
9039#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9040 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9041
Gilles Peskine449bd832023-01-11 14:50:10 +01009042 if (used <= buf_len) {
9043 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9044 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9045 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009046
Gilles Peskine449bd832023-01-11 14:50:10 +01009047 if (session->ticket != NULL) {
9048 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009049 p += session->ticket_len;
9050 }
9051
Gilles Peskine449bd832023-01-11 14:50:10 +01009052 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009053 p += 4;
9054 }
9055#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9056
9057 /*
9058 * Misc extension-related info
9059 */
9060#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9061 used += 1;
9062
Gilles Peskine449bd832023-01-11 14:50:10 +01009063 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009064 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009065 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009066#endif
9067
9068#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9069 used += 1;
9070
Gilles Peskine449bd832023-01-11 14:50:10 +01009071 if (used <= buf_len) {
9072 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9073 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009074#endif
9075
Gilles Peskine449bd832023-01-11 14:50:10 +01009076 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009077}
9078
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009079MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009080static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9081 const unsigned char *buf,
9082 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009083{
9084#if defined(MBEDTLS_HAVE_TIME)
9085 uint64_t start;
9086#endif
9087#if defined(MBEDTLS_X509_CRT_PARSE_C)
9088#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9089 size_t cert_len;
9090#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9091#endif /* MBEDTLS_X509_CRT_PARSE_C */
9092
9093 const unsigned char *p = buf;
9094 const unsigned char * const end = buf + len;
9095
9096 /*
9097 * Time
9098 */
9099#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009100 if (8 > (size_t) (end - p)) {
9101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9102 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009103
Gilles Peskine449bd832023-01-11 14:50:10 +01009104 start = ((uint64_t) p[0] << 56) |
9105 ((uint64_t) p[1] << 48) |
9106 ((uint64_t) p[2] << 40) |
9107 ((uint64_t) p[3] << 32) |
9108 ((uint64_t) p[4] << 24) |
9109 ((uint64_t) p[5] << 16) |
9110 ((uint64_t) p[6] << 8) |
9111 ((uint64_t) p[7]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009112 p += 8;
9113
9114 session->start = (time_t) start;
9115#endif /* MBEDTLS_HAVE_TIME */
9116
9117 /*
9118 * Basic mandatory fields
9119 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009120 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9122 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009123
Gilles Peskine449bd832023-01-11 14:50:10 +01009124 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009125 p += 2;
9126
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009127 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009128 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009129 p += 32;
9130
Gilles Peskine449bd832023-01-11 14:50:10 +01009131 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009132 p += 48;
9133
Gilles Peskine449bd832023-01-11 14:50:10 +01009134 session->verify_result = ((uint32_t) p[0] << 24) |
9135 ((uint32_t) p[1] << 16) |
9136 ((uint32_t) p[2] << 8) |
9137 ((uint32_t) p[3]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009138 p += 4;
9139
9140 /* Immediately clear invalid pointer values that have been read, in case
9141 * we exit early before we replaced them with valid ones. */
9142#if defined(MBEDTLS_X509_CRT_PARSE_C)
9143#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9144 session->peer_cert = NULL;
9145#else
9146 session->peer_cert_digest = NULL;
9147#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9148#endif /* MBEDTLS_X509_CRT_PARSE_C */
9149#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9150 session->ticket = NULL;
9151#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9152
9153 /*
9154 * Peer certificate
9155 */
9156#if defined(MBEDTLS_X509_CRT_PARSE_C)
9157#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9158 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009159 if (3 > (size_t) (end - p)) {
9160 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9161 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009162
Gilles Peskine449bd832023-01-11 14:50:10 +01009163 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009164 p += 3;
9165
Gilles Peskine449bd832023-01-11 14:50:10 +01009166 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009167 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9168
Gilles Peskine449bd832023-01-11 14:50:10 +01009169 if (cert_len > (size_t) (end - p)) {
9170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9171 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009172
Gilles Peskine449bd832023-01-11 14:50:10 +01009173 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009174
Gilles Peskine449bd832023-01-11 14:50:10 +01009175 if (session->peer_cert == NULL) {
9176 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9177 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009178
Gilles Peskine449bd832023-01-11 14:50:10 +01009179 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009180
Gilles Peskine449bd832023-01-11 14:50:10 +01009181 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9182 p, cert_len)) != 0) {
9183 mbedtls_x509_crt_free(session->peer_cert);
9184 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009185 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009186 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009187 }
9188
9189 p += cert_len;
9190 }
9191#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9192 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009193 if (2 > (size_t) (end - p)) {
9194 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9195 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009196
9197 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9198 session->peer_cert_digest_len = (size_t) *p++;
9199
Gilles Peskine449bd832023-01-11 14:50:10 +01009200 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009201 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9203 if (md_info == NULL) {
9204 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9205 }
9206 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9207 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9208 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009209
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9211 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9212 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009213
9214 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009215 mbedtls_calloc(1, session->peer_cert_digest_len);
9216 if (session->peer_cert_digest == NULL) {
9217 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9218 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009219
Gilles Peskine449bd832023-01-11 14:50:10 +01009220 memcpy(session->peer_cert_digest, p,
9221 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009222 p += session->peer_cert_digest_len;
9223 }
9224#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9225#endif /* MBEDTLS_X509_CRT_PARSE_C */
9226
9227 /*
9228 * Session ticket and associated data
9229 */
9230#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009231 if (3 > (size_t) (end - p)) {
9232 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9233 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009234
Gilles Peskine449bd832023-01-11 14:50:10 +01009235 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009236 p += 3;
9237
Gilles Peskine449bd832023-01-11 14:50:10 +01009238 if (session->ticket_len != 0) {
9239 if (session->ticket_len > (size_t) (end - p)) {
9240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9241 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009242
Gilles Peskine449bd832023-01-11 14:50:10 +01009243 session->ticket = mbedtls_calloc(1, session->ticket_len);
9244 if (session->ticket == NULL) {
9245 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9246 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009247
Gilles Peskine449bd832023-01-11 14:50:10 +01009248 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009249 p += session->ticket_len;
9250 }
9251
Gilles Peskine449bd832023-01-11 14:50:10 +01009252 if (4 > (size_t) (end - p)) {
9253 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9254 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009255
Gilles Peskine449bd832023-01-11 14:50:10 +01009256 session->ticket_lifetime = ((uint32_t) p[0] << 24) |
9257 ((uint32_t) p[1] << 16) |
9258 ((uint32_t) p[2] << 8) |
9259 ((uint32_t) p[3]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009260 p += 4;
9261#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9262
9263 /*
9264 * Misc extension-related info
9265 */
9266#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009267 if (1 > (size_t) (end - p)) {
9268 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9269 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009270
9271 session->mfl_code = *p++;
9272#endif
9273
9274#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009275 if (1 > (size_t) (end - p)) {
9276 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9277 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009278
9279 session->encrypt_then_mac = *p++;
9280#endif
9281
9282 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009283 if (p != end) {
9284 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9285 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009286
Gilles Peskine449bd832023-01-11 14:50:10 +01009287 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009288}
Jerry Yudc7bd172022-02-17 13:44:15 +08009289#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9290
XiaokangQian75d40ef2022-04-20 11:05:24 +00009291int mbedtls_ssl_validate_ciphersuite(
9292 const mbedtls_ssl_context *ssl,
9293 const mbedtls_ssl_ciphersuite_t *suite_info,
9294 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009295 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009296{
9297 (void) ssl;
9298
Gilles Peskine449bd832023-01-11 14:50:10 +01009299 if (suite_info == NULL) {
9300 return -1;
9301 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009302
Gilles Peskine449bd832023-01-11 14:50:10 +01009303 if ((suite_info->min_tls_version > max_tls_version) ||
9304 (suite_info->max_tls_version < min_tls_version)) {
9305 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009306 }
9307
XiaokangQian060d8672022-04-21 09:24:56 +00009308#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009309#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009310#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009311 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9312 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009313#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009314 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9315 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009316#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009317 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009318 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009319 }
9320#endif
9321
9322 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9323#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009324 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9325 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9326 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009327 }
9328#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9329#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9330
Gilles Peskine449bd832023-01-11 14:50:10 +01009331 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009332}
9333
Ronald Crone68ab4f2022-10-05 12:46:29 +02009334#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009335/*
9336 * Function for writing a signature algorithm extension.
9337 *
9338 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9339 * value (TLS 1.3 RFC8446):
9340 * enum {
9341 * ....
9342 * ecdsa_secp256r1_sha256( 0x0403 ),
9343 * ecdsa_secp384r1_sha384( 0x0503 ),
9344 * ecdsa_secp521r1_sha512( 0x0603 ),
9345 * ....
9346 * } SignatureScheme;
9347 *
9348 * struct {
9349 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9350 * } SignatureSchemeList;
9351 *
9352 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9353 * value (TLS 1.2 RFC5246):
9354 * enum {
9355 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9356 * sha512(6), (255)
9357 * } HashAlgorithm;
9358 *
9359 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9360 * SignatureAlgorithm;
9361 *
9362 * struct {
9363 * HashAlgorithm hash;
9364 * SignatureAlgorithm signature;
9365 * } SignatureAndHashAlgorithm;
9366 *
9367 * SignatureAndHashAlgorithm
9368 * supported_signature_algorithms<2..2^16-2>;
9369 *
9370 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9371 * generalization of the TLS 1.2 signature algorithm extension.
9372 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9373 * `SignatureScheme` field of TLS 1.3
9374 *
9375 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009376int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9377 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009378{
9379 unsigned char *p = buf;
9380 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9381 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9382
9383 *out_len = 0;
9384
Gilles Peskine449bd832023-01-11 14:50:10 +01009385 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009386
9387 /* Check if we have space for header and length field:
9388 * - extension_type (2 bytes)
9389 * - extension_data_length (2 bytes)
9390 * - supported_signature_algorithms_length (2 bytes)
9391 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009392 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009393 p += 6;
9394
9395 /*
9396 * Write supported_signature_algorithms
9397 */
9398 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009399 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9400 if (sig_alg == NULL) {
9401 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9402 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009403
Gilles Peskine449bd832023-01-11 14:50:10 +01009404 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9405 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9406 *sig_alg,
9407 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9408 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009409 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009410 }
9411 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9412 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009413 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009414 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9415 *sig_alg,
9416 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009417 }
9418
9419 /* Length of supported_signature_algorithms */
9420 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009421 if (supported_sig_alg_len == 0) {
9422 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9423 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009424 }
9425
Gilles Peskine449bd832023-01-11 14:50:10 +01009426 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9427 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9428 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009429
XiaokangQianeaf36512022-04-24 09:07:44 +00009430 *out_len = p - buf;
9431
9432#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009433 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009434#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009435
Gilles Peskine449bd832023-01-11 14:50:10 +01009436 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009437}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009438#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009439
XiaokangQian40a35232022-05-07 09:02:40 +00009440#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009441/*
9442 * mbedtls_ssl_parse_server_name_ext
9443 *
9444 * Structure of server_name extension:
9445 *
9446 * enum {
9447 * host_name(0), (255)
9448 * } NameType;
9449 * opaque HostName<1..2^16-1>;
9450 *
9451 * struct {
9452 * NameType name_type;
9453 * select (name_type) {
9454 * case host_name: HostName;
9455 * } name;
9456 * } ServerName;
9457 * struct {
9458 * ServerName server_name_list<1..2^16-1>
9459 * } ServerNameList;
9460 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009461MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009462int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9463 const unsigned char *buf,
9464 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009465{
9466 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9467 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009468 size_t server_name_list_len, hostname_len;
9469 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009470
Gilles Peskine449bd832023-01-11 14:50:10 +01009471 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009472
Gilles Peskine449bd832023-01-11 14:50:10 +01009473 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9474 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009475 p += 2;
9476
Gilles Peskine449bd832023-01-11 14:50:10 +01009477 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009478 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009479 while (p < server_name_list_end) {
9480 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9481 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9482 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9483 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009484
Gilles Peskine449bd832023-01-11 14:50:10 +01009485 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009486 /* sni_name is intended to be used only during the parsing of the
9487 * ClientHello message (it is reset to NULL before the end of
9488 * the message parsing). Thus it is ok to just point to the
9489 * reception buffer and not make a copy of it.
9490 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009491 ssl->handshake->sni_name = p + 3;
9492 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009493 if (ssl->conf->f_sni == NULL) {
9494 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009495 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009496 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9497 ssl, p + 3, hostname_len);
9498 if (ret != 0) {
9499 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9500 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9501 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9502 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9503 }
9504 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009505 }
9506
9507 p += hostname_len + 3;
9508 }
9509
Gilles Peskine449bd832023-01-11 14:50:10 +01009510 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009511}
9512#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9513
XiaokangQianacb39922022-06-17 10:18:48 +00009514#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009515MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009516int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9517 const unsigned char *buf,
9518 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009519{
9520 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009521 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009522 const unsigned char *protocol_name_list;
9523 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009524 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009525
9526 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009527 if (ssl->conf->alpn_list == NULL) {
9528 return 0;
9529 }
XiaokangQianacb39922022-06-17 10:18:48 +00009530
9531 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009532 * RFC7301, section 3.1
9533 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009534 *
XiaokangQianc7403452022-06-23 03:24:12 +00009535 * struct {
9536 * ProtocolName protocol_name_list<2..2^16-1>
9537 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009538 */
9539
XiaokangQianc7403452022-06-23 03:24:12 +00009540 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009541 * protocol_name_list_len 2 bytes
9542 * protocol_name_len 1 bytes
9543 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009544 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009545 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009546
Gilles Peskine449bd832023-01-11 14:50:10 +01009547 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009548 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009549 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009550 protocol_name_list = p;
9551 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009552
9553 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009554 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009555 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009556 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9557 protocol_name_len);
9558 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009559 MBEDTLS_SSL_PEND_FATAL_ALERT(
9560 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009561 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9562 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009563 }
9564
9565 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009566 }
9567
9568 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9570 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009571 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009572 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009573 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009574 if (protocol_name_len == alpn_len &&
9575 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009576 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009577 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009578 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009579
9580 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009581 }
9582 }
9583
XiaokangQian95d5f542022-06-24 02:29:26 +00009584 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009585 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009586 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9587 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9588 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009589}
9590
Gilles Peskine449bd832023-01-11 14:50:10 +01009591int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9592 unsigned char *buf,
9593 unsigned char *end,
9594 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009595{
9596 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009597 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009598 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009599
Gilles Peskine449bd832023-01-11 14:50:10 +01009600 if (ssl->alpn_chosen == NULL) {
9601 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009602 }
9603
Gilles Peskine449bd832023-01-11 14:50:10 +01009604 protocol_name_len = strlen(ssl->alpn_chosen);
9605 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009606
Gilles Peskine449bd832023-01-11 14:50:10 +01009607 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009608 /*
9609 * 0 . 1 ext identifier
9610 * 2 . 3 ext length
9611 * 4 . 5 protocol list length
9612 * 6 . 6 protocol name length
9613 * 7 . 7+n protocol name
9614 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009615 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009616
XiaokangQian95d5f542022-06-24 02:29:26 +00009617 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009618
Gilles Peskine449bd832023-01-11 14:50:10 +01009619 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9620 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009621 /* Note: the length of the chosen protocol has been checked to be less
9622 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9623 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009624 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009625
Gilles Peskine449bd832023-01-11 14:50:10 +01009626 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009627
9628#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009629 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009630#endif
9631
Gilles Peskine449bd832023-01-11 14:50:10 +01009632 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009633}
9634#endif /* MBEDTLS_SSL_ALPN */
9635
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009636#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009637 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009638 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009639 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009640int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9641 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009642{
9643 /* Initialize to suppress unnecessary compiler warning */
9644 size_t hostname_len = 0;
9645
9646 /* Check if new hostname is valid before
9647 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009648 if (hostname != NULL) {
9649 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009650
Gilles Peskine449bd832023-01-11 14:50:10 +01009651 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9652 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9653 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009654 }
9655
9656 /* Now it's clear that we will overwrite the old hostname,
9657 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009658 if (session->hostname != NULL) {
9659 mbedtls_platform_zeroize(session->hostname,
9660 strlen(session->hostname));
9661 mbedtls_free(session->hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009662 }
9663
9664 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009665 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009666 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009667 } else {
9668 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9669 if (session->hostname == NULL) {
9670 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9671 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009672
Gilles Peskine449bd832023-01-11 14:50:10 +01009673 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009674 }
9675
Gilles Peskine449bd832023-01-11 14:50:10 +01009676 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009677}
Xiaokang Qian03409292022-10-12 02:49:52 +00009678#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9679 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009680 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009681 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009682
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009683#endif /* MBEDTLS_SSL_TLS_C */