blob: ad019b1cc750fadb861c557c6da96695f90af06e [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 */
1151#if defined(MBEDTLS_ECP_C)
1152#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
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE) &&
1159 (length < MBEDTLS_ECP_DP_MAX); length++) {
1160 }
Brett Warrene0edc842021-08-17 09:53:13 +01001161
1162 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001163 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1164 if (group_list == NULL) {
1165 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1166 }
Brett Warrene0edc842021-08-17 09:53:13 +01001167
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001169 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 curve_list[i]);
1171 if (tls_id == 0) {
1172 mbedtls_free(group_list);
1173 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001174 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001175 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001176 }
1177
1178 group_list[length] = 0;
1179
1180 ssl->handshake->group_list = group_list;
1181 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001183 ssl->handshake->group_list = ssl->conf->group_list;
1184 ssl->handshake->group_list_heap_allocated = 0;
1185 }
1186#endif /* MBEDTLS_DEPRECATED_REMOVED */
1187#endif /* MBEDTLS_ECP_C */
1188
Ronald Crone68ab4f2022-10-05 12:46:29 +02001189#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001190#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001191#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001192 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1193 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1195 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001196 const int *md;
1197 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001198 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001199 uint16_t *p;
1200
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001201 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1202 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1203 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001204
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1206 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001207 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 }
Valerio Setti75fba322023-02-23 17:35:09 +01001209#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001211#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001212
Jerry Yub476a442022-01-21 18:14:45 +08001213#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001215#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1217 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1218 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001219 }
1220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1222 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1223 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001224
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1226 sizeof(uint16_t));
1227 if (ssl->handshake->sig_algs == NULL) {
1228 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1229 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001230
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 p = (uint16_t *) ssl->handshake->sig_algs;
1232 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1233 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1234 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001235 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 }
Valerio Setti75fba322023-02-23 17:35:09 +01001237#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001240#endif
1241#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001243 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001244#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001245 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001246 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001247 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001249#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001250 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001251 ssl->handshake->sig_algs_heap_allocated = 0;
1252 }
Jerry Yucc539102022-06-27 16:27:35 +08001253#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001254#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001255 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001256}
1257
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001258#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001259/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001260MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001261static int ssl_cookie_write_dummy(void *ctx,
1262 unsigned char **p, unsigned char *end,
1263 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001264{
1265 ((void) ctx);
1266 ((void) p);
1267 ((void) end);
1268 ((void) cli_id);
1269 ((void) cli_id_len);
1270
Gilles Peskine449bd832023-01-11 14:50:10 +01001271 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001272}
1273
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001274MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001275static int ssl_cookie_check_dummy(void *ctx,
1276 const unsigned char *cookie, size_t cookie_len,
1277 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001278{
1279 ((void) ctx);
1280 ((void) cookie);
1281 ((void) cookie_len);
1282 ((void) cli_id);
1283 ((void) cli_id_len);
1284
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001286}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001287#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001288
Paul Bakker5121ce52009-01-03 21:22:43 +00001289/*
1290 * Initialize an SSL context
1291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001292void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001293{
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001295}
1296
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001297MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001298static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001299{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001300 const mbedtls_ssl_config *conf = ssl->conf;
1301
Ronald Cron6f135e12021-12-08 16:57:54 +01001302#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1304 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1305 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1306 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001307 }
1308
Gilles Peskine449bd832023-01-11 14:50:10 +01001309 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1310 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001311 }
1312#endif
1313
1314#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1316 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1317 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001318 }
1319#endif
1320
Ronald Cron6f135e12021-12-08 16:57:54 +01001321#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1323 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1324 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1325 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001326 }
1327
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 if (conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
1329 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS 1.3 server is not supported yet."));
1330 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian8f9dfe42022-04-15 02:52:39 +00001331 }
1332
1333
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1335 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001336 }
1337#endif
1338
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1340 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001341}
1342
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001343MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001344static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1345{
1346 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 ret = ssl_conf_version_check(ssl);
1348 if (ret != 0) {
1349 return ret;
1350 }
Jerry Yu60835a82021-08-04 10:13:52 +08001351
Jerry Yudef7ae42022-10-30 14:13:19 +08001352#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1353 /* RFC 8446 section 4.4.3
1354 *
1355 * If the verification fails, the receiver MUST terminate the handshake with
1356 * a "decrypt_error" alert.
1357 *
1358 * If the client is configured as TLS 1.3 only with optional verify, return
1359 * bad config.
1360 *
1361 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1363 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001364 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1365 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1366 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001367 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001368 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001369 1, ("Optional verify auth mode "
1370 "is not available for TLS 1.3 client"));
1371 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001372 }
1373#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1374
Jerry Yu60835a82021-08-04 10:13:52 +08001375 /* Space for further checks */
1376
Gilles Peskine449bd832023-01-11 14:50:10 +01001377 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001378}
1379
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001380/*
1381 * Setup an SSL context
1382 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001383
Gilles Peskine449bd832023-01-11 14:50:10 +01001384int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1385 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001386{
Janos Follath865b3eb2019-12-16 11:46:15 +00001387 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001388 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1389 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001390
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001391 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001392
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 if ((ret = ssl_conf_check(ssl)) != 0) {
1394 return ret;
1395 }
Jerry Yu60835a82021-08-04 10:13:52 +08001396
Paul Bakker62f2dee2012-09-28 07:31:51 +00001397 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001398 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001399 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001400
1401 /* Set to NULL in case of an error condition */
1402 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001403
Darryl Greenb33cc762019-11-28 14:29:44 +00001404#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1405 ssl->in_buf_len = in_buf_len;
1406#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001407 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1408 if (ssl->in_buf == NULL) {
1409 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001410 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001411 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001412 }
1413
Darryl Greenb33cc762019-11-28 14:29:44 +00001414#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1415 ssl->out_buf_len = out_buf_len;
1416#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1418 if (ssl->out_buf == NULL) {
1419 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001420 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001421 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001422 }
1423
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001425
Johan Pascalb62bb512015-12-03 21:56:45 +01001426#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001428#endif
1429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001431 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001433
Gilles Peskine449bd832023-01-11 14:50:10 +01001434 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001435
1436error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 mbedtls_free(ssl->in_buf);
1438 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001439
1440 ssl->conf = NULL;
1441
Darryl Greenb33cc762019-11-28 14:29:44 +00001442#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1443 ssl->in_buf_len = 0;
1444 ssl->out_buf_len = 0;
1445#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001446 ssl->in_buf = NULL;
1447 ssl->out_buf = NULL;
1448
1449 ssl->in_hdr = NULL;
1450 ssl->in_ctr = NULL;
1451 ssl->in_len = NULL;
1452 ssl->in_iv = NULL;
1453 ssl->in_msg = NULL;
1454
1455 ssl->out_hdr = NULL;
1456 ssl->out_ctr = NULL;
1457 ssl->out_len = NULL;
1458 ssl->out_iv = NULL;
1459 ssl->out_msg = NULL;
1460
Gilles Peskine449bd832023-01-11 14:50:10 +01001461 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001462}
1463
1464/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001465 * Reset an initialized and used SSL context for re-use while retaining
1466 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001467 *
1468 * If partial is non-zero, keep data in the input buffer and client ID.
1469 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1472 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001473{
Darryl Greenb33cc762019-11-28 14:29:44 +00001474#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1475 size_t in_buf_len = ssl->in_buf_len;
1476 size_t out_buf_len = ssl->out_buf_len;
1477#else
1478 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1479 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1480#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001481
Hanno Beckerb0302c42021-08-03 09:39:42 +01001482#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1483 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001484#endif
1485
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001486 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001488
Gilles Peskine449bd832023-01-11 14:50:10 +01001489 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001490
1491 /* Reset incoming message parsing */
1492 ssl->in_offt = NULL;
1493 ssl->nb_zero = 0;
1494 ssl->in_msgtype = 0;
1495 ssl->in_msglen = 0;
1496 ssl->in_hslen = 0;
1497 ssl->keep_current_message = 0;
1498 ssl->transform_in = NULL;
1499
1500#if defined(MBEDTLS_SSL_PROTO_DTLS)
1501 ssl->next_record_offset = 0;
1502 ssl->in_epoch = 0;
1503#endif
1504
1505 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001507 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001508 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001509 }
1510
Ronald Cronad8c17b2022-06-10 17:18:09 +02001511 ssl->send_alert = 0;
1512
Hanno Beckerb0302c42021-08-03 09:39:42 +01001513 /* Reset outgoing message writing */
1514 ssl->out_msgtype = 0;
1515 ssl->out_msglen = 0;
1516 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 memset(ssl->out_buf, 0, out_buf_len);
1518 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001519 ssl->transform_out = NULL;
1520
1521#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001523#endif
1524
XiaokangQian2b01dc32022-01-21 02:53:13 +00001525#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 if (ssl->transform) {
1527 mbedtls_ssl_transform_free(ssl->transform);
1528 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001529 ssl->transform = NULL;
1530 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1532
XiaokangQian2b01dc32022-01-21 02:53:13 +00001533#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 mbedtls_ssl_transform_free(ssl->transform_application);
1535 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001536 ssl->transform_application = NULL;
1537
Gilles Peskine449bd832023-01-11 14:50:10 +01001538 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001539#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1541 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001542 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001543#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001544
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1546 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001547 ssl->handshake->transform_handshake = NULL;
1548 }
1549
XiaokangQian2b01dc32022-01-21 02:53:13 +00001550#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001551}
1552
Gilles Peskine449bd832023-01-11 14:50:10 +01001553int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001554{
1555 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1556
1557 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1558
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001560
1561 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001562#if defined(MBEDTLS_SSL_RENEGOTIATION)
1563 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001564 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001565
1566 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001567 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1568 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001569#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001571
Hanno Beckerb0302c42021-08-03 09:39:42 +01001572 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001573 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001574 if (ssl->session) {
1575 mbedtls_ssl_session_free(ssl->session);
1576 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001577 ssl->session = NULL;
1578 }
1579
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001580#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001581 ssl->alpn_chosen = NULL;
1582#endif
1583
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001584#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001585 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001586#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001588#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 if (free_cli_id) {
1590 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001591 ssl->cli_id = NULL;
1592 ssl->cli_id_len = 0;
1593 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001594#endif
1595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 if ((ret = ssl_handshake_init(ssl)) != 0) {
1597 return ret;
1598 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001599
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001601}
1602
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001603/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001604 * Reset an initialized and used SSL context for re-use while retaining
1605 * all application-set variables, function pointers and data.
1606 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001607int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001608{
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001610}
1611
1612/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001613 * SSL set accessors
1614 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001615void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001616{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001617 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001618}
1619
Gilles Peskine449bd832023-01-11 14:50:10 +01001620void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001621{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001622 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001623}
1624
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001625#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001626void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001627{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001628 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001629}
1630#endif
1631
Gilles Peskine449bd832023-01-11 14:50:10 +01001632void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001633{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001634 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001635}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001636
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001637#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001638
Gilles Peskine449bd832023-01-11 14:50:10 +01001639void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1640 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001641{
1642 ssl->disable_datagram_packing = !allow_packing;
1643}
1644
Gilles Peskine449bd832023-01-11 14:50:10 +01001645void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1646 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001647{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001648 conf->hs_timeout_min = min;
1649 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001650}
1651#endif
1652
Gilles Peskine449bd832023-01-11 14:50:10 +01001653void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001654{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001655 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001656}
1657
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001658#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001659void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1660 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1661 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001662{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001663 conf->f_vrfy = f_vrfy;
1664 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001665}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001666#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001667
Gilles Peskine449bd832023-01-11 14:50:10 +01001668void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1669 int (*f_rng)(void *, unsigned char *, size_t),
1670 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001671{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001672 conf->f_rng = f_rng;
1673 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001674}
1675
Gilles Peskine449bd832023-01-11 14:50:10 +01001676void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1677 void (*f_dbg)(void *, int, const char *, int, const char *),
1678 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001679{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001680 conf->f_dbg = f_dbg;
1681 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001682}
1683
Gilles Peskine449bd832023-01-11 14:50:10 +01001684void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1685 void *p_bio,
1686 mbedtls_ssl_send_t *f_send,
1687 mbedtls_ssl_recv_t *f_recv,
1688 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001689{
1690 ssl->p_bio = p_bio;
1691 ssl->f_send = f_send;
1692 ssl->f_recv = f_recv;
1693 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001694}
1695
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001696#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001697void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001698{
1699 ssl->mtu = mtu;
1700}
1701#endif
1702
Gilles Peskine449bd832023-01-11 14:50:10 +01001703void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001704{
1705 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001706}
1707
Gilles Peskine449bd832023-01-11 14:50:10 +01001708void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1709 void *p_timer,
1710 mbedtls_ssl_set_timer_t *f_set_timer,
1711 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001712{
1713 ssl->p_timer = p_timer;
1714 ssl->f_set_timer = f_set_timer;
1715 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001716
1717 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001719}
1720
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001722void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1723 void *p_cache,
1724 mbedtls_ssl_cache_get_t *f_get_cache,
1725 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001726{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001727 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001728 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001729 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001730}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001731#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001734int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001735{
Janos Follath865b3eb2019-12-16 11:46:15 +00001736 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001737
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001739 session == NULL ||
1740 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1742 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001743 }
1744
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 if (ssl->handshake->resume == 1) {
1746 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1747 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001748
Jerry Yu21092062022-10-10 21:21:31 +08001749#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001751 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001753
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001755 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1757 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1758 session->ciphersuite));
1759 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001760 }
Jerry Yu40afab62022-10-08 10:42:13 +08001761 }
Jerry Yu21092062022-10-10 21:21:31 +08001762#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001763
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1765 session)) != 0) {
1766 return ret;
1767 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001768
Paul Bakker0a597072012-09-25 21:55:46 +00001769 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001772}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001773#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1776 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001777{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001778 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001779}
1780
Ronald Cron6f135e12021-12-08 16:57:54 +01001781#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001782void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1783 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001784{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001785 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001786}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787
1788#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001789void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
1790 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001791{
1792 conf->early_data_enabled = early_data_enabled;
1793}
Jerry Yucc4e0072022-11-22 17:22:22 +08001794
1795#if defined(MBEDTLS_SSL_SRV_C)
1796void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001797 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001798{
Jerry Yu39da9852022-12-06 16:58:36 +08001799 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001800}
1801#endif /* MBEDTLS_SSL_SRV_C */
1802
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001803#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001804#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001807void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1808 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001809{
1810 conf->cert_profile = profile;
1811}
1812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001814{
1815 mbedtls_ssl_key_cert *cur = key_cert, *next;
1816
Gilles Peskine449bd832023-01-11 14:50:10 +01001817 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001818 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001819 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001820 cur = next;
1821 }
1822}
1823
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001824/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001825MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001826static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1827 mbedtls_x509_crt *cert,
1828 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001829{
niisato8ee24222018-06-25 19:05:48 +09001830 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001831
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001833 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001835 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001837 }
1838
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1840 if (new_cert == NULL) {
1841 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1842 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001843
niisato8ee24222018-06-25 19:05:48 +09001844 new_cert->cert = cert;
1845 new_cert->key = key;
1846 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001847
Glenn Strauss36872db2022-01-22 05:06:31 -05001848 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001850 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001852 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001854 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 }
niisato8ee24222018-06-25 19:05:48 +09001856 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001857 }
1858
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001860}
1861
Gilles Peskine449bd832023-01-11 14:50:10 +01001862int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001863 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001865{
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001867}
1868
Gilles Peskine449bd832023-01-11 14:50:10 +01001869void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001870 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001872{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001873 conf->ca_chain = ca_chain;
1874 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001875
1876#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1877 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1878 * cannot be used together. */
1879 conf->f_ca_cb = NULL;
1880 conf->p_ca_cb = NULL;
1881#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001882}
Hanno Becker5adaad92019-03-27 16:54:37 +00001883
1884#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001885void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1886 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1887 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001888{
1889 conf->f_ca_cb = f_ca_cb;
1890 conf->p_ca_cb = p_ca_cb;
1891
1892 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1893 * cannot be used together. */
1894 conf->ca_chain = NULL;
1895 conf->ca_crl = NULL;
1896}
1897#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001899
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001900#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001901const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1902 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001903{
1904 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001905 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001906}
1907
Gilles Peskine449bd832023-01-11 14:50:10 +01001908int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1909 mbedtls_x509_crt *own_cert,
1910 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001911{
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1913 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001914}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001915
Gilles Peskine449bd832023-01-11 14:50:10 +01001916void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1917 mbedtls_x509_crt *ca_chain,
1918 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001919{
1920 ssl->handshake->sni_ca_chain = ca_chain;
1921 ssl->handshake->sni_ca_crl = ca_crl;
1922}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001923
Glenn Strauss999ef702022-03-11 01:37:23 -05001924#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001925void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1926 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001927{
1928 ssl->handshake->dn_hints = crt;
1929}
1930#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1931
Gilles Peskine449bd832023-01-11 14:50:10 +01001932void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1933 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001934{
1935 ssl->handshake->sni_authmode = authmode;
1936}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001937#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1938
Hanno Becker8927c832019-04-03 12:52:50 +01001939#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001940void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1941 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1942 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001943{
1944 ssl->f_vrfy = f_vrfy;
1945 ssl->p_vrfy = p_vrfy;
1946}
1947#endif
1948
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001949#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001950
Valerio Setti016f6822022-12-09 14:17:50 +01001951#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001952static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1953static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1954
Valerio Setti016f6822022-12-09 14:17:50 +01001955static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 mbedtls_ssl_context *ssl,
1957 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001958{
1959 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001960 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001961 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001962 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001963 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001964 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1966 psa_pake_cs_set_primitive(&cipher_suite,
1967 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1968 PSA_ECC_FAMILY_SECP_R1,
1969 256));
1970 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001971
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1973 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001974 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001976
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001978 user = jpake_server_id;
1979 user_len = sizeof(jpake_server_id);
1980 peer = jpake_client_id;
1981 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001983 user = jpake_client_id;
1984 user_len = sizeof(jpake_client_id);
1985 peer = jpake_server_id;
1986 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001988
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001989 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1990 if (status != PSA_SUCCESS) {
1991 return status;
1992 }
1993
1994 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001996 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 }
Valerio Setti016f6822022-12-09 14:17:50 +01001998
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
2000 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002001 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 }
Valerio Setti016f6822022-12-09 14:17:50 +01002003
2004 ssl->handshake->psa_pake_ctx_is_ok = 1;
2005
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002007}
2008
Gilles Peskine449bd832023-01-11 14:50:10 +01002009int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2010 const unsigned char *pw,
2011 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002012{
2013 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2014 psa_status_t status;
2015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 if (ssl->handshake == NULL || ssl->conf == NULL) {
2017 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002018 }
2019
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 /* Empty password is not valid */
2021 if ((pw == NULL) || (pw_len == 0)) {
2022 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2023 }
2024
2025 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2026 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2027 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2028
2029 status = psa_import_key(&attributes, pw, pw_len,
2030 &ssl->handshake->psa_pake_password);
2031 if (status != PSA_SUCCESS) {
2032 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2033 }
2034
2035 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2036 ssl->handshake->psa_pake_password);
2037 if (status != PSA_SUCCESS) {
2038 psa_destroy_key(ssl->handshake->psa_pake_password);
2039 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2040 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2041 }
2042
2043 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002044}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002045
Gilles Peskine449bd832023-01-11 14:50:10 +01002046int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2047 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002048{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002049 psa_status_t status;
2050
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 if (ssl->handshake == NULL || ssl->conf == NULL) {
2052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002053 }
2054
Gilles Peskine449bd832023-01-11 14:50:10 +01002055 if (mbedtls_svc_key_id_is_null(pwd)) {
2056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2057 }
2058
2059 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2060 if (status != PSA_SUCCESS) {
2061 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2062 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2063 }
2064
2065 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002066}
2067#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002068int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2069 const unsigned char *pw,
2070 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002071{
2072 mbedtls_ecjpake_role role;
2073
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 if (ssl->handshake == NULL || ssl->conf == NULL) {
2075 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2076 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002077
Valerio Settic689ed82022-12-07 14:40:38 +01002078 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 if ((pw == NULL) || (pw_len == 0)) {
2080 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2081 }
Valerio Settic689ed82022-12-07 14:40:38 +01002082
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002084 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002086 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002088
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2090 role,
2091 MBEDTLS_MD_SHA256,
2092 MBEDTLS_ECP_DP_SECP256R1,
2093 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002094}
Valerio Setti02c25b52022-11-15 14:08:42 +01002095#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002096#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002097
Ronald Cron73fe8df2022-10-05 14:31:43 +02002098#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002099int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002100{
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 if (conf->psk_identity == NULL ||
2102 conf->psk_identity_len == 0) {
2103 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002104 }
2105
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002106#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2108 return 1;
2109 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002110#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 if (conf->psk != NULL && conf->psk_len != 0) {
2113 return 1;
2114 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002117}
2118
Gilles Peskine449bd832023-01-11 14:50:10 +01002119static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002120{
2121 /* Remove reference to existing PSK, if any. */
2122#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002124 /* The maintenance of the PSK key slot is the
2125 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002126 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002127 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002128#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 if (conf->psk != NULL) {
2130 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 mbedtls_free(conf->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002133 conf->psk = NULL;
2134 conf->psk_len = 0;
2135 }
2136
2137 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 if (conf->psk_identity != NULL) {
2139 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002140 conf->psk_identity = NULL;
2141 conf->psk_identity_len = 0;
2142 }
2143}
2144
Hanno Becker7390c712018-11-15 13:33:04 +00002145/* This function assumes that PSK identity in the SSL config is unset.
2146 * It checks that the provided identity is well-formed and attempts
2147 * to make a copy of it in the SSL config.
2148 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002149MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002150static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2151 unsigned char const *psk_identity,
2152 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002153{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002154 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002156 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 (psk_identity_len >> 16) != 0 ||
2158 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2159 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002160 }
2161
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2163 if (conf->psk_identity == NULL) {
2164 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2165 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002166
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002167 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002169
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002171}
2172
Gilles Peskine449bd832023-01-11 14:50:10 +01002173int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2174 const unsigned char *psk, size_t psk_len,
2175 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002176{
Janos Follath865b3eb2019-12-16 11:46:15 +00002177 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002178
2179 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2181 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2182 }
Hanno Becker7390c712018-11-15 13:33:04 +00002183
2184 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 if (psk == NULL) {
2186 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2187 }
2188 if (psk_len == 0) {
2189 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2190 }
2191 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2192 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2193 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2196 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2197 }
Hanno Becker7390c712018-11-15 13:33:04 +00002198 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002200
2201 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2203 if (ret != 0) {
2204 ssl_conf_remove_psk(conf);
2205 }
Hanno Becker7390c712018-11-15 13:33:04 +00002206
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002208}
2209
Gilles Peskine449bd832023-01-11 14:50:10 +01002210static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002211{
2212#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002214 /* The maintenance of the external PSK key slot is the
2215 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 if (ssl->handshake->psk_opaque_is_internal) {
2217 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002218 ssl->handshake->psk_opaque_is_internal = 0;
2219 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002220 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002221 }
Neil Armstronge952a302022-05-03 10:22:14 +02002222#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 if (ssl->handshake->psk != NULL) {
2224 mbedtls_platform_zeroize(ssl->handshake->psk,
2225 ssl->handshake->psk_len);
2226 mbedtls_free(ssl->handshake->psk);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002227 ssl->handshake->psk_len = 0;
2228 }
Neil Armstronge952a302022-05-03 10:22:14 +02002229#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002230}
2231
Gilles Peskine449bd832023-01-11 14:50:10 +01002232int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2233 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002234{
Neil Armstrong501c9322022-05-03 09:35:09 +02002235#if defined(MBEDTLS_USE_PSA_CRYPTO)
2236 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002237 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002238 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002239 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002240#endif /* MBEDTLS_USE_PSA_CRYPTO */
2241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (psk == NULL || ssl->handshake == NULL) {
2243 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2244 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002245
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2247 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2248 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002249
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002251
Neil Armstrong501c9322022-05-03 09:35:09 +02002252#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002253#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2255 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2256 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2257 } else {
2258 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2259 }
2260 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002261 }
2262#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002263
Jerry Yu568ec252022-07-22 21:27:34 +08002264#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2266 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2267 psa_set_key_usage_flags(&key_attributes,
2268 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002269 }
2270#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 psa_set_key_algorithm(&key_attributes, alg);
2273 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002274
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2276 if (status != PSA_SUCCESS) {
2277 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2278 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002279
2280 /* Allow calling psa_destroy_key() on psk remove */
2281 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002283#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2285 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2286 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002287
2288 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002292#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002293}
2294
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002295#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002296int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2297 mbedtls_svc_key_id_t psk,
2298 const unsigned char *psk_identity,
2299 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002300{
Janos Follath865b3eb2019-12-16 11:46:15 +00002301 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002302
2303 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2305 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2306 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002307
Hanno Becker7390c712018-11-15 13:33:04 +00002308 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 if (mbedtls_svc_key_id_is_null(psk)) {
2310 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2311 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002312 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002313
2314 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2316 psk_identity_len);
2317 if (ret != 0) {
2318 ssl_conf_remove_psk(conf);
2319 }
Hanno Becker7390c712018-11-15 13:33:04 +00002320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002322}
2323
Gilles Peskine449bd832023-01-11 14:50:10 +01002324int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2325 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002326{
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 if ((mbedtls_svc_key_id_is_null(psk)) ||
2328 (ssl->handshake == NULL)) {
2329 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2330 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002333 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002335}
2336#endif /* MBEDTLS_USE_PSA_CRYPTO */
2337
Jerry Yu8897c072022-08-12 13:56:53 +08002338#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002339void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2340 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2341 size_t),
2342 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002343{
2344 conf->f_psk = f_psk;
2345 conf->p_psk = p_psk;
2346}
Jerry Yu8897c072022-08-12 13:56:53 +08002347#endif /* MBEDTLS_SSL_SRV_C */
2348
Ronald Cron73fe8df2022-10-05 14:31:43 +02002349#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002350
2351#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002352static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002354{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002355#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 if (alg == PSA_ALG_CBC_NO_PADDING) {
2357 return MBEDTLS_SSL_MODE_CBC;
2358 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002359#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 if (PSA_ALG_IS_AEAD(alg)) {
2361 return MBEDTLS_SSL_MODE_AEAD;
2362 }
2363 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002364}
2365
2366#else /* MBEDTLS_USE_PSA_CRYPTO */
2367
2368static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002370{
2371#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 if (mode == MBEDTLS_MODE_CBC) {
2373 return MBEDTLS_SSL_MODE_CBC;
2374 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002375#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2376
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002377#if defined(MBEDTLS_GCM_C) || \
2378 defined(MBEDTLS_CCM_C) || \
2379 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 mode == MBEDTLS_MODE_CHACHAPOLY) {
2383 return MBEDTLS_SSL_MODE_AEAD;
2384 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002385#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002386
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002388}
Gilles Peskine301711e2022-04-26 16:57:05 +02002389#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002390
Gilles Peskinee108d982022-04-26 16:50:40 +02002391static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2392 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002394{
2395#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2397 base_mode == MBEDTLS_SSL_MODE_CBC) {
2398 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002399 }
2400#else
2401 (void) encrypt_then_mac;
2402#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002404}
2405
Neil Armstrongab555e02022-04-04 11:07:59 +02002406mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002408{
Gilles Peskinee108d982022-04-26 16:50:40 +02002409 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002410#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002412#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002414#endif
2415 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002416
Gilles Peskinee108d982022-04-26 16:50:40 +02002417 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002418#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002419 encrypt_then_mac = transform->encrypt_then_mac;
2420#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002422}
2423
Neil Armstrongab555e02022-04-04 11:07:59 +02002424mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002425#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002427#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002429{
Gilles Peskinee108d982022-04-26 16:50:40 +02002430 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2431
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002432#if defined(MBEDTLS_USE_PSA_CRYPTO)
2433 psa_status_t status;
2434 psa_algorithm_t alg;
2435 psa_key_type_t type;
2436 size_t size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 status = mbedtls_ssl_cipher_to_psa(suite->cipher, 0, &alg, &type, &size);
2438 if (status == PSA_SUCCESS) {
2439 base_mode = mbedtls_ssl_get_base_mode(alg);
2440 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002441#else
2442 const mbedtls_cipher_info_t *cipher =
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 mbedtls_cipher_info_from_type(suite->cipher);
2444 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002445 base_mode =
2446 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002448 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002449#endif /* MBEDTLS_USE_PSA_CRYPTO */
2450
Gilles Peskinee108d982022-04-26 16:50:40 +02002451#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2452 int encrypt_then_mac = 0;
2453#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002454 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002455}
2456
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002457#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002458
2459#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002460/* Serialization of TLS 1.3 sessions:
2461 *
2462 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002463 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002464 * uint64 ticket_received;
2465 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002466 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002467 * } ClientOnlyData;
2468 *
2469 * struct {
2470 * uint8 endpoint;
2471 * uint8 ciphersuite[2];
2472 * uint32 ticket_age_add;
2473 * uint8 ticket_flags;
2474 * opaque resumption_key<0..255>;
2475 * select ( endpoint ) {
2476 * case client: ClientOnlyData;
2477 * case server: uint64 start_time;
2478 * };
2479 * } serialized_session_tls13;
2480 *
2481 */
2482#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002483MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002484static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2485 unsigned char *buf,
2486 size_t buf_len,
2487 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002488{
2489 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002490#if defined(MBEDTLS_SSL_CLI_C) && \
2491 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 size_t hostname_len = (session->hostname == NULL) ?
2493 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002494#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002495 size_t needed = 1 /* endpoint */
2496 + 2 /* ciphersuite */
2497 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002498 + 1 /* ticket_flags */
2499 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002500 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002501
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2503 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2504 }
Jerry Yu34191072022-08-18 10:32:09 +08002505 needed += session->resumption_key_len; /* resumption_key */
2506
Jerry Yu438ddd82022-07-07 06:55:50 +00002507#if defined(MBEDTLS_HAVE_TIME)
2508 needed += 8; /* start_time or ticket_received */
2509#endif
2510
2511#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002513#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002514 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002516#endif
2517
Jerry Yu438ddd82022-07-07 06:55:50 +00002518 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002519 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002520
2521 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 if (session->ticket_len > SIZE_MAX - needed) {
2523 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2524 }
Jerry Yu34191072022-08-18 10:32:09 +08002525
Jerry Yue28d9742022-08-18 15:44:03 +08002526 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002527 }
2528#endif /* MBEDTLS_SSL_CLI_C */
2529
Jerry Yue36fdd62022-08-17 21:31:36 +08002530 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 if (needed > buf_len) {
2532 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2533 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002534
2535 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2537 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002538 p[7] = session->ticket_flags;
2539
2540 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002541 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002542 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002543 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002544 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002545
2546#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2548 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002549 p += 8;
2550 }
2551#endif /* MBEDTLS_HAVE_TIME */
2552
2553#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002555#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002557 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002559 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002561 p += hostname_len;
2562 }
2563#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2564
Jerry Yu438ddd82022-07-07 06:55:50 +00002565#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002567 p += 8;
2568#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002570 p += 4;
2571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002573 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002574
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 if (session->ticket != NULL && session->ticket_len > 0) {
2576 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002577 p += session->ticket_len;
2578 }
2579 }
2580#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002582}
2583
2584MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002585static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2586 const unsigned char *buf,
2587 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002588{
2589 const unsigned char *p = buf;
2590 const unsigned char *end = buf + len;
2591
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 if (end - p < 9) {
2593 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2594 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002595 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2597 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002598 session->ticket_flags = p[7];
2599
2600 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002601 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002602 p += 9;
2603
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 if (end - p < session->resumption_key_len) {
2605 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2606 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2609 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2610 }
2611 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002612 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002613
2614#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2616 if (end - p < 8) {
2617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2618 }
2619 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002620 p += 8;
2621 }
2622#endif /* MBEDTLS_HAVE_TIME */
2623
2624#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002626#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002628 size_t hostname_len;
2629 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (end - p < 2) {
2631 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2632 }
2633 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002634 p += 2;
2635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 if (end - p < (long int) hostname_len) {
2637 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2638 }
2639 if (hostname_len > 0) {
2640 session->hostname = mbedtls_calloc(1, hostname_len);
2641 if (session->hostname == NULL) {
2642 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2643 }
2644 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002645 p += hostname_len;
2646 }
2647#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2648 MBEDTLS_SSL_SESSION_TICKETS */
2649
Jerry Yu438ddd82022-07-07 06:55:50 +00002650#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 if (end - p < 8) {
2652 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2653 }
2654 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002655 p += 8;
2656#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 if (end - p < 4) {
2658 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2659 }
2660 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002661 p += 4;
2662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 if (end - p < 2) {
2664 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2665 }
2666 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002667 p += 2;
2668
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 if (end - p < (long int) session->ticket_len) {
2670 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2671 }
2672 if (session->ticket_len > 0) {
2673 session->ticket = mbedtls_calloc(1, session->ticket_len);
2674 if (session->ticket == NULL) {
2675 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2676 }
2677 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002678 p += session->ticket_len;
2679 }
2680 }
2681#endif /* MBEDTLS_SSL_CLI_C */
2682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002684
2685}
2686#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002687MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002688static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2689 unsigned char *buf,
2690 size_t buf_len,
2691 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002692{
2693 ((void) session);
2694 ((void) buf);
2695 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002696 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002698}
Jerry Yu438ddd82022-07-07 06:55:50 +00002699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2701 unsigned char *buf,
2702 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002703{
2704 ((void) session);
2705 ((void) buf);
2706 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002708}
2709#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002710#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2713 size_t taglen,
2714 psa_algorithm_t *alg,
2715 psa_key_type_t *key_type,
2716 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002717{
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002719 case MBEDTLS_CIPHER_AES_128_CBC:
2720 *alg = PSA_ALG_CBC_NO_PADDING;
2721 *key_type = PSA_KEY_TYPE_AES;
2722 *key_size = 128;
2723 break;
2724 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002725 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002726 *key_type = PSA_KEY_TYPE_AES;
2727 *key_size = 128;
2728 break;
2729 case MBEDTLS_CIPHER_AES_128_GCM:
2730 *alg = PSA_ALG_GCM;
2731 *key_type = PSA_KEY_TYPE_AES;
2732 *key_size = 128;
2733 break;
2734 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002736 *key_type = PSA_KEY_TYPE_AES;
2737 *key_size = 192;
2738 break;
2739 case MBEDTLS_CIPHER_AES_192_GCM:
2740 *alg = PSA_ALG_GCM;
2741 *key_type = PSA_KEY_TYPE_AES;
2742 *key_size = 192;
2743 break;
2744 case MBEDTLS_CIPHER_AES_256_CBC:
2745 *alg = PSA_ALG_CBC_NO_PADDING;
2746 *key_type = PSA_KEY_TYPE_AES;
2747 *key_size = 256;
2748 break;
2749 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002751 *key_type = PSA_KEY_TYPE_AES;
2752 *key_size = 256;
2753 break;
2754 case MBEDTLS_CIPHER_AES_256_GCM:
2755 *alg = PSA_ALG_GCM;
2756 *key_type = PSA_KEY_TYPE_AES;
2757 *key_size = 256;
2758 break;
2759 case MBEDTLS_CIPHER_ARIA_128_CBC:
2760 *alg = PSA_ALG_CBC_NO_PADDING;
2761 *key_type = PSA_KEY_TYPE_ARIA;
2762 *key_size = 128;
2763 break;
2764 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002766 *key_type = PSA_KEY_TYPE_ARIA;
2767 *key_size = 128;
2768 break;
2769 case MBEDTLS_CIPHER_ARIA_128_GCM:
2770 *alg = PSA_ALG_GCM;
2771 *key_type = PSA_KEY_TYPE_ARIA;
2772 *key_size = 128;
2773 break;
2774 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002776 *key_type = PSA_KEY_TYPE_ARIA;
2777 *key_size = 192;
2778 break;
2779 case MBEDTLS_CIPHER_ARIA_192_GCM:
2780 *alg = PSA_ALG_GCM;
2781 *key_type = PSA_KEY_TYPE_ARIA;
2782 *key_size = 192;
2783 break;
2784 case MBEDTLS_CIPHER_ARIA_256_CBC:
2785 *alg = PSA_ALG_CBC_NO_PADDING;
2786 *key_type = PSA_KEY_TYPE_ARIA;
2787 *key_size = 256;
2788 break;
2789 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002791 *key_type = PSA_KEY_TYPE_ARIA;
2792 *key_size = 256;
2793 break;
2794 case MBEDTLS_CIPHER_ARIA_256_GCM:
2795 *alg = PSA_ALG_GCM;
2796 *key_type = PSA_KEY_TYPE_ARIA;
2797 *key_size = 256;
2798 break;
2799 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2800 *alg = PSA_ALG_CBC_NO_PADDING;
2801 *key_type = PSA_KEY_TYPE_CAMELLIA;
2802 *key_size = 128;
2803 break;
2804 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002806 *key_type = PSA_KEY_TYPE_CAMELLIA;
2807 *key_size = 128;
2808 break;
2809 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2810 *alg = PSA_ALG_GCM;
2811 *key_type = PSA_KEY_TYPE_CAMELLIA;
2812 *key_size = 128;
2813 break;
2814 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002816 *key_type = PSA_KEY_TYPE_CAMELLIA;
2817 *key_size = 192;
2818 break;
2819 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2820 *alg = PSA_ALG_GCM;
2821 *key_type = PSA_KEY_TYPE_CAMELLIA;
2822 *key_size = 192;
2823 break;
2824 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2825 *alg = PSA_ALG_CBC_NO_PADDING;
2826 *key_type = PSA_KEY_TYPE_CAMELLIA;
2827 *key_size = 256;
2828 break;
2829 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002831 *key_type = PSA_KEY_TYPE_CAMELLIA;
2832 *key_size = 256;
2833 break;
2834 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2835 *alg = PSA_ALG_GCM;
2836 *key_type = PSA_KEY_TYPE_CAMELLIA;
2837 *key_size = 256;
2838 break;
2839 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2840 *alg = PSA_ALG_CHACHA20_POLY1305;
2841 *key_type = PSA_KEY_TYPE_CHACHA20;
2842 *key_size = 256;
2843 break;
2844 case MBEDTLS_CIPHER_NULL:
2845 *alg = MBEDTLS_SSL_NULL_CIPHER;
2846 *key_type = 0;
2847 *key_size = 0;
2848 break;
2849 default:
2850 return PSA_ERROR_NOT_SUPPORTED;
2851 }
2852
2853 return PSA_SUCCESS;
2854}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002855#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002856
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002857#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002858int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2859 const unsigned char *dhm_P, size_t P_len,
2860 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002861{
Janos Follath865b3eb2019-12-16 11:46:15 +00002862 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 mbedtls_mpi_free(&conf->dhm_P);
2865 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2868 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2869 mbedtls_mpi_free(&conf->dhm_P);
2870 mbedtls_mpi_free(&conf->dhm_G);
2871 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002872 }
2873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002875}
Paul Bakker5121ce52009-01-03 21:22:43 +00002876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002878{
Janos Follath865b3eb2019-12-16 11:46:15 +00002879 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 mbedtls_mpi_free(&conf->dhm_P);
2882 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002883
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2885 &conf->dhm_P)) != 0 ||
2886 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2887 &conf->dhm_G)) != 0) {
2888 mbedtls_mpi_free(&conf->dhm_P);
2889 mbedtls_mpi_free(&conf->dhm_G);
2890 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002891 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002894}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002895#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002896
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002897#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2898/*
2899 * Set the minimum length for Diffie-Hellman parameters
2900 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002901void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2902 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002903{
2904 conf->dhm_min_bitlen = bitlen;
2905}
2906#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2907
Ronald Crone68ab4f2022-10-05 12:46:29 +02002908#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002909#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002910/*
2911 * Set allowed/preferred hashes for handshake signatures
2912 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002913void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2914 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002915{
2916 conf->sig_hashes = hashes;
2917}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002918#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002919
Jerry Yuf017ee42022-01-12 15:49:48 +08002920/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002921void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2922 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002923{
Jerry Yuf017ee42022-01-12 15:49:48 +08002924#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2925 conf->sig_hashes = NULL;
2926#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2927 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002928}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002929#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002930
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002931#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002932#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002933/*
2934 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002935 *
2936 * mbedtls_ssl_setup() takes the provided list
2937 * and translates it to a list of IANA TLS group identifiers,
2938 * stored in ssl->handshake->group_list.
2939 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002940 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002941void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2942 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002943{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002944 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002945 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002946}
Brett Warrene0edc842021-08-17 09:53:13 +01002947#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002948#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002949
Brett Warrene0edc842021-08-17 09:53:13 +01002950/*
2951 * Set the allowed groups
2952 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002953void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2954 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002955{
2956#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2957 conf->curve_list = NULL;
2958#endif
2959 conf->group_list = group_list;
2960}
2961
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002962#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002963int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002964{
Hanno Becker947194e2017-04-07 13:25:49 +01002965 /* Initialize to suppress unnecessary compiler warning */
2966 size_t hostname_len = 0;
2967
2968 /* Check if new hostname is valid before
2969 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 if (hostname != NULL) {
2971 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002972
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2974 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2975 }
Hanno Becker947194e2017-04-07 13:25:49 +01002976 }
2977
2978 /* Now it's clear that we will overwrite the old hostname,
2979 * so we can free it safely */
2980
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 if (ssl->hostname != NULL) {
2982 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
2983 mbedtls_free(ssl->hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002984 }
2985
2986 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002987
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002989 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 } else {
2991 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2992 if (ssl->hostname == NULL) {
2993 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2994 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002995
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002997
Hanno Becker947194e2017-04-07 13:25:49 +01002998 ssl->hostname[hostname_len] = '\0';
2999 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003000
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003002}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003003#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003004
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003005#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003006void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3007 int (*f_sni)(void *, mbedtls_ssl_context *,
3008 const unsigned char *, size_t),
3009 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003010{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003011 conf->f_sni = f_sni;
3012 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003013}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003014#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003015
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003017int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003018{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003019 size_t cur_len, tot_len;
3020 const char **p;
3021
3022 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003023 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3024 * MUST NOT be truncated."
3025 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003026 */
3027 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 for (p = protos; *p != NULL; p++) {
3029 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003030 tot_len += cur_len;
3031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 if ((cur_len == 0) ||
3033 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3034 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3035 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3036 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003037 }
3038
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003039 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003042}
3043
Gilles Peskine449bd832023-01-11 14:50:10 +01003044const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003045{
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003047}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003049
Johan Pascalb62bb512015-12-03 21:56:45 +01003050#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003051void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3052 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003053{
3054 conf->dtls_srtp_mki_support = support_mki_value;
3055}
3056
Gilles Peskine449bd832023-01-11 14:50:10 +01003057int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3058 unsigned char *mki_value,
3059 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003060{
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3062 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003063 }
Ron Eldor591f1622018-01-22 12:30:04 +02003064
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3066 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003067 }
Ron Eldor591f1622018-01-22 12:30:04 +02003068
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003070 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003071 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003072}
3073
Gilles Peskine449bd832023-01-11 14:50:10 +01003074int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3075 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003076{
Johan Pascal253d0262020-09-22 13:04:45 +02003077 const mbedtls_ssl_srtp_profile *p;
3078 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003079
Johan Pascal253d0262020-09-22 13:04:45 +02003080 /* check the profiles list: all entry must be valid,
3081 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3083 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3084 p++) {
3085 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003086 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003087 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003088 /* unsupported value, stop parsing and set the size to an error value */
3089 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003090 }
3091 }
3092
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3094 conf->dtls_srtp_profile_list = NULL;
3095 conf->dtls_srtp_profile_list_len = 0;
3096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003097 }
3098
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003099 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003100 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003101
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003103}
3104
Gilles Peskine449bd832023-01-11 14:50:10 +01003105void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3106 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003107{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003108 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3109 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003111 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003113 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3115 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003116 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003117}
Johan Pascalb62bb512015-12-03 21:56:45 +01003118#endif /* MBEDTLS_SSL_DTLS_SRTP */
3119
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303120#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003121void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003122{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003123 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00003124}
3125
Gilles Peskine449bd832023-01-11 14:50:10 +01003126void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003127{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003128 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00003129}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303130#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003131
Janos Follath088ce432017-04-10 12:42:31 +01003132#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003133void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3134 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003135{
3136 conf->cert_req_ca_list = cert_req_ca_list;
3137}
3138#endif
3139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003141void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003142{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003143 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003144}
3145#endif
3146
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003148void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003149{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003150 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003151}
3152#endif
3153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003155int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003156{
Gilles Peskine449bd832023-01-11 14:50:10 +01003157 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3158 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3159 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003160 }
3161
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003162 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003163
Gilles Peskine449bd832023-01-11 14:50:10 +01003164 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003165}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003166#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003167
Gilles Peskine449bd832023-01-11 14:50:10 +01003168void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003169{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003170 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003171}
3172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003173#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003174void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003175{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003176 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003177}
3178
Gilles Peskine449bd832023-01-11 14:50:10 +01003179void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003180{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003181 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003182}
3183
Gilles Peskine449bd832023-01-11 14:50:10 +01003184void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3185 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003186{
Gilles Peskine449bd832023-01-11 14:50:10 +01003187 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003188}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003189#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003191#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003192#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003193void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003194{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003195 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003196}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003197#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003198
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003199#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003200
Jerry Yud0766ec2022-09-22 10:46:57 +08003201#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003202void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3203 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003204{
Jerry Yud0766ec2022-09-22 10:46:57 +08003205 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003206}
3207#endif
3208
Gilles Peskine449bd832023-01-11 14:50:10 +01003209void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3210 mbedtls_ssl_ticket_write_t *f_ticket_write,
3211 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3212 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003213{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003214 conf->f_ticket_write = f_ticket_write;
3215 conf->f_ticket_parse = f_ticket_parse;
3216 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003217}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003218#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003219#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003220
Gilles Peskine449bd832023-01-11 14:50:10 +01003221void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3222 mbedtls_ssl_export_keys_t *f_export_keys,
3223 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003224{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003225 ssl->f_export_keys = f_export_keys;
3226 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003227}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003228
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003229#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003230void mbedtls_ssl_conf_async_private_cb(
3231 mbedtls_ssl_config *conf,
3232 mbedtls_ssl_async_sign_t *f_async_sign,
3233 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3234 mbedtls_ssl_async_resume_t *f_async_resume,
3235 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003237{
3238 conf->f_async_sign_start = f_async_sign;
3239 conf->f_async_decrypt_start = f_async_decrypt;
3240 conf->f_async_resume = f_async_resume;
3241 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003242 conf->p_async_config_data = async_config_data;
3243}
3244
Gilles Peskine449bd832023-01-11 14:50:10 +01003245void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003246{
Gilles Peskine449bd832023-01-11 14:50:10 +01003247 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003248}
3249
Gilles Peskine449bd832023-01-11 14:50:10 +01003250void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003251{
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 if (ssl->handshake == NULL) {
3253 return NULL;
3254 } else {
3255 return ssl->handshake->user_async_ctx;
3256 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003257}
3258
Gilles Peskine449bd832023-01-11 14:50:10 +01003259void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3260 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003261{
Gilles Peskine449bd832023-01-11 14:50:10 +01003262 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003263 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003264 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003265}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003266#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003267
Paul Bakker5121ce52009-01-03 21:22:43 +00003268/*
3269 * SSL get accessors
3270 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003271uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003272{
Gilles Peskine449bd832023-01-11 14:50:10 +01003273 if (ssl->session != NULL) {
3274 return ssl->session->verify_result;
3275 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003276
Gilles Peskine449bd832023-01-11 14:50:10 +01003277 if (ssl->session_negotiate != NULL) {
3278 return ssl->session_negotiate->verify_result;
3279 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003280
Gilles Peskine449bd832023-01-11 14:50:10 +01003281 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003282}
3283
Gilles Peskine449bd832023-01-11 14:50:10 +01003284int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003285{
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 if (ssl == NULL || ssl->session == NULL) {
3287 return 0;
3288 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003289
Gilles Peskine449bd832023-01-11 14:50:10 +01003290 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003291}
3292
Gilles Peskine449bd832023-01-11 14:50:10 +01003293const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003294{
Gilles Peskine449bd832023-01-11 14:50:10 +01003295 if (ssl == NULL || ssl->session == NULL) {
3296 return NULL;
3297 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003298
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003300}
3301
Gilles Peskine449bd832023-01-11 14:50:10 +01003302const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003303{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003304#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3306 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003307 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003309 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003311 }
3312 }
3313#endif
3314
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003316 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003318 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003320 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003321 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003322 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003323}
3324
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003325#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003326size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003327{
David Horstmann95d516f2021-05-04 18:36:56 +01003328 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003329 size_t read_mfl;
3330
Jerry Yuddda0502022-12-01 19:43:12 +08003331#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003332 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3334 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3335 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003336 }
Jerry Yuddda0502022-12-01 19:43:12 +08003337#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003338
3339 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 if (ssl->session_out != NULL) {
3341 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3342 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003343 max_len = read_mfl;
3344 }
3345 }
3346
Jerry Yuddda0502022-12-01 19:43:12 +08003347 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 if (ssl->session_negotiate != NULL) {
3349 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3350 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003351 max_len = read_mfl;
3352 }
3353 }
3354
Gilles Peskine449bd832023-01-11 14:50:10 +01003355 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003356}
3357
Gilles Peskine449bd832023-01-11 14:50:10 +01003358size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003359{
3360 size_t max_len;
3361
3362 /*
3363 * Assume mfl_code is correct since it was checked when set
3364 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003366
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003367 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 if (ssl->session_out != NULL &&
3369 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3370 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003371 }
3372
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003373 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003374 if (ssl->session_negotiate != NULL &&
3375 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3376 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003377 }
3378
Gilles Peskine449bd832023-01-11 14:50:10 +01003379 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003380}
3381#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3382
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003383#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003384size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003385{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003386 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003387 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3388 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3389 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3390 return 0;
3391 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003392
Gilles Peskine449bd832023-01-11 14:50:10 +01003393 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3394 return ssl->mtu;
3395 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003396
Gilles Peskine449bd832023-01-11 14:50:10 +01003397 if (ssl->mtu == 0) {
3398 return ssl->handshake->mtu;
3399 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003400
Gilles Peskine449bd832023-01-11 14:50:10 +01003401 return ssl->mtu < ssl->handshake->mtu ?
3402 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003403}
3404#endif /* MBEDTLS_SSL_PROTO_DTLS */
3405
Gilles Peskine449bd832023-01-11 14:50:10 +01003406int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003407{
3408 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3409
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003410#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3411 !defined(MBEDTLS_SSL_PROTO_DTLS)
3412 (void) ssl;
3413#endif
3414
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003415#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003416 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003417
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003419 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003421#endif
3422
3423#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3425 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3426 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003427 const size_t overhead = (size_t) ret;
3428
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 if (ret < 0) {
3430 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003431 }
3432
Gilles Peskine449bd832023-01-11 14:50:10 +01003433 if (mtu <= overhead) {
3434 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3435 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3436 }
3437
3438 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003439 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003440 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003441 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003442#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003443
Hanno Becker0defedb2018-08-10 12:35:02 +01003444#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3445 !defined(MBEDTLS_SSL_PROTO_DTLS)
3446 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003447#endif
3448
Gilles Peskine449bd832023-01-11 14:50:10 +01003449 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003450}
3451
Gilles Peskine449bd832023-01-11 14:50:10 +01003452int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003453{
3454 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3455
3456#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3457 (void) ssl;
3458#endif
3459
3460#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003461 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003462
Gilles Peskine449bd832023-01-11 14:50:10 +01003463 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003464 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003465 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003466#endif
3467
Gilles Peskine449bd832023-01-11 14:50:10 +01003468 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003469}
3470
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003471#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003472const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003473{
Gilles Peskine449bd832023-01-11 14:50:10 +01003474 if (ssl == NULL || ssl->session == NULL) {
3475 return NULL;
3476 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003477
Hanno Beckere6824572019-02-07 13:18:46 +00003478#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003479 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003480#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003481 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003482#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003483}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003484#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003485
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003486#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003487int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3488 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003489{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003490 int ret;
3491
Gilles Peskine449bd832023-01-11 14:50:10 +01003492 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003493 dst == NULL ||
3494 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003495 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3496 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003497 }
3498
Hanno Beckere810bbc2021-05-14 16:01:05 +01003499 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3500 * idempotent: Each session can only be exported once.
3501 *
3502 * (This is in preparation for TLS 1.3 support where we will
3503 * need the ability to export multiple sessions (aka tickets),
3504 * which will be achieved by calling mbedtls_ssl_get_session()
3505 * multiple times until it fails.)
3506 *
3507 * Check whether we have already exported the current session,
3508 * and fail if so.
3509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003510 if (ssl->session->exported == 1) {
3511 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3512 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003513
Gilles Peskine449bd832023-01-11 14:50:10 +01003514 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3515 if (ret != 0) {
3516 return ret;
3517 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003518
3519 /* Remember that we've exported the session. */
3520 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003521 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003522}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003523#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003524
Paul Bakker5121ce52009-01-03 21:22:43 +00003525/*
Hanno Beckera835da52019-05-16 12:39:07 +01003526 * Define ticket header determining Mbed TLS version
3527 * and structure of the ticket.
3528 */
3529
Hanno Becker94ef3b32019-05-16 12:50:45 +01003530/*
Hanno Becker50b59662019-05-28 14:30:45 +01003531 * Define bitflag determining compile-time settings influencing
3532 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003533 */
3534
Hanno Becker50b59662019-05-28 14:30:45 +01003535#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003536#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003537#else
Hanno Becker3e088662019-05-29 11:10:18 +01003538#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003539#endif /* MBEDTLS_HAVE_TIME */
3540
3541#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003542#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003543#else
Hanno Becker3e088662019-05-29 11:10:18 +01003544#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003545#endif /* MBEDTLS_X509_CRT_PARSE_C */
3546
3547#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003548#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003549#else
Hanno Becker3e088662019-05-29 11:10:18 +01003550#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003551#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3552
3553#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003554#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003555#else
Hanno Becker3e088662019-05-29 11:10:18 +01003556#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003557#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3558
Hanno Becker94ef3b32019-05-16 12:50:45 +01003559#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003560#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003561#else
Hanno Becker3e088662019-05-29 11:10:18 +01003562#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003563#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3564
Hanno Becker94ef3b32019-05-16 12:50:45 +01003565#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3566#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3567#else
3568#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3569#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3570
Hanno Becker3e088662019-05-29 11:10:18 +01003571#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3572#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3573#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3574#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003575#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3576#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003577
Hanno Becker50b59662019-05-28 14:30:45 +01003578#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003579 ((uint16_t) ( \
3580 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3581 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3582 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3583 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3584 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3585 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3586 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003587
Hanno Beckerf8787072019-05-16 12:41:07 +01003588static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003589 MBEDTLS_VERSION_MAJOR,
3590 MBEDTLS_VERSION_MINOR,
3591 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003592 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3593 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003594};
Hanno Beckera835da52019-05-16 12:39:07 +01003595
3596/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003597 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003598 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003599 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003600 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003601 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003602 * opaque mbedtls_version[3]; // library version: major, minor, patch
3603 * opaque session_format[2]; // library-version specific 16-bit field
3604 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003605 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003606 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003607 * Note: When updating the format, remember to keep
3608 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003609 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003610 * // In this version, `session_format` determines
3611 * // the setting of those compile-time
3612 * // configuration options which influence
3613 * // the structure of mbedtls_ssl_session.
3614 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003615 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003616 * // - TLS 1.2 (0x0303)
3617 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003618 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003619 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003620 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003621 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003622 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003623 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003624 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003625 *
3626 * };
3627 *
3628 * } serialized_session;
3629 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003630 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003631
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003632MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003633static int ssl_session_save(const mbedtls_ssl_session *session,
3634 unsigned char omit_header,
3635 unsigned char *buf,
3636 size_t buf_len,
3637 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003638{
3639 unsigned char *p = buf;
3640 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003641 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003642#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3643 size_t out_len;
3644 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3645#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003646 if (session == NULL) {
3647 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3648 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003649
Gilles Peskine449bd832023-01-11 14:50:10 +01003650 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003651 /*
3652 * Add Mbed TLS version identifier
3653 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003654 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003655
Gilles Peskine449bd832023-01-11 14:50:10 +01003656 if (used <= buf_len) {
3657 memcpy(p, ssl_serialized_session_header,
3658 sizeof(ssl_serialized_session_header));
3659 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003660 }
3661 }
3662
3663 /*
3664 * TLS version identifier
3665 */
3666 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003667 if (used <= buf_len) {
3668 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003669 }
3670
3671 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003672 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003673 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003674#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003675 case MBEDTLS_SSL_VERSION_TLS1_2:
3676 used += ssl_tls12_session_save(session, p, remaining_len);
3677 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003678#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3679
Jerry Yu251a12e2022-07-13 15:15:48 +08003680#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003681 case MBEDTLS_SSL_VERSION_TLS1_3:
3682 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3683 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3684 return ret;
3685 }
3686 used += out_len;
3687 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003688#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3689
Gilles Peskine449bd832023-01-11 14:50:10 +01003690 default:
3691 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003692 }
3693
3694 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003695 if (used > buf_len) {
3696 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3697 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003698
Gilles Peskine449bd832023-01-11 14:50:10 +01003699 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003700}
3701
3702/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003703 * Public wrapper for ssl_session_save()
3704 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003705int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3706 unsigned char *buf,
3707 size_t buf_len,
3708 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003709{
Gilles Peskine449bd832023-01-11 14:50:10 +01003710 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003711}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003712
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003713/*
3714 * Deserialize session, see mbedtls_ssl_session_save() for format.
3715 *
3716 * This internal version is wrapped by a public function that cleans up in
3717 * case of error, and has an extra option omit_header.
3718 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003719MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003720static int ssl_session_load(mbedtls_ssl_session *session,
3721 unsigned char omit_header,
3722 const unsigned char *buf,
3723 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003724{
3725 const unsigned char *p = buf;
3726 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003727 size_t remaining_len;
3728
3729
Gilles Peskine449bd832023-01-11 14:50:10 +01003730 if (session == NULL) {
3731 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3732 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003733
Gilles Peskine449bd832023-01-11 14:50:10 +01003734 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003735 /*
3736 * Check Mbed TLS version identifier
3737 */
3738
Gilles Peskine449bd832023-01-11 14:50:10 +01003739 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3740 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003741 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003742
3743 if (memcmp(p, ssl_serialized_session_header,
3744 sizeof(ssl_serialized_session_header)) != 0) {
3745 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3746 }
3747 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003748 }
3749
3750 /*
3751 * TLS version identifier
3752 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003753 if (1 > (size_t) (end - p)) {
3754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3755 }
Glenn Straussda7851c2022-03-14 13:29:48 -04003756 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003757
3758 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003759 remaining_len = (end - p);
3760 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003761#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003762 case MBEDTLS_SSL_VERSION_TLS1_2:
3763 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003764#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3765
Jerry Yu438ddd82022-07-07 06:55:50 +00003766#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003767 case MBEDTLS_SSL_VERSION_TLS1_3:
3768 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003769#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3770
Gilles Peskine449bd832023-01-11 14:50:10 +01003771 default:
3772 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003773 }
3774}
3775
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003776/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003777 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003778 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003779int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3780 const unsigned char *buf,
3781 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003782{
Gilles Peskine449bd832023-01-11 14:50:10 +01003783 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003784
Gilles Peskine449bd832023-01-11 14:50:10 +01003785 if (ret != 0) {
3786 mbedtls_ssl_session_free(session);
3787 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003788
Gilles Peskine449bd832023-01-11 14:50:10 +01003789 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003790}
3791
3792/*
Paul Bakker1961b702013-01-25 14:49:24 +01003793 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003794 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003795MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003796static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003797{
3798 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3799
Ronald Cron66dbf912022-02-02 15:33:46 +01003800 /*
3801 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003802 * that were written into the output buffer by the previous handshake step,
3803 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003804 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3805 * We proceed to the next handshake step only when all data from the
3806 * previous one have been sent to the peer, thus we make sure that this is
3807 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3808 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3809 * we have to wait before to go ahead.
3810 * In the case of TLS 1.3, handshake step handlers do not send data to the
3811 * peer. Data are only sent here and through
3812 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003813 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003814 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003815 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3816 return ret;
3817 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003818
3819#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003820 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3821 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3822 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3823 return ret;
3824 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003825 }
3826#endif /* MBEDTLS_SSL_PROTO_DTLS */
3827
Gilles Peskine449bd832023-01-11 14:50:10 +01003828 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003829}
3830
Gilles Peskine449bd832023-01-11 14:50:10 +01003831int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003832{
Hanno Becker41934dd2021-08-07 19:13:43 +01003833 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003834
Gilles Peskine449bd832023-01-11 14:50:10 +01003835 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003836 ssl->conf == NULL ||
3837 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003838 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3839 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003840 }
3841
Gilles Peskine449bd832023-01-11 14:50:10 +01003842 ret = ssl_prepare_handshake_step(ssl);
3843 if (ret != 0) {
3844 return ret;
3845 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003846
Gilles Peskine449bd832023-01-11 14:50:10 +01003847 ret = mbedtls_ssl_handle_pending_alert(ssl);
3848 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003849 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003850 }
Jerry Yue7047812021-09-13 19:26:39 +08003851
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003852 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3853 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3854 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3855
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003856#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003857 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3858 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
3859 mbedtls_ssl_states_str(ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003860
Gilles Peskine449bd832023-01-11 14:50:10 +01003861 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003862 case MBEDTLS_SSL_HELLO_REQUEST:
3863 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003864 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003865 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003866
Ronald Cron9f0fba32022-02-10 16:45:15 +01003867 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003868 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003869 break;
3870
3871 default:
3872#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003873 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3874 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3875 } else {
3876 ret = mbedtls_ssl_handshake_client_step(ssl);
3877 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003878#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003879 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003880#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003881 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003882#endif
3883 }
Jerry Yub9930e72021-08-06 17:11:51 +08003884 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003885#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003886#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003887 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6f135e12021-12-08 16:57:54 +01003888#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003889 if (mbedtls_ssl_conf_is_tls13_only(ssl->conf)) {
3890 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
3891 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003892#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003893
3894#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003895 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf)) {
3896 ret = mbedtls_ssl_handshake_server_step(ssl);
3897 }
Jerry Yub9930e72021-08-06 17:11:51 +08003898#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3899 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003900#endif
3901
Gilles Peskine449bd832023-01-11 14:50:10 +01003902 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003903 /* handshake_step return error. And it is same
3904 * with alert_reason.
3905 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003906 if (ssl->send_alert) {
3907 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003908 goto cleanup;
3909 }
3910 }
3911
3912cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003913 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003914}
3915
3916/*
3917 * Perform the SSL handshake
3918 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003919int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003920{
3921 int ret = 0;
3922
Hanno Beckera817ea42020-10-20 15:20:23 +01003923 /* Sanity checks */
3924
Gilles Peskine449bd832023-01-11 14:50:10 +01003925 if (ssl == NULL || ssl->conf == NULL) {
3926 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3927 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003928
Hanno Beckera817ea42020-10-20 15:20:23 +01003929#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003930 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3931 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3932 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3933 "mbedtls_ssl_set_timer_cb() for DTLS"));
3934 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003935 }
3936#endif /* MBEDTLS_SSL_PROTO_DTLS */
3937
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003939
Hanno Beckera817ea42020-10-20 15:20:23 +01003940 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003941 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3942 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003943
Gilles Peskine449bd832023-01-11 14:50:10 +01003944 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003945 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 }
Paul Bakker1961b702013-01-25 14:49:24 +01003947 }
3948
Gilles Peskine449bd832023-01-11 14:50:10 +01003949 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003950
Gilles Peskine449bd832023-01-11 14:50:10 +01003951 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003952}
3953
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003954#if defined(MBEDTLS_SSL_RENEGOTIATION)
3955#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003956/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003957 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003958 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003959MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003960static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003961{
Janos Follath865b3eb2019-12-16 11:46:15 +00003962 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003963
Gilles Peskine449bd832023-01-11 14:50:10 +01003964 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003965
3966 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003967 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3968 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003969
Gilles Peskine449bd832023-01-11 14:50:10 +01003970 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3971 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3972 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003973 }
3974
Gilles Peskine449bd832023-01-11 14:50:10 +01003975 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003976
Gilles Peskine449bd832023-01-11 14:50:10 +01003977 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003978}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003979#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003980
3981/*
3982 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003983 * - any side: calling mbedtls_ssl_renegotiate(),
3984 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3985 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003986 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003987 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003988 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003989 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003990int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003991{
Janos Follath865b3eb2019-12-16 11:46:15 +00003992 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003993
Gilles Peskine449bd832023-01-11 14:50:10 +01003994 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00003995
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 if ((ret = ssl_handshake_init(ssl)) != 0) {
3997 return ret;
3998 }
Paul Bakker48916f92012-09-16 19:57:18 +00003999
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004000 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4001 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004002#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4004 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4005 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004006 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004008 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004009 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004010 }
4011#endif
4012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004013 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4014 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004015
Gilles Peskine449bd832023-01-11 14:50:10 +01004016 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4017 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4018 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004019 }
4020
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004022
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004024}
4025
4026/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004027 * Renegotiate current connection on client,
4028 * or request renegotiation on server
4029 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004030int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004031{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004032 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004033
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 if (ssl == NULL || ssl->conf == NULL) {
4035 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4036 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004038#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004039 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004040 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4041 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4042 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4043 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004044
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004045 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004046
4047 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 if (ssl->out_left != 0) {
4049 return mbedtls_ssl_flush_output(ssl);
4050 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004051
Gilles Peskine449bd832023-01-11 14:50:10 +01004052 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004053 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004054#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004056#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004057 /*
4058 * On client, either start the renegotiation process or,
4059 * if already in progress, continue the handshake
4060 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004061 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4062 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4063 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004064 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004065
4066 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4067 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4068 return ret;
4069 }
4070 } else {
4071 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4072 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4073 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004074 }
4075 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004076#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004077
Gilles Peskine449bd832023-01-11 14:50:10 +01004078 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004079}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004080#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004081
Gilles Peskine449bd832023-01-11 14:50:10 +01004082void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004083{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004084 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4085
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004087 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004088 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004089
Brett Warrene0edc842021-08-17 09:53:13 +01004090#if defined(MBEDTLS_ECP_C)
4091#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004092 if (ssl->handshake->group_list_heap_allocated) {
4093 mbedtls_free((void *) handshake->group_list);
4094 }
Brett Warrene0edc842021-08-17 09:53:13 +01004095 handshake->group_list = NULL;
4096#endif /* MBEDTLS_DEPRECATED_REMOVED */
4097#endif /* MBEDTLS_ECP_C */
4098
Ronald Crone68ab4f2022-10-05 12:46:29 +02004099#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004100#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 if (ssl->handshake->sig_algs_heap_allocated) {
4102 mbedtls_free((void *) handshake->sig_algs);
4103 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004104 handshake->sig_algs = NULL;
4105#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004106#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004107 if (ssl->handshake->certificate_request_context) {
4108 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004109 }
4110#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004111#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004112
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004113#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4115 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004116 handshake->async_in_progress = 0;
4117 }
4118#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4119
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004120#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004121#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004123#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004124 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004125#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004126#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004127#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004128#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004130#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004131 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004132#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004133#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004135#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004137#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02004138#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004140#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004141
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004142#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004143#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004145 /*
4146 * Opaque keys are not stored in the handshake's data and it's the user
4147 * responsibility to destroy them. Clear ones, instead, are created by
4148 * the TLS library and should be destroyed at the same level
4149 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4151 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004152 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004153 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4154#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004156#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004157#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004159 handshake->ecjpake_cache = NULL;
4160 handshake->ecjpake_cache_len = 0;
4161#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004162#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004163
Janos Follath4ae5c292016-02-10 11:27:43 +00004164#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4165 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004166 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004168#endif
4169
Ronald Cron73fe8df2022-10-05 14:31:43 +02004170#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004171#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004173 /* The maintenance of the external PSK key slot is the
4174 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 if (ssl->handshake->psk_opaque_is_internal) {
4176 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004177 ssl->handshake->psk_opaque_is_internal = 0;
4178 }
4179 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4180 }
Neil Armstronge952a302022-05-03 10:22:14 +02004181#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 if (handshake->psk != NULL) {
4183 mbedtls_platform_zeroize(handshake->psk, handshake->psk_len);
4184 mbedtls_free(handshake->psk);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004185 }
Neil Armstronge952a302022-05-03 10:22:14 +02004186#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004187#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004188
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004189#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4190 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004191 /*
4192 * Free only the linked list wrapper, not the keys themselves
4193 * since the belong to the SNI callback
4194 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004196#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004197
Gilles Peskineeccd8882020-03-10 12:19:08 +01004198#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004199 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4200 if (handshake->ecrs_peer_cert != NULL) {
4201 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4202 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004203 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004204#endif
4205
Hanno Becker75173122019-02-06 16:18:31 +00004206#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4207 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004209#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4210
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004211#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4213 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004214#endif /* MBEDTLS_SSL_CLI_C &&
4215 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004216
4217#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004218 mbedtls_ssl_flight_free(handshake->flight);
4219 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004220#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004221
Valerio Setti080a22b2023-03-20 15:22:47 +01004222#if defined(PSA_WANT_ALG_ECDH) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 (defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4224 if (handshake->ecdh_psa_privkey_is_external == 0) {
4225 psa_destroy_key(handshake->ecdh_psa_privkey);
4226 }
Valerio Setti080a22b2023-03-20 15:22:47 +01004227#endif /* PSA_WANT_ALG_ECDH && (MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3) */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004228
Ronald Cron6f135e12021-12-08 16:57:54 +01004229#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004230 mbedtls_ssl_transform_free(handshake->transform_handshake);
4231 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004232#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4234 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004235#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004236#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004237
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004238
4239#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4240 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4241 * processes datagrams and the fact that a datagram is allowed to have
4242 * several records in it, it is possible that the I/O buffers are not
4243 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4245 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004246#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004247
Jerry Yuba9c7272021-10-30 11:54:10 +08004248 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 mbedtls_platform_zeroize(handshake,
4250 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004251}
4252
Gilles Peskine449bd832023-01-11 14:50:10 +01004253void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004254{
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004256 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004258
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004259#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004261#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004262
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004263#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004264#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4265 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004267#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004269#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004270
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004272}
4273
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004274#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004275
4276#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4277#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4278#else
4279#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4280#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4281
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004282#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004283
4284#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4285#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4286#else
4287#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4288#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4289
4290#if defined(MBEDTLS_SSL_ALPN)
4291#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4292#else
4293#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4294#endif /* MBEDTLS_SSL_ALPN */
4295
4296#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4297#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4298#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4299#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4300
4301#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 ((uint32_t) ( \
4303 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4304 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4305 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4306 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4307 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4308 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4309 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4310 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004311
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004312static unsigned char ssl_serialized_context_header[] = {
4313 MBEDTLS_VERSION_MAJOR,
4314 MBEDTLS_VERSION_MINOR,
4315 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4317 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4318 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4319 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4320 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004321};
4322
Paul Bakker5121ce52009-01-03 21:22:43 +00004323/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004324 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004325 *
4326 * The format of the serialized data is:
4327 * (in the presentation language of TLS, RFC 8446 section 3)
4328 *
4329 * // header
4330 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004331 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004332 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004333 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004334 * Note: When updating the format, remember to keep these
4335 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004336 *
4337 * // session sub-structure
4338 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4339 * // transform sub-structure
4340 * uint8 random[64]; // ServerHello.random+ClientHello.random
4341 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4342 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4343 * // fields from ssl_context
4344 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4345 * uint64 in_window_top; // DTLS: last validated record seq_num
4346 * uint64 in_window; // DTLS: bitmask for replay protection
4347 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4348 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4349 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4350 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4351 *
4352 * Note that many fields of the ssl_context or sub-structures are not
4353 * serialized, as they fall in one of the following categories:
4354 *
4355 * 1. forced value (eg in_left must be 0)
4356 * 2. pointer to dynamically-allocated memory (eg session, transform)
4357 * 3. value can be re-derived from other data (eg session keys from MS)
4358 * 4. value was temporary (eg content of input buffer)
4359 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004360 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004361int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4362 unsigned char *buf,
4363 size_t buf_len,
4364 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004365{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004366 unsigned char *p = buf;
4367 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004368 size_t session_len;
4369 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004370
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004371 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004372 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4373 * this function's documentation.
4374 *
4375 * These are due to assumptions/limitations in the implementation. Some of
4376 * them are likely to stay (no handshake in progress) some might go away
4377 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004378 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004379 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4381 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4382 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004383 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 if (ssl->handshake != NULL) {
4385 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
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 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if (ssl->transform == NULL || ssl->session == NULL) {
4390 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4391 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004392 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004393 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 if (mbedtls_ssl_check_pending(ssl) != 0) {
4395 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4396 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004397 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 if (ssl->out_left != 0) {
4399 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4400 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004401 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004402 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4404 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is 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 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4409 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 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 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4414 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4415 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004416 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004417 /* Renegotiation must not be enabled */
4418#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4420 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4421 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004422 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004423#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004424
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004425 /*
4426 * Version and format identifier
4427 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004429
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 if (used <= buf_len) {
4431 memcpy(p, ssl_serialized_context_header,
4432 sizeof(ssl_serialized_context_header));
4433 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004434 }
4435
4436 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004437 * Session (length + data)
4438 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4440 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4441 return ret;
4442 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004443
4444 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 if (used <= buf_len) {
4446 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004447 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004448
Gilles Peskine449bd832023-01-11 14:50:10 +01004449 ret = ssl_session_save(ssl->session, 1,
4450 p, session_len, &session_len);
4451 if (ret != 0) {
4452 return ret;
4453 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004454
4455 p += session_len;
4456 }
4457
4458 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004459 * Transform
4460 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 used += sizeof(ssl->transform->randbytes);
4462 if (used <= buf_len) {
4463 memcpy(p, ssl->transform->randbytes,
4464 sizeof(ssl->transform->randbytes));
4465 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004466 }
4467
4468#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4469 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004471 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004473 p += ssl->transform->in_cid_len;
4474
4475 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004477 p += ssl->transform->out_cid_len;
4478 }
4479#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4480
4481 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004482 * Saved fields from top-level ssl_context structure
4483 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004484 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 if (used <= buf_len) {
4486 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004487 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004488 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004489
4490#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4491 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 if (used <= buf_len) {
4493 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004494 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004495
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004497 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004498 }
4499#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4500
4501#if defined(MBEDTLS_SSL_PROTO_DTLS)
4502 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004504 *p++ = ssl->disable_datagram_packing;
4505 }
4506#endif /* MBEDTLS_SSL_PROTO_DTLS */
4507
Jerry Yuae0b2e22021-10-08 15:21:19 +08004508 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 if (used <= buf_len) {
4510 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004511 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004512 }
4513
4514#if defined(MBEDTLS_SSL_PROTO_DTLS)
4515 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 if (used <= buf_len) {
4517 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004518 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004519 }
4520#endif /* MBEDTLS_SSL_PROTO_DTLS */
4521
4522#if defined(MBEDTLS_SSL_ALPN)
4523 {
4524 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004526 : 0;
4527
4528 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004530 *p++ = alpn_len;
4531
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 if (ssl->alpn_chosen != NULL) {
4533 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004534 p += alpn_len;
4535 }
4536 }
4537 }
4538#endif /* MBEDTLS_SSL_ALPN */
4539
4540 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004541 * Done
4542 */
4543 *olen = used;
4544
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 if (used > buf_len) {
4546 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4547 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004548
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004552}
4553
4554/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004555 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004556 *
4557 * This internal version is wrapped by a public function that cleans up in
4558 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004559 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004560MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004561static int ssl_context_load(mbedtls_ssl_context *ssl,
4562 const unsigned char *buf,
4563 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004564{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004565 const unsigned char *p = buf;
4566 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004567 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004568 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004569#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004570 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004571#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004572
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004573 /*
4574 * The context should have been freshly setup or reset.
4575 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004576 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004577 * renegotiating, or if the user mistakenly loaded a session first.)
4578 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4580 ssl->session != NULL) {
4581 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004582 }
4583
4584 /*
4585 * We can't check that the config matches the initial one, but we can at
4586 * least check it matches the requirements for serializing.
4587 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004589 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4590 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004591#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004592 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004593#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 0) {
4595 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004596 }
4597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004599
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004600 /*
4601 * Check version identifier
4602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4604 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004605 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004606
4607 if (memcmp(p, ssl_serialized_context_header,
4608 sizeof(ssl_serialized_context_header)) != 0) {
4609 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4610 }
4611 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004612
4613 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004614 * Session
4615 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 if ((size_t) (end - p) < 4) {
4617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4618 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004619
Gilles Peskine449bd832023-01-11 14:50:10 +01004620 session_len = ((size_t) p[0] << 24) |
4621 ((size_t) p[1] << 16) |
4622 ((size_t) p[2] << 8) |
4623 ((size_t) p[3]);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004624 p += 4;
4625
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004626 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004627 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004628 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004629 ssl->session_in = ssl->session;
4630 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004631 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004632
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 if ((size_t) (end - p) < session_len) {
4634 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4635 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 ret = ssl_session_load(ssl->session, 1, p, session_len);
4638 if (ret != 0) {
4639 mbedtls_ssl_session_free(ssl->session);
4640 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004641 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004642
4643 p += session_len;
4644
4645 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004646 * Transform
4647 */
4648
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004649 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004650 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004651#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004652 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004653 ssl->transform_in = ssl->transform;
4654 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004655 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004656#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004657
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004658#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4660 if (prf_func == NULL) {
4661 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4662 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004663
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004664 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4666 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4667 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004668
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 ret = ssl_tls12_populate_transform(ssl->transform,
4670 ssl->session->ciphersuite,
4671 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004672#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004674#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 prf_func,
4676 p, /* currently pointing to randbytes */
4677 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4678 ssl->conf->endpoint,
4679 ssl);
4680 if (ret != 0) {
4681 return ret;
4682 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004683#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004685
4686#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4687 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 if ((size_t) (end - p) < 1) {
4689 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4690 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004691
4692 ssl->transform->in_cid_len = *p++;
4693
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4695 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4696 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004697
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004699 p += ssl->transform->in_cid_len;
4700
4701 ssl->transform->out_cid_len = *p++;
4702
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4704 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4705 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004708 p += ssl->transform->out_cid_len;
4709#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4710
4711 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004712 * Saved fields from top-level ssl_context structure
4713 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 if ((size_t) (end - p) < 4) {
4715 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4716 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004717
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 ssl->badmac_seen = ((uint32_t) p[0] << 24) |
4719 ((uint32_t) p[1] << 16) |
4720 ((uint32_t) p[2] << 8) |
4721 ((uint32_t) p[3]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004722 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004723
4724#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 if ((size_t) (end - p) < 16) {
4726 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4727 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004728
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 ssl->in_window_top = ((uint64_t) p[0] << 56) |
4730 ((uint64_t) p[1] << 48) |
4731 ((uint64_t) p[2] << 40) |
4732 ((uint64_t) p[3] << 32) |
4733 ((uint64_t) p[4] << 24) |
4734 ((uint64_t) p[5] << 16) |
4735 ((uint64_t) p[6] << 8) |
4736 ((uint64_t) p[7]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004737 p += 8;
4738
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 ssl->in_window = ((uint64_t) p[0] << 56) |
4740 ((uint64_t) p[1] << 48) |
4741 ((uint64_t) p[2] << 40) |
4742 ((uint64_t) p[3] << 32) |
4743 ((uint64_t) p[4] << 24) |
4744 ((uint64_t) p[5] << 16) |
4745 ((uint64_t) p[6] << 8) |
4746 ((uint64_t) p[7]);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004747 p += 8;
4748#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4749
4750#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if ((size_t) (end - p) < 1) {
4752 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4753 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004754
4755 ssl->disable_datagram_packing = *p++;
4756#endif /* MBEDTLS_SSL_PROTO_DTLS */
4757
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4759 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4760 }
4761 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4762 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004763
4764#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 if ((size_t) (end - p) < 2) {
4766 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4767 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004768
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004770 p += 2;
4771#endif /* MBEDTLS_SSL_PROTO_DTLS */
4772
4773#if defined(MBEDTLS_SSL_ALPN)
4774 {
4775 uint8_t alpn_len;
4776 const char **cur;
4777
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 if ((size_t) (end - p) < 1) {
4779 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4780 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004781
4782 alpn_len = *p++;
4783
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004785 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4787 if (strlen(*cur) == alpn_len &&
4788 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004789 ssl->alpn_chosen = *cur;
4790 break;
4791 }
4792 }
4793 }
4794
4795 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4797 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4798 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004799
4800 p += alpn_len;
4801 }
4802#endif /* MBEDTLS_SSL_ALPN */
4803
4804 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004805 * Forced fields from top-level ssl_context structure
4806 *
4807 * Most of them already set to the correct value by mbedtls_ssl_init() and
4808 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4809 */
4810 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004811 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004812
Hanno Becker361b10d2019-08-30 10:42:49 +01004813 /* Adjust pointers for header fields of outgoing records to
4814 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004816
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004817#if defined(MBEDTLS_SSL_PROTO_DTLS)
4818 ssl->in_epoch = 1;
4819#endif
4820
4821 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4822 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004823 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4824 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 if (ssl->handshake != NULL) {
4826 mbedtls_ssl_handshake_free(ssl);
4827 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004828 ssl->handshake = NULL;
4829 }
4830
4831 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004832 * Done - should have consumed entire buffer
4833 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 if (p != end) {
4835 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4836 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004837
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004839}
4840
4841/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004842 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004843 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004844int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4845 const unsigned char *buf,
4846 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004847{
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004849
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 if (ret != 0) {
4851 mbedtls_ssl_free(context);
4852 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004853
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004855}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004856#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004857
4858/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004859 * Free an SSL context
4860 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004861void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004862{
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004864 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004866
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004868
Gilles Peskine449bd832023-01-11 14:50:10 +01004869 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004870#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4871 size_t out_buf_len = ssl->out_buf_len;
4872#else
4873 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4874#endif
4875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 mbedtls_platform_zeroize(ssl->out_buf, out_buf_len);
4877 mbedtls_free(ssl->out_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004878 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004879 }
4880
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004882#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4883 size_t in_buf_len = ssl->in_buf_len;
4884#else
4885 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4886#endif
4887
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 mbedtls_platform_zeroize(ssl->in_buf, in_buf_len);
4889 mbedtls_free(ssl->in_buf);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004890 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004891 }
4892
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 if (ssl->transform) {
4894 mbedtls_ssl_transform_free(ssl->transform);
4895 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004896 }
4897
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 if (ssl->handshake) {
4899 mbedtls_ssl_handshake_free(ssl);
4900 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004901
4902#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4904 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004905#endif
4906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 mbedtls_ssl_session_free(ssl->session_negotiate);
4908 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004909 }
4910
Ronald Cron6f135e12021-12-08 16:57:54 +01004911#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 mbedtls_ssl_transform_free(ssl->transform_application);
4913 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004914#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004915
Gilles Peskine449bd832023-01-11 14:50:10 +01004916 if (ssl->session) {
4917 mbedtls_ssl_session_free(ssl->session);
4918 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004919 }
4920
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004921#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 if (ssl->hostname != NULL) {
4923 mbedtls_platform_zeroize(ssl->hostname, strlen(ssl->hostname));
4924 mbedtls_free(ssl->hostname);
Paul Bakker5121ce52009-01-03 21:22:43 +00004925 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004926#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004927
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004928#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004930#endif
4931
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004933
Paul Bakker86f04f42013-02-14 11:20:09 +01004934 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004936}
4937
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004938/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004939 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004940 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004941void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004942{
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004944}
4945
Gilles Peskineae270bf2021-06-02 00:05:29 +02004946/* The selection should be the same as mbedtls_x509_crt_profile_default in
4947 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004948 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004949 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004950 * about this list.
4951 */
Brett Warrene0edc842021-08-17 09:53:13 +01004952static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004953#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004954 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004955#endif
4956#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004957 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004958#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004959#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004960 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004961#endif
4962#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004963 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004964#endif
4965#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004966 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004967#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004968#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004969 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004970#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004971#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004972 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004973#endif
4974#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004975 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004976#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004977 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004978};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004979
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004980static int ssl_preset_suiteb_ciphersuites[] = {
4981 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4982 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4983 0
4984};
4985
Ronald Crone68ab4f2022-10-05 12:46:29 +02004986#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004987
Jerry Yu909df7b2022-01-22 11:56:27 +08004988/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004989 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004990 * rules SHOULD be upheld.
4991 * - No duplicate entries.
4992 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004993 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004994 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004995 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004996static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004997
Valerio Setti75fba322023-02-23 17:35:09 +01004998#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004999 defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08005000 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5001 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005002#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA256 &&
Jerry Yued5e9f42022-01-26 11:21:34 +08005003 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005004
Valerio Setti75fba322023-02-23 17:35:09 +01005005#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005006 defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08005007 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5008 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005009#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu909df7b2022-01-22 11:56:27 +08005010 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
5011
Valerio Setti75fba322023-02-23 17:35:09 +01005012#if defined(MBEDTLS_PK_CAN_ECDSA_SOME) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005013 defined(MBEDTLS_MD_CAN_SHA512) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08005014 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
5015 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005016#endif /* MBEDTLS_PK_CAN_ECDSA_SOME && MBEDTLS_MD_CAN_SHA384&&
Jerry Yued5e9f42022-01-26 11:21:34 +08005017 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005018
Gilles Peskine449bd832023-01-11 14:50:10 +01005019#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005020 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005021 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005022#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005023 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005024
Gilles Peskine449bd832023-01-11 14:50:10 +01005025#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005026 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005027 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005028#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005029 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005030
Gilles Peskine449bd832023-01-11 14:50:10 +01005031#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005032 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005033 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005034#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005035 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005036
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005037#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005038 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005039#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005040
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005041#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005042 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005043#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005044
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005045#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005046 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005047#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005048
Gabor Mezei15b95a62022-05-09 16:37:58 +02005049 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005050};
5051
5052/* NOTICE: see above */
5053#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5054static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005055#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Setti75fba322023-02-23 17:35:09 +01005056#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005058#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005059#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5060 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5061#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005062#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005064#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005065#endif /* MBEDTLS_MD_CAN_SHA512*/
5066#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Setti75fba322023-02-23 17:35:09 +01005067#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005069#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005070#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5071 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5072#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005073#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005074 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005075#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005076#endif /* MBEDTLS_MD_CAN_SHA384*/
5077#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Setti75fba322023-02-23 17:35:09 +01005078#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005080#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005081#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5082 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5083#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005084#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005086#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005087#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005088 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005089};
5090#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5091/* NOTICE: see above */
5092static uint16_t ssl_preset_suiteb_sig_algs[] = {
5093
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005094#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA256) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08005095 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
5096 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005097#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA256&&
Jerry Yu909df7b2022-01-22 11:56:27 +08005098 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
5099
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005100#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_MD_CAN_SHA384) && \
Jerry Yu53037892022-01-25 11:02:06 +08005101 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
5102 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005103#endif /* MBEDTLS_ECDSA_C && MBEDTLS_MD_CAN_SHA384&&
Jerry Yu53037892022-01-25 11:02:06 +08005104 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08005105
Gilles Peskine449bd832023-01-11 14:50:10 +01005106#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005107 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005108 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005109#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005110 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005111
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005112#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005113 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005114#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005115
Gabor Mezei15b95a62022-05-09 16:37:58 +02005116 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005117};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005118
Jerry Yu909df7b2022-01-22 11:56:27 +08005119/* NOTICE: see above */
5120#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5121static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005122#if defined(MBEDTLS_MD_CAN_SHA256)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005123#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005125#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005126#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005128#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005129#endif /* MBEDTLS_MD_CAN_SHA256*/
5130#if defined(MBEDTLS_MD_CAN_SHA384)
Gabor Mezeic1051b62022-05-10 13:13:58 +02005131#if defined(MBEDTLS_ECDSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005133#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005134#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005136#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005137#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005138 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005139};
Jerry Yu909df7b2022-01-22 11:56:27 +08005140#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5141
Ronald Crone68ab4f2022-10-05 12:46:29 +02005142#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005143
Brett Warrene0edc842021-08-17 09:53:13 +01005144static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01005145#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005146 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005147#endif
5148#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005149 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005150#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005151 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005152};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005153
Ronald Crone68ab4f2022-10-05 12:46:29 +02005154#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005155/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005156 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005157MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005158static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005159{
5160 size_t i, j;
5161 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005162
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5164 for (j = 0; j < i; j++) {
5165 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005166 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 }
5168 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5169 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5170 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005171 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005172 }
5173 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005175}
5176
Ronald Crone68ab4f2022-10-05 12:46:29 +02005177#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005178
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005179/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005180 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005181 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005182int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5183 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005184{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005185#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005186 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005187#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005188
Ronald Crone68ab4f2022-10-05 12:46:29 +02005189#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5191 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5192 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005193 }
5194
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5196 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5197 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005198 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005199
5200#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5202 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5203 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005204 }
5205
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5207 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5208 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005209 }
5210#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005211#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005212
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005213 /* Use the functions here so that they are covered in tests,
5214 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 mbedtls_ssl_conf_endpoint(conf, endpoint);
5216 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005217
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005218 /*
5219 * Things that are common to all presets
5220 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005221#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005223 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5224#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5225 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5226#endif
5227 }
5228#endif
5229
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005230#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5231 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5232#endif
5233
5234#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5235 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5236#endif
5237
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005238#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005239 conf->f_cookie_write = ssl_cookie_write_dummy;
5240 conf->f_cookie_check = ssl_cookie_check_dummy;
5241#endif
5242
5243#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5244 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5245#endif
5246
Janos Follath088ce432017-04-10 12:42:31 +01005247#if defined(MBEDTLS_SSL_SRV_C)
5248 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005249 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005250#endif
5251
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005252#if defined(MBEDTLS_SSL_PROTO_DTLS)
5253 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5254 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5255#endif
5256
5257#if defined(MBEDTLS_SSL_RENEGOTIATION)
5258 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 memset(conf->renego_period, 0x00, 2);
5260 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005261#endif
5262
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005263#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005265 const unsigned char dhm_p[] =
5266 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5267 const unsigned char dhm_g[] =
5268 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005269
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5271 dhm_p, sizeof(dhm_p),
5272 dhm_g, sizeof(dhm_g))) != 0) {
5273 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005274 }
5275 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005276#endif
5277
Ronald Cron6f135e12021-12-08 16:57:54 +01005278#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005279
5280#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 mbedtls_ssl_tls13_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005282#if defined(MBEDTLS_SSL_SRV_C)
5283 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005284 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005285#endif
5286#endif /* MBEDTLS_SSL_EARLY_DATA */
5287
Jerry Yud0766ec2022-09-22 10:46:57 +08005288#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005289 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005290 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005291#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005292 /*
5293 * Allow all TLS 1.3 key exchange modes by default.
5294 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005295 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005296#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005297
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005299#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005300 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005301 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005302#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005304#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005306#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005308 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5309 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 } else {
5311 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
XiaokangQian4d3a6042022-04-21 13:46:17 +00005312 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5313 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5314 }
5315#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5316 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5317 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5318#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5319 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5320 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5321#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005323#endif
5324 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005325
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005326 /*
5327 * Preset-specific defaults
5328 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005330 /*
5331 * NSA Suite B
5332 */
5333 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005334
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005335 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005336
5337#if defined(MBEDTLS_X509_CRT_PARSE_C)
5338 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005339#endif
5340
Ronald Crone68ab4f2022-10-05 12:46:29 +02005341#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005342#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005344 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005346#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005347 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005348#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005349
Brett Warrene0edc842021-08-17 09:53:13 +01005350#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5351 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005352#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005353 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005354 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005355
5356 /*
5357 * Default
5358 */
5359 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005360
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005361 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005362
5363#if defined(MBEDTLS_X509_CRT_PARSE_C)
5364 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5365#endif
5366
Ronald Crone68ab4f2022-10-05 12:46:29 +02005367#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005368#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005370 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005372#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005374#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005375
Brett Warrene0edc842021-08-17 09:53:13 +01005376#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5377 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005378#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005379 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005380
5381#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5382 conf->dhm_min_bitlen = 1024;
5383#endif
5384 }
5385
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005387}
5388
5389/*
5390 * Free mbedtls_ssl_config
5391 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005392void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005393{
5394#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 mbedtls_mpi_free(&conf->dhm_P);
5396 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005397#endif
5398
Ronald Cron73fe8df2022-10-05 14:31:43 +02005399#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005400#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005402 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5403 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005404#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 if (conf->psk != NULL) {
5406 mbedtls_platform_zeroize(conf->psk, conf->psk_len);
5407 mbedtls_free(conf->psk);
Azim Khan27e8a122018-03-21 14:24:11 +00005408 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005409 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005410 }
5411
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 if (conf->psk_identity != NULL) {
5413 mbedtls_platform_zeroize(conf->psk_identity, conf->psk_identity_len);
5414 mbedtls_free(conf->psk_identity);
Azim Khan27e8a122018-03-21 14:24:11 +00005415 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005416 conf->psk_identity_len = 0;
5417 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005418#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005419
5420#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005422#endif
5423
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005425}
5426
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005427#if defined(MBEDTLS_PK_C) && \
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005428 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_PK_CAN_ECDSA_SOME))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005429/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005430 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005431 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005432unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005433{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005434#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5436 return MBEDTLS_SSL_SIG_RSA;
5437 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005438#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005439#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5441 return MBEDTLS_SSL_SIG_ECDSA;
5442 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005443#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005444 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005445}
5446
Gilles Peskine449bd832023-01-11 14:50:10 +01005447unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005448{
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005450 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005452 case MBEDTLS_PK_ECDSA:
5453 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005455 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005457 }
5458}
5459
Gilles Peskine449bd832023-01-11 14:50:10 +01005460mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005461{
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005463#if defined(MBEDTLS_RSA_C)
5464 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005466#endif
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005467#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005468 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005470#endif
5471 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005473 }
5474}
Valerio Setti1ad9ef22023-02-22 12:38:07 +01005475#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_PK_CAN_ECDSA_SOME ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005476
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005477/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005478 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005479 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005480mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005481{
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005483#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005484 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005486#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005487#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005488 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005490#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005491#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005492 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005494#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005495#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005496 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005498#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005499#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005500 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005502#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005503#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005504 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005506#endif
5507 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005509 }
5510}
5511
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005512/*
5513 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5514 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005515unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005516{
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005518#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005519 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005521#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005522#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005523 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005525#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005526#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005527 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005528 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005529#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005530#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005531 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005533#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005534#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005535 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005537#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005538#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005539 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005540 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005541#endif
5542 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005544 }
5545}
5546
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005547/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005548 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005549 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005550 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005551int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005552{
Gilles Peskine449bd832023-01-11 14:50:10 +01005553 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005554
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 if (group_list == NULL) {
5556 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005557 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005558
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 for (; *group_list != 0; group_list++) {
5560 if (*group_list == tls_id) {
5561 return 0;
5562 }
5563 }
5564
5565 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005566}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005567
5568#if defined(MBEDTLS_ECP_C)
5569/*
5570 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5571 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005572int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005573{
Gilles Peskine449bd832023-01-11 14:50:10 +01005574 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005575
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005577 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005579
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005581}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02005582#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005583
Gilles Peskine449bd832023-01-11 14:50:10 +01005584#if defined(MBEDTLS_DEBUG_C)
Valerio Setti67419f02023-01-04 16:12:42 +01005585#define EC_NAME(_name_) _name_
5586#else
5587#define EC_NAME(_name_) NULL
5588#endif
5589
Valerio Setti18c9fed2022-12-30 17:44:24 +01005590static const struct {
5591 uint16_t tls_id;
5592 mbedtls_ecp_group_id ecp_group_id;
5593 psa_ecc_family_t psa_family;
5594 uint16_t bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 const char *name;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005596} tls_id_match_table[] =
5597{
5598#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521, EC_NAME("secp521r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005600#endif
5601#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512, EC_NAME("brainpoolP512r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005603#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005604#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384, EC_NAME("secp384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005606#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005607#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384, EC_NAME("brainpoolP384r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005609#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005610#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256, EC_NAME("secp256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005612#endif
5613#if defined(MBEDTLS_ECP_DP_SECP256K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256, EC_NAME("secp256k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005615#endif
Valerio Setti67419f02023-01-04 16:12:42 +01005616#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED) || defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005617 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256, EC_NAME("brainpoolP256r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005618#endif
5619#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224, EC_NAME("secp224r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005621#endif
5622#if defined(MBEDTLS_ECP_DP_SECP224K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224, EC_NAME("secp224k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005624#endif
5625#if defined(MBEDTLS_ECP_DP_SECP192R1_ENABLED) || defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192, EC_NAME("secp192r1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005627#endif
5628#if defined(MBEDTLS_ECP_DP_SECP192K1_ENABLED) || defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192, EC_NAME("secp192k1") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005630#endif
5631#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255, EC_NAME("x25519") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005633#endif
5634#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED) || defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448, EC_NAME("x448") },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005636#endif
5637 { 0, MBEDTLS_ECP_DP_NONE, 0, 0, NULL },
5638};
5639
Gilles Peskine449bd832023-01-11 14:50:10 +01005640int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
5641 psa_ecc_family_t *family,
5642 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005643{
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5645 if (tls_id_match_table[i].tls_id == tls_id) {
5646 if (family != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005647 *family = tls_id_match_table[i].psa_family;
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 }
5649 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005650 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005652 return PSA_SUCCESS;
5653 }
5654 }
5655
5656 return PSA_ERROR_NOT_SUPPORTED;
5657}
5658
Gilles Peskine449bd832023-01-11 14:50:10 +01005659mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_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].tls_id != 0; i++) {
5662 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005663 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005664 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005665 }
5666
5667 return MBEDTLS_ECP_DP_NONE;
5668}
5669
Gilles Peskine449bd832023-01-11 14:50:10 +01005670uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005671{
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5673 i++) {
5674 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005675 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005677 }
5678
5679 return 0;
5680}
5681
Valerio Setti67419f02023-01-04 16:12:42 +01005682#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005683const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005684{
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5686 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005687 return tls_id_match_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005688 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005689 }
5690
5691 return NULL;
5692}
Valerio Setti67419f02023-01-04 16:12:42 +01005693#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005695#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005696int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5697 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5698 int cert_endpoint,
5699 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005700{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005701 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005702 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005703 const char *ext_oid;
5704 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005705
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005707 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005709 case MBEDTLS_KEY_EXCHANGE_RSA:
5710 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005711 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005712 break;
5713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005714 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5715 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5716 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5717 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005718 break;
5719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005720 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5721 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005722 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005723 break;
5724
5725 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005726 case MBEDTLS_KEY_EXCHANGE_NONE:
5727 case MBEDTLS_KEY_EXCHANGE_PSK:
5728 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5729 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005730 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005731 usage = 0;
5732 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005734 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5735 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005736 }
5737
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005739 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005740 ret = -1;
5741 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005742
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005744 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5746 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005747 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005749 }
5750
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005752 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005753 ret = -1;
5754 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005755
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005757}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005758#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005759
Jerry Yu148165c2021-09-24 23:20:59 +08005760#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005761int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5762 const mbedtls_md_type_t md,
5763 unsigned char *dst,
5764 size_t dst_len,
5765 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005766{
Ronald Cronf6893e12022-01-07 22:09:01 +01005767 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5768 psa_hash_operation_t *hash_operation_to_clone;
5769 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5770
Jerry Yu148165c2021-09-24 23:20:59 +08005771 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005772
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005774#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005775 case MBEDTLS_MD_SHA384:
5776 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5777 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005778#endif
5779
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005780#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 case MBEDTLS_MD_SHA256:
5782 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5783 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005784#endif
5785
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 default:
5787 goto exit;
5788 }
5789
5790 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5791 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005792 goto exit;
5793 }
5794
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5796 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005797 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005799
5800exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005801#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5802 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005803 (void) ssl;
5804#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005805 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005806}
5807#else /* MBEDTLS_USE_PSA_CRYPTO */
5808
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005809#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005810MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005811static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5812 unsigned char *dst,
5813 size_t dst_len,
5814 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005815{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005816 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005817 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005818
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 if (dst_len < 48) {
5820 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5821 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005822
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005823 mbedtls_md_init(&sha384);
5824 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005825 if (ret != 0) {
5826 goto exit;
5827 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005828 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005829 if (ret != 0) {
5830 goto exit;
5831 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005832
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005833 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005834 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005835 goto exit;
5836 }
5837
5838 *olen = 48;
5839
5840exit:
5841
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005842 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005844}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005845#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005846
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005847#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005848MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005849static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5850 unsigned char *dst,
5851 size_t dst_len,
5852 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005853{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005854 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005855 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005856
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 if (dst_len < 32) {
5858 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5859 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005860
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005861 mbedtls_md_init(&sha256);
5862 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5863 if (ret != 0) {
5864 goto exit;
5865 }
5866 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5867 if (ret != 0) {
5868 goto exit;
5869 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005870
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005871 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5872 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005873 goto exit;
5874 }
5875
5876 *olen = 32;
5877
5878exit:
5879
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005880 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005881 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005882}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005883#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005884
Gilles Peskine449bd832023-01-11 14:50:10 +01005885int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5886 const mbedtls_md_type_t md,
5887 unsigned char *dst,
5888 size_t dst_len,
5889 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005890{
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005892
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005893#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 case MBEDTLS_MD_SHA384:
5895 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005896#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005897
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005898#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005899 case MBEDTLS_MD_SHA256:
5900 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005901#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005902
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005904#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5905 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 (void) ssl;
5907 (void) dst;
5908 (void) dst_len;
5909 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005910#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005911 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005912 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005914}
XiaokangQian647719a2021-12-07 09:16:29 +00005915
Jerry Yu148165c2021-09-24 23:20:59 +08005916#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005917
Ronald Crone68ab4f2022-10-05 12:46:29 +02005918#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005919/* mbedtls_ssl_parse_sig_alg_ext()
5920 *
5921 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5922 * value (TLS 1.3 RFC8446):
5923 * enum {
5924 * ....
5925 * ecdsa_secp256r1_sha256( 0x0403 ),
5926 * ecdsa_secp384r1_sha384( 0x0503 ),
5927 * ecdsa_secp521r1_sha512( 0x0603 ),
5928 * ....
5929 * } SignatureScheme;
5930 *
5931 * struct {
5932 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5933 * } SignatureSchemeList;
5934 *
5935 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5936 * value (TLS 1.2 RFC5246):
5937 * enum {
5938 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5939 * sha512(6), (255)
5940 * } HashAlgorithm;
5941 *
5942 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5943 * SignatureAlgorithm;
5944 *
5945 * struct {
5946 * HashAlgorithm hash;
5947 * SignatureAlgorithm signature;
5948 * } SignatureAndHashAlgorithm;
5949 *
5950 * SignatureAndHashAlgorithm
5951 * supported_signature_algorithms<2..2^16-2>;
5952 *
5953 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5954 * generalization of the TLS 1.2 signature algorithm extension.
5955 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5956 * `SignatureScheme` field of TLS 1.3
5957 *
5958 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005959int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5960 const unsigned char *buf,
5961 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005962{
5963 const unsigned char *p = buf;
5964 size_t supported_sig_algs_len = 0;
5965 const unsigned char *supported_sig_algs_end;
5966 uint16_t sig_alg;
5967 uint32_t common_idx = 0;
5968
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5970 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005971 p += 2;
5972
Gilles Peskine449bd832023-01-11 14:50:10 +01005973 memset(ssl->handshake->received_sig_algs, 0,
5974 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005975
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005977 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005978 while (p < supported_sig_algs_end) {
5979 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5980 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005981 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5983 sig_alg,
5984 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005985#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5987 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5988 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005989 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005990 }
5991#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005992
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5994 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005995
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005997 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5998 common_idx += 1;
5999 }
6000 }
6001 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 if (p != end) {
6003 MBEDTLS_SSL_DEBUG_MSG(1,
6004 ("Signature algorithms extension length misaligned"));
6005 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6006 MBEDTLS_ERR_SSL_DECODE_ERROR);
6007 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006008 }
6009
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 if (common_idx == 0) {
6011 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6012 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6013 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6014 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006015 }
6016
Gabor Mezei15b95a62022-05-09 16:37:58 +02006017 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006019}
6020
Ronald Crone68ab4f2022-10-05 12:46:29 +02006021#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006022
Jerry Yudc7bd172022-02-17 13:44:15 +08006023#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6024
6025#if defined(MBEDTLS_USE_PSA_CRYPTO)
6026
Gilles Peskine449bd832023-01-11 14:50:10 +01006027static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6028 mbedtls_svc_key_id_t key,
6029 psa_algorithm_t alg,
6030 const unsigned char *raw_psk, size_t raw_psk_length,
6031 const unsigned char *seed, size_t seed_length,
6032 const unsigned char *label, size_t label_length,
6033 const unsigned char *other_secret,
6034 size_t other_secret_length,
6035 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006036{
6037 psa_status_t status;
6038
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 status = psa_key_derivation_setup(derivation, alg);
6040 if (status != PSA_SUCCESS) {
6041 return status;
6042 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006043
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6045 status = psa_key_derivation_input_bytes(derivation,
6046 PSA_KEY_DERIVATION_INPUT_SEED,
6047 seed, seed_length);
6048 if (status != PSA_SUCCESS) {
6049 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006050 }
6051
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 if (other_secret != NULL) {
6053 status = psa_key_derivation_input_bytes(derivation,
6054 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6055 other_secret, other_secret_length);
6056 if (status != PSA_SUCCESS) {
6057 return status;
6058 }
6059 }
6060
6061 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006062 status = psa_key_derivation_input_bytes(
6063 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 raw_psk, raw_psk_length);
6065 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006066 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006068 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 if (status != PSA_SUCCESS) {
6070 return status;
6071 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006072
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 status = psa_key_derivation_input_bytes(derivation,
6074 PSA_KEY_DERIVATION_INPUT_LABEL,
6075 label, label_length);
6076 if (status != PSA_SUCCESS) {
6077 return status;
6078 }
6079 } else {
6080 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006081 }
6082
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 status = psa_key_derivation_set_capacity(derivation, capacity);
6084 if (status != PSA_SUCCESS) {
6085 return status;
6086 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006087
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006089}
6090
Andrzej Kurek57d10632022-10-24 10:32:01 -04006091#if defined(PSA_WANT_ALG_SHA_384) || \
6092 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006093MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006094static int tls_prf_generic(mbedtls_md_type_t md_type,
6095 const unsigned char *secret, size_t slen,
6096 const char *label,
6097 const unsigned char *random, size_t rlen,
6098 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006099{
6100 psa_status_t status;
6101 psa_algorithm_t alg;
6102 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6103 psa_key_derivation_operation_t derivation =
6104 PSA_KEY_DERIVATION_OPERATION_INIT;
6105
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006107 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006109 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006111
6112 /* Normally a "secret" should be long enough to be impossible to
6113 * find by brute force, and in particular should not be empty. But
6114 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6115 * and for this use case it makes sense to have a 0-length "secret".
6116 * Since the key API doesn't allow importing a key of length 0,
6117 * keep master_key=0, which setup_psa_key_derivation() understands
6118 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006120 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6122 psa_set_key_algorithm(&key_attributes, alg);
6123 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006124
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6126 if (status != PSA_SUCCESS) {
6127 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6128 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006129 }
6130
Gilles Peskine449bd832023-01-11 14:50:10 +01006131 status = setup_psa_key_derivation(&derivation,
6132 master_key, alg,
6133 NULL, 0,
6134 random, rlen,
6135 (unsigned char const *) label,
6136 (size_t) strlen(label),
6137 NULL, 0,
6138 dlen);
6139 if (status != PSA_SUCCESS) {
6140 psa_key_derivation_abort(&derivation);
6141 psa_destroy_key(master_key);
6142 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006143 }
6144
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6146 if (status != PSA_SUCCESS) {
6147 psa_key_derivation_abort(&derivation);
6148 psa_destroy_key(master_key);
6149 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006150 }
6151
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 status = psa_key_derivation_abort(&derivation);
6153 if (status != PSA_SUCCESS) {
6154 psa_destroy_key(master_key);
6155 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006156 }
6157
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 if (!mbedtls_svc_key_id_is_null(master_key)) {
6159 status = psa_destroy_key(master_key);
6160 }
6161 if (status != PSA_SUCCESS) {
6162 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6163 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006164
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006166}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006167#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006168#else /* MBEDTLS_USE_PSA_CRYPTO */
6169
Andrzej Kurek57d10632022-10-24 10:32:01 -04006170#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006171 (defined(MBEDTLS_MD_CAN_SHA256) || \
6172 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006173MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006174static int tls_prf_generic(mbedtls_md_type_t md_type,
6175 const unsigned char *secret, size_t slen,
6176 const char *label,
6177 const unsigned char *random, size_t rlen,
6178 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006179{
6180 size_t nb;
6181 size_t i, j, k, md_len;
6182 unsigned char *tmp;
6183 size_t tmp_len = 0;
6184 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6185 const mbedtls_md_info_t *md_info;
6186 mbedtls_md_context_t md_ctx;
6187 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6188
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006190
Gilles Peskine449bd832023-01-11 14:50:10 +01006191 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6192 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6193 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006194
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006196
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 tmp_len = md_len + strlen(label) + rlen;
6198 tmp = mbedtls_calloc(1, tmp_len);
6199 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006200 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6201 goto exit;
6202 }
6203
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 nb = strlen(label);
6205 memcpy(tmp + md_len, label, nb);
6206 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006207 nb += rlen;
6208
6209 /*
6210 * Compute P_<hash>(secret, label + random)[0..dlen]
6211 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006213 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006215
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6217 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006218 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 }
6220 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6221 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006222 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 }
6224 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6225 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006226 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006228
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 for (i = 0; i < dlen; i += md_len) {
6230 ret = mbedtls_md_hmac_reset(&md_ctx);
6231 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006232 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 }
6234 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6235 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006236 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 }
6238 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6239 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006240 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006242
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 ret = mbedtls_md_hmac_reset(&md_ctx);
6244 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006245 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 }
6247 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6248 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006249 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 }
6251 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6252 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006253 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006255
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006257
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006259 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006261 }
6262
6263exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006265
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 if (tmp != NULL) {
6267 mbedtls_platform_zeroize(tmp, tmp_len);
6268 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006269
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006271
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006273
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006275}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006276#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006277#endif /* MBEDTLS_USE_PSA_CRYPTO */
6278
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006279#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006280MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006281static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6282 const char *label,
6283 const unsigned char *random, size_t rlen,
6284 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006285{
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6287 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006288}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006289#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006290
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006291#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006292MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006293static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6294 const char *label,
6295 const unsigned char *random, size_t rlen,
6296 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006297{
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6299 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006300}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006301#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006302
Jerry Yuf009d862022-02-17 14:01:37 +08006303/*
6304 * Set appropriate PRF function and other SSL / TLS1.2 functions
6305 *
6306 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006307 * - hash associated with the ciphersuite (only used by TLS 1.2)
6308 *
6309 * Outputs:
6310 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6311 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006312MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006313static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6314 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006315{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006316#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006318 handshake->tls_prf = tls_prf_sha384;
6319 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6320 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006322#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006323#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006324 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006325 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006326 handshake->tls_prf = tls_prf_sha256;
6327 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6328 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6329 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006330#else
Jerry Yuf009d862022-02-17 14:01:37 +08006331 {
Jerry Yuf009d862022-02-17 14:01:37 +08006332 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006333 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006335 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006336#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006337
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006339}
Jerry Yud6ab2352022-02-17 14:03:43 +08006340
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006341/*
6342 * Compute master secret if needed
6343 *
6344 * Parameters:
6345 * [in/out] handshake
6346 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6347 * (PSA-PSK) ciphersuite_info, psk_opaque
6348 * [out] premaster (cleared)
6349 * [out] master
6350 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6351 * debug: conf->f_dbg, conf->p_dbg
6352 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006353 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006354 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006355MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006356static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6357 unsigned char *master,
6358 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006359{
6360 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6361
6362 /* cf. RFC 5246, Section 8.1:
6363 * "The master secret is always exactly 48 bytes in length." */
6364 size_t const master_secret_len = 48;
6365
6366#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6367 unsigned char session_hash[48];
6368#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6369
6370 /* The label for the KDF used for key expansion.
6371 * This is either "master secret" or "extended master secret"
6372 * depending on whether the Extended Master Secret extension
6373 * is used. */
6374 char const *lbl = "master secret";
6375
Przemek Stekielae4ed302022-04-05 17:15:55 +02006376 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006377 * - If the Extended Master Secret extension is not used,
6378 * this is ClientHello.Random + ServerHello.Random
6379 * (see Sect. 8.1 in RFC 5246).
6380 * - If the Extended Master Secret extension is used,
6381 * this is the transcript of the handshake so far.
6382 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006383 unsigned char const *seed = handshake->randbytes;
6384 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006385
6386#if !defined(MBEDTLS_DEBUG_C) && \
6387 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6388 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006390 ssl = NULL; /* make sure we don't use it except for those cases */
6391 (void) ssl;
6392#endif
6393
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 if (handshake->resume != 0) {
6395 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6396 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006397 }
6398
6399#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006401 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006402 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006403 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6404 if (ret != 0) {
6405 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6406 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006407
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6409 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006410 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006411#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006412
Przemek Stekiel99114f32022-04-22 11:20:09 +02006413#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006414 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006416 /* Perform PSK-to-MS expansion in a single step. */
6417 psa_status_t status;
6418 psa_algorithm_t alg;
6419 mbedtls_svc_key_id_t psk;
6420 psa_key_derivation_operation_t derivation =
6421 PSA_KEY_DERIVATION_OPERATION_INIT;
6422 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6423
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006427
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006429 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006431 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006432 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006433
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006434 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006436
Gilles Peskine449bd832023-01-11 14:50:10 +01006437 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006438 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006439 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006440 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006441 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006442 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006443 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006444 other_secret_len = 48;
6445 other_secret = handshake->premaster + 2;
6446 break;
6447 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006448 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006449 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6450 other_secret = handshake->premaster + 2;
6451 break;
6452 default:
6453 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006454 }
6455
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 status = setup_psa_key_derivation(&derivation, psk, alg,
6457 ssl->conf->psk, ssl->conf->psk_len,
6458 seed, seed_len,
6459 (unsigned char const *) lbl,
6460 (size_t) strlen(lbl),
6461 other_secret, other_secret_len,
6462 master_secret_len);
6463 if (status != PSA_SUCCESS) {
6464 psa_key_derivation_abort(&derivation);
6465 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006466 }
6467
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 status = psa_key_derivation_output_bytes(&derivation,
6469 master,
6470 master_secret_len);
6471 if (status != PSA_SUCCESS) {
6472 psa_key_derivation_abort(&derivation);
6473 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006474 }
6475
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 status = psa_key_derivation_abort(&derivation);
6477 if (status != PSA_SUCCESS) {
6478 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6479 }
6480 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006481#endif
6482 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006483#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6485 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006486 psa_status_t status;
6487 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6488 psa_key_derivation_operation_t derivation =
6489 PSA_KEY_DERIVATION_OPERATION_INIT;
6490
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006492
6493 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6494
Gilles Peskine449bd832023-01-11 14:50:10 +01006495 status = psa_key_derivation_setup(&derivation, alg);
6496 if (status != PSA_SUCCESS) {
6497 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006498 }
6499
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 status = psa_key_derivation_set_capacity(&derivation,
6501 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6502 if (status != PSA_SUCCESS) {
6503 psa_key_derivation_abort(&derivation);
6504 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006505 }
6506
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6508 &derivation);
6509 if (status != PSA_SUCCESS) {
6510 psa_key_derivation_abort(&derivation);
6511 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006512 }
6513
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 status = psa_key_derivation_output_bytes(&derivation,
6515 handshake->premaster,
6516 handshake->pmslen);
6517 if (status != PSA_SUCCESS) {
6518 psa_key_derivation_abort(&derivation);
6519 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6520 }
6521
6522 status = psa_key_derivation_abort(&derivation);
6523 if (status != PSA_SUCCESS) {
6524 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006525 }
6526 }
6527#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6529 lbl, seed, seed_len,
6530 master,
6531 master_secret_len);
6532 if (ret != 0) {
6533 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6534 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006535 }
6536
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6538 handshake->premaster,
6539 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006540
Gilles Peskine449bd832023-01-11 14:50:10 +01006541 mbedtls_platform_zeroize(handshake->premaster,
6542 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006543 }
6544
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006546}
6547
Gilles Peskine449bd832023-01-11 14:50:10 +01006548int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006549{
6550 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6551 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6552 ssl->handshake->ciphersuite_info;
6553
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006555
6556 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 ret = ssl_set_handshake_prfs(ssl->handshake,
6558 ciphersuite_info->mac);
6559 if (ret != 0) {
6560 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6561 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006562 }
6563
6564 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 ret = ssl_compute_master(ssl->handshake,
6566 ssl->session_negotiate->master,
6567 ssl);
6568 if (ret != 0) {
6569 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6570 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006571 }
6572
6573 /* Swap the client and server random values:
6574 * - MS derivation wanted client+server (RFC 5246 8.1)
6575 * - key derivation wants server+client (RFC 5246 6.3) */
6576 {
6577 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006578 memcpy(tmp, ssl->handshake->randbytes, 64);
6579 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6580 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6581 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006582 }
6583
6584 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6586 ssl->session_negotiate->ciphersuite,
6587 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006588#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006589 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006590#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 ssl->handshake->tls_prf,
6592 ssl->handshake->randbytes,
6593 ssl->tls_version,
6594 ssl->conf->endpoint,
6595 ssl);
6596 if (ret != 0) {
6597 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6598 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006599 }
6600
6601 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006602 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6603 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006604
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006606
Gilles Peskine449bd832023-01-11 14:50:10 +01006607 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006608}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006609
Gilles Peskine449bd832023-01-11 14:50:10 +01006610int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006611{
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006613#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006614 case MBEDTLS_SSL_HASH_SHA384:
6615 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6616 break;
6617#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006618#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006619 case MBEDTLS_SSL_HASH_SHA256:
6620 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6621 break;
6622#endif
6623 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006625 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006626#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6627 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006628 (void) ssl;
6629#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006630 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006631}
6632
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006633#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006634int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6635 unsigned char *hash,
6636 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006637{
6638#if defined(MBEDTLS_USE_PSA_CRYPTO)
6639 size_t hash_size;
6640 psa_status_t status;
6641 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
6642
Gilles Peskine449bd832023-01-11 14:50:10 +01006643 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify sha256"));
6644 status = psa_hash_clone(&ssl->handshake->fin_sha256_psa, &sha256_psa);
6645 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006646 goto exit;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006647 }
6648
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 status = psa_hash_finish(&sha256_psa, hash, 32, &hash_size);
6650 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006651 goto exit;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006652 }
6653
6654 *hlen = 32;
Gilles Peskine449bd832023-01-11 14:50:10 +01006655 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6656 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006657
6658exit:
6659 psa_hash_abort(&sha256_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05006660 return PSA_TO_MD_ERR(status);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006661#else
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006662 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006663 mbedtls_md_context_t sha256;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006664
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006665 mbedtls_md_init(&sha256);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006666
Gilles Peskine449bd832023-01-11 14:50:10 +01006667 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify sha256"));
Jerry Yu8392e0d2022-02-17 14:10:24 +08006668
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006669 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6670 if (ret != 0) {
6671 goto exit;
6672 }
6673 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6674 if (ret != 0) {
6675 goto exit;
6676 }
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006677
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006678 ret = mbedtls_md_finish(&sha256, hash);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006679 if (ret != 0) {
6680 goto exit;
6681 }
Jerry Yu8392e0d2022-02-17 14:10:24 +08006682
6683 *hlen = 32;
6684
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6686 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
Jerry Yu8392e0d2022-02-17 14:10:24 +08006687
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006688exit:
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006689 mbedtls_md_free(&sha256);
Manuel Pégourié-Gonnard8e176f72023-02-09 10:33:54 +01006690 return ret;
Jerry Yu8392e0d2022-02-17 14:10:24 +08006691#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006692}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006693#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006694
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006695#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006696int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6697 unsigned char *hash,
6698 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006699{
6700#if defined(MBEDTLS_USE_PSA_CRYPTO)
6701 size_t hash_size;
6702 psa_status_t status;
6703 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
6704
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify sha384"));
6706 status = psa_hash_clone(&ssl->handshake->fin_sha384_psa, &sha384_psa);
6707 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006708 goto exit;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006709 }
6710
Gilles Peskine449bd832023-01-11 14:50:10 +01006711 status = psa_hash_finish(&sha384_psa, hash, 48, &hash_size);
6712 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006713 goto exit;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006714 }
6715
6716 *hlen = 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006717 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6718 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006719
6720exit:
6721 psa_hash_abort(&sha384_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05006722 return PSA_TO_MD_ERR(status);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006723#else
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006724 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006725 mbedtls_md_context_t sha384;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006726
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006727 mbedtls_md_init(&sha384);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006728
Gilles Peskine449bd832023-01-11 14:50:10 +01006729 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify sha384"));
Jerry Yuc1cb3842022-02-17 14:13:48 +08006730
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006731 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006732 if (ret != 0) {
6733 goto exit;
6734 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006735 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006736 if (ret != 0) {
6737 goto exit;
6738 }
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006739
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006740 ret = mbedtls_md_finish(&sha384, hash);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006741 if (ret != 0) {
6742 goto exit;
6743 }
Jerry Yuc1cb3842022-02-17 14:13:48 +08006744
6745 *hlen = 48;
6746
Gilles Peskine449bd832023-01-11 14:50:10 +01006747 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6748 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
Jerry Yuc1cb3842022-02-17 14:13:48 +08006749
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006750exit:
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006751 mbedtls_md_free(&sha384);
Manuel Pégourié-Gonnardb9b564e2023-02-06 10:06:04 +01006752 return ret;
Jerry Yuc1cb3842022-02-17 14:13:48 +08006753#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006754}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006755#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006756
Neil Armstrong80f6f322022-05-03 17:56:38 +02006757#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6758 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006759int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006760{
6761 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006763 const unsigned char *psk = NULL;
6764 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006766
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006768 /*
6769 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006770 * checked before calling this function.
6771 *
6772 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006773 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006774 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6776 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6777 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006778 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006779 }
6780
6781 /*
6782 * PMS = struct {
6783 * opaque other_secret<0..2^16-1>;
6784 * opaque psk<0..2^16-1>;
6785 * };
6786 * with "other_secret" depending on the particular key exchange
6787 */
6788#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6790 if (end - p < 2) {
6791 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6792 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006793
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006795 p += 2;
6796
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 if (end < p || (size_t) (end - p) < psk_len) {
6798 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6799 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006800
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006802 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006804#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6805#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006807 /*
6808 * other_secret already set by the ClientKeyExchange message,
6809 * and is 48 bytes long
6810 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 if (end - p < 2) {
6812 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6813 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006814
6815 *p++ = 0;
6816 *p++ = 48;
6817 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006819#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6820#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006822 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6823 size_t len;
6824
6825 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6827 p + 2, end - (p + 2), &len,
6828 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6829 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6830 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006831 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006833 p += 2 + len;
6834
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6836 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006837#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006838#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006839 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006840 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6841 size_t zlen;
6842
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6844 p + 2, end - (p + 2),
6845 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6846 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6847 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006848 }
6849
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006851 p += 2 + zlen;
6852
Gilles Peskine449bd832023-01-11 14:50:10 +01006853 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6854 MBEDTLS_DEBUG_ECDH_Z);
6855 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006856#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006857 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6859 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006860 }
6861
6862 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 if (end - p < 2) {
6864 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6865 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006866
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006868 p += 2;
6869
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 if (end < p || (size_t) (end - p) < psk_len) {
6871 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6872 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006873
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006875 p += psk_len;
6876
6877 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6878
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006880}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006881#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006882
6883#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006884MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006885static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006886
6887#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006888int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006889{
6890 /* If renegotiation is not enforced, retransmit until we would reach max
6891 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006893 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6894 unsigned char doublings = 1;
6895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006897 ++doublings;
6898 ratio >>= 1;
6899 }
6900
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 if (++ssl->renego_records_seen > doublings) {
6902 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6903 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006904 }
6905 }
6906
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006908}
6909#endif
6910#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006911
Jerry Yud9526692022-02-17 14:23:47 +08006912/*
6913 * Handshake functions
6914 */
6915#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6916/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006917int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006918{
6919 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6920 ssl->handshake->ciphersuite_info;
6921
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006923
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6925 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006926 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006928 }
6929
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6931 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006932}
6933
Gilles Peskine449bd832023-01-11 14:50:10 +01006934int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006935{
6936 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6937 ssl->handshake->ciphersuite_info;
6938
Gilles Peskine449bd832023-01-11 14:50:10 +01006939 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006940
Gilles Peskine449bd832023-01-11 14:50:10 +01006941 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6942 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006943 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006944 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006945 }
6946
Gilles Peskine449bd832023-01-11 14:50:10 +01006947 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6948 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006949}
6950
6951#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6952/* Some certificate support -> implement write and parse */
6953
Gilles Peskine449bd832023-01-11 14:50:10 +01006954int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006955{
6956 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6957 size_t i, n;
6958 const mbedtls_x509_crt *crt;
6959 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6960 ssl->handshake->ciphersuite_info;
6961
Gilles Peskine449bd832023-01-11 14:50:10 +01006962 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006963
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6965 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006966 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006967 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006968 }
6969
6970#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6972 if (ssl->handshake->client_auth == 0) {
6973 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006974 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006975 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006976 }
6977 }
6978#endif /* MBEDTLS_SSL_CLI_C */
6979#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006980 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6981 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006982 /* Should never happen because we shouldn't have picked the
6983 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006985 }
6986 }
6987#endif
6988
Gilles Peskine449bd832023-01-11 14:50:10 +01006989 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006990
6991 /*
6992 * 0 . 0 handshake type
6993 * 1 . 3 handshake length
6994 * 4 . 6 length of all certs
6995 * 7 . 9 length of cert. 1
6996 * 10 . n-1 peer certificate
6997 * n . n+2 length of cert. 2
6998 * n+3 . ... upper level cert, etc.
6999 */
7000 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007002
Gilles Peskine449bd832023-01-11 14:50:10 +01007003 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007004 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007005 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7006 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7007 " > %" MBEDTLS_PRINTF_SIZET,
7008 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7009 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007010 }
7011
Gilles Peskine449bd832023-01-11 14:50:10 +01007012 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7013 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7014 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007015
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007017 i += n; crt = crt->next;
7018 }
7019
Gilles Peskine449bd832023-01-11 14:50:10 +01007020 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7021 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7022 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007023
7024 ssl->out_msglen = i;
7025 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7026 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7027
7028 ssl->state++;
7029
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7031 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7032 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007033 }
7034
Gilles Peskine449bd832023-01-11 14:50:10 +01007035 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007036
Gilles Peskine449bd832023-01-11 14:50:10 +01007037 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007038}
7039
7040#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7041
7042#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007043MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007044static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7045 unsigned char *crt_buf,
7046 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007047{
7048 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7049
Gilles Peskine449bd832023-01-11 14:50:10 +01007050 if (peer_crt == NULL) {
7051 return -1;
7052 }
Jerry Yud9526692022-02-17 14:23:47 +08007053
Gilles Peskine449bd832023-01-11 14:50:10 +01007054 if (peer_crt->raw.len != crt_buf_len) {
7055 return -1;
7056 }
Jerry Yud9526692022-02-17 14:23:47 +08007057
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007059}
7060#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007061MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007062static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7063 unsigned char *crt_buf,
7064 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007065{
7066 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7067 unsigned char const * const peer_cert_digest =
7068 ssl->session->peer_cert_digest;
7069 mbedtls_md_type_t const peer_cert_digest_type =
7070 ssl->session->peer_cert_digest_type;
7071 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007072 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007073 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7074 size_t digest_len;
7075
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 if (peer_cert_digest == NULL || digest_info == NULL) {
7077 return -1;
7078 }
Jerry Yud9526692022-02-17 14:23:47 +08007079
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 digest_len = mbedtls_md_get_size(digest_info);
7081 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7082 return -1;
7083 }
Jerry Yud9526692022-02-17 14:23:47 +08007084
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7086 if (ret != 0) {
7087 return -1;
7088 }
Jerry Yud9526692022-02-17 14:23:47 +08007089
Gilles Peskine449bd832023-01-11 14:50:10 +01007090 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007091}
7092#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7093#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7094
7095/*
7096 * Once the certificate message is read, parse it into a cert chain and
7097 * perform basic checks, but leave actual verification to the caller
7098 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007099MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007100static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7101 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007102{
7103 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7104#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007106#endif
7107 size_t i, n;
7108 uint8_t alert;
7109
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7111 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7112 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7113 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7114 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007115 }
7116
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7118 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7119 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7120 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007121 }
7122
Gilles Peskine449bd832023-01-11 14:50:10 +01007123 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7124 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7125 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7126 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7127 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007128 }
7129
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007131
7132 /*
7133 * Same message structure as in mbedtls_ssl_write_certificate()
7134 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007136
Gilles Peskine449bd832023-01-11 14:50:10 +01007137 if (ssl->in_msg[i] != 0 ||
7138 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7139 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7140 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7141 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7142 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007143 }
7144
7145 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7146 i += 3;
7147
7148 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007150 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 if (i + 3 > ssl->in_hslen) {
7152 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7153 mbedtls_ssl_send_alert_message(ssl,
7154 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7155 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7156 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007157 }
7158 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7159 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 if (ssl->in_msg[i] != 0) {
7161 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7162 mbedtls_ssl_send_alert_message(ssl,
7163 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7164 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7165 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007166 }
7167
7168 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007170 | (unsigned int) ssl->in_msg[i + 2];
7171 i += 3;
7172
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 if (n < 128 || i + n > ssl->in_hslen) {
7174 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7175 mbedtls_ssl_send_alert_message(ssl,
7176 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7177 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7178 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007179 }
7180
7181 /* Check if we're handling the first CRT in the chain. */
7182#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007183 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007184 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007186 /* During client-side renegotiation, check that the server's
7187 * end-CRTs hasn't changed compared to the initial handshake,
7188 * mitigating the triple handshake attack. On success, reuse
7189 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007190 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7191 if (ssl_check_peer_crt_unchanged(ssl,
7192 &ssl->in_msg[i],
7193 n) != 0) {
7194 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7195 mbedtls_ssl_send_alert_message(ssl,
7196 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7197 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7198 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007199 }
7200
7201 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007203 }
7204#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7205
7206 /* Parse the next certificate in the chain. */
7207#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007209#else
7210 /* If we don't need to store the CRT chain permanently, parse
7211 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007212 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007213#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007215 case 0: /*ok*/
7216 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7217 /* Ignore certificate with an unknown algorithm: maybe a
7218 prior certificate was already trusted. */
7219 break;
7220
7221 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7222 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7223 goto crt_parse_der_failed;
7224
7225 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7226 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7227 goto crt_parse_der_failed;
7228
7229 default:
7230 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007231crt_parse_der_failed:
7232 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7233 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7234 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007235 }
7236
7237 i += n;
7238 }
7239
Gilles Peskine449bd832023-01-11 14:50:10 +01007240 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7241 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007242}
7243
7244#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007245MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007246static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007247{
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7249 return -1;
7250 }
Jerry Yud9526692022-02-17 14:23:47 +08007251
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007253 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7254 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7256 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7257 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007258 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007260}
7261#endif /* MBEDTLS_SSL_SRV_C */
7262
7263/* Check if a certificate message is expected.
7264 * Return either
7265 * - SSL_CERTIFICATE_EXPECTED, or
7266 * - SSL_CERTIFICATE_SKIP
7267 * indicating whether a Certificate message is expected or not.
7268 */
7269#define SSL_CERTIFICATE_EXPECTED 0
7270#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007271MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007272static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7273 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007274{
7275 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7276 ssl->handshake->ciphersuite_info;
7277
Gilles Peskine449bd832023-01-11 14:50:10 +01007278 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7279 return SSL_CERTIFICATE_SKIP;
7280 }
Jerry Yud9526692022-02-17 14:23:47 +08007281
7282#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007283 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7284 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7285 return SSL_CERTIFICATE_SKIP;
7286 }
Jerry Yud9526692022-02-17 14:23:47 +08007287
Gilles Peskine449bd832023-01-11 14:50:10 +01007288 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007289 ssl->session_negotiate->verify_result =
7290 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007291 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007292 }
7293 }
7294#else
7295 ((void) authmode);
7296#endif /* MBEDTLS_SSL_SRV_C */
7297
Gilles Peskine449bd832023-01-11 14:50:10 +01007298 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007299}
7300
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007301MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007302static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7303 int authmode,
7304 mbedtls_x509_crt *chain,
7305 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007306{
7307 int ret = 0;
7308 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7309 ssl->handshake->ciphersuite_info;
7310 int have_ca_chain = 0;
7311
7312 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7313 void *p_vrfy;
7314
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7316 return 0;
7317 }
Jerry Yud9526692022-02-17 14:23:47 +08007318
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 if (ssl->f_vrfy != NULL) {
7320 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007321 f_vrfy = ssl->f_vrfy;
7322 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 } else {
7324 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007325 f_vrfy = ssl->conf->f_vrfy;
7326 p_vrfy = ssl->conf->p_vrfy;
7327 }
7328
7329 /*
7330 * Main check: verify certificate
7331 */
7332#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007333 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007334 ((void) rs_ctx);
7335 have_ca_chain = 1;
7336
Gilles Peskine449bd832023-01-11 14:50:10 +01007337 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007338 ret = mbedtls_x509_crt_verify_with_ca_cb(
7339 chain,
7340 ssl->conf->f_ca_cb,
7341 ssl->conf->p_ca_cb,
7342 ssl->conf->cert_profile,
7343 ssl->hostname,
7344 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007345 f_vrfy, p_vrfy);
7346 } else
Jerry Yud9526692022-02-17 14:23:47 +08007347#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7348 {
7349 mbedtls_x509_crt *ca_chain;
7350 mbedtls_x509_crl *ca_crl;
7351
7352#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007354 ca_chain = ssl->handshake->sni_ca_chain;
7355 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 } else
Jerry Yud9526692022-02-17 14:23:47 +08007357#endif
7358 {
7359 ca_chain = ssl->conf->ca_chain;
7360 ca_crl = ssl->conf->ca_crl;
7361 }
7362
Gilles Peskine449bd832023-01-11 14:50:10 +01007363 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007364 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 }
Jerry Yud9526692022-02-17 14:23:47 +08007366
7367 ret = mbedtls_x509_crt_verify_restartable(
7368 chain,
7369 ca_chain, ca_crl,
7370 ssl->conf->cert_profile,
7371 ssl->hostname,
7372 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007374 }
7375
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 if (ret != 0) {
7377 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007378 }
7379
7380#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7382 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7383 }
Jerry Yud9526692022-02-17 14:23:47 +08007384#endif
7385
7386 /*
7387 * Secondary checks: always done, but change 'ret' only if it was 0
7388 */
7389
7390#if defined(MBEDTLS_ECP_C)
7391 {
7392 const mbedtls_pk_context *pk = &chain->pk;
7393
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007394 /* If certificate uses an EC key, make sure the curve is OK.
7395 * This is a public key, so it can't be opaque, so can_do() is a good
7396 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007398 /* and in the unlikely case the above assumption no longer holds
7399 * we are making sure that pk_ec() here does not return a NULL
7400 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 const mbedtls_ecp_keypair *ec = mbedtls_pk_ec(*pk);
7402 if (ec == NULL) {
7403 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_pk_ec() returned NULL"));
7404 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007405 }
Jerry Yud9526692022-02-17 14:23:47 +08007406
Gilles Peskine449bd832023-01-11 14:50:10 +01007407 if (mbedtls_ssl_check_curve(ssl, ec->grp.id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007408 ssl->session_negotiate->verify_result |=
7409 MBEDTLS_X509_BADCERT_BAD_KEY;
7410
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7412 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007413 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007415 }
Jerry Yud9526692022-02-17 14:23:47 +08007416 }
7417 }
7418#endif /* MBEDTLS_ECP_C */
7419
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 if (mbedtls_ssl_check_cert_usage(chain,
7421 ciphersuite_info,
7422 !ssl->conf->endpoint,
7423 &ssl->session_negotiate->verify_result) != 0) {
7424 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7425 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007426 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 }
Jerry Yud9526692022-02-17 14:23:47 +08007428 }
7429
7430 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7431 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7432 * with details encoded in the verification flags. All other kinds
7433 * of error codes, including those from the user provided f_vrfy
7434 * functions, are treated as fatal and lead to a failure of
7435 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7437 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7438 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007439 ret = 0;
7440 }
7441
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7443 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007444 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7445 }
7446
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007448 uint8_t alert;
7449
7450 /* The certificate may have been rejected for several reasons.
7451 Pick one and send the corresponding alert. Which alert to send
7452 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007454 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007456 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007458 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007460 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007462 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007464 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007466 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007468 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007470 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007472 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007474 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007475 }
7476 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7477 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007478 }
7479
7480#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 if (ssl->session_negotiate->verify_result != 0) {
7482 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7483 (unsigned int) ssl->session_negotiate->verify_result));
7484 } else {
7485 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007486 }
7487#endif /* MBEDTLS_DEBUG_C */
7488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007490}
7491
7492#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007493MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007494static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7495 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007496{
7497 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7498 /* Remember digest of the peer's end-CRT. */
7499 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7501 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7502 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7503 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7504 mbedtls_ssl_send_alert_message(ssl,
7505 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7506 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007507
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007509 }
7510
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 ret = mbedtls_md(mbedtls_md_info_from_type(
7512 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7513 start, len,
7514 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007515
7516 ssl->session_negotiate->peer_cert_digest_type =
7517 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7518 ssl->session_negotiate->peer_cert_digest_len =
7519 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7520
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007522}
7523
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007524MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007525static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7526 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007527{
7528 unsigned char *end = start + len;
7529 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7530
7531 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7533 ret = mbedtls_pk_parse_subpubkey(&start, end,
7534 &ssl->handshake->peer_pubkey);
7535 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007536 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007538 }
7539
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007541}
7542#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7543
Gilles Peskine449bd832023-01-11 14:50:10 +01007544int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007545{
7546 int ret = 0;
7547 int crt_expected;
7548#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7549 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7550 ? ssl->handshake->sni_authmode
7551 : ssl->conf->authmode;
7552#else
7553 const int authmode = ssl->conf->authmode;
7554#endif
7555 void *rs_ctx = NULL;
7556 mbedtls_x509_crt *chain = NULL;
7557
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007559
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7561 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7562 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007563 goto exit;
7564 }
7565
7566#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007567 if (ssl->handshake->ecrs_enabled &&
7568 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007569 chain = ssl->handshake->ecrs_peer_cert;
7570 ssl->handshake->ecrs_peer_cert = NULL;
7571 goto crt_verify;
7572 }
7573#endif
7574
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007576 /* mbedtls_ssl_read_record may have sent an alert already. We
7577 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007579 goto exit;
7580 }
7581
7582#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007584 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7585
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007587 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 }
Jerry Yud9526692022-02-17 14:23:47 +08007589
7590 goto exit;
7591 }
7592#endif /* MBEDTLS_SSL_SRV_C */
7593
7594 /* Clear existing peer CRT structure in case we tried to
7595 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007596 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007597
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7599 if (chain == NULL) {
7600 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7601 sizeof(mbedtls_x509_crt)));
7602 mbedtls_ssl_send_alert_message(ssl,
7603 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7604 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007605
7606 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7607 goto exit;
7608 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007610
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 ret = ssl_parse_certificate_chain(ssl, chain);
7612 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007613 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 }
Jerry Yud9526692022-02-17 14:23:47 +08007615
7616#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007617 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007618 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 }
Jerry Yud9526692022-02-17 14:23:47 +08007620
7621crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007623 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 }
Jerry Yud9526692022-02-17 14:23:47 +08007625#endif
7626
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 ret = ssl_parse_certificate_verify(ssl, authmode,
7628 chain, rs_ctx);
7629 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007630 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 }
Jerry Yud9526692022-02-17 14:23:47 +08007632
7633#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7634 {
7635 unsigned char *crt_start, *pk_start;
7636 size_t crt_len, pk_len;
7637
7638 /* We parse the CRT chain without copying, so
7639 * these pointers point into the input buffer,
7640 * and are hence still valid after freeing the
7641 * CRT chain. */
7642
7643 crt_start = chain->raw.p;
7644 crt_len = chain->raw.len;
7645
7646 pk_start = chain->pk_raw.p;
7647 pk_len = chain->pk_raw.len;
7648
7649 /* Free the CRT structures before computing
7650 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 mbedtls_x509_crt_free(chain);
7652 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007653 chain = NULL;
7654
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7656 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007657 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 }
Jerry Yud9526692022-02-17 14:23:47 +08007659
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7661 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007662 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007663 }
Jerry Yud9526692022-02-17 14:23:47 +08007664 }
7665#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7666 /* Pass ownership to session structure. */
7667 ssl->session_negotiate->peer_cert = chain;
7668 chain = NULL;
7669#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007672
7673exit:
7674
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007676 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 }
Jerry Yud9526692022-02-17 14:23:47 +08007678
7679#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007681 ssl->handshake->ecrs_peer_cert = chain;
7682 chain = NULL;
7683 }
7684#endif
7685
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 if (chain != NULL) {
7687 mbedtls_x509_crt_free(chain);
7688 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007689 }
7690
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007692}
7693#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7694
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007695#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007696static int ssl_calc_finished_tls_sha256(
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007698{
7699 int len = 12;
7700 const char *sender;
7701 unsigned char padbuf[32];
7702#if defined(MBEDTLS_USE_PSA_CRYPTO)
7703 size_t hash_size;
7704 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
7705 psa_status_t status;
7706#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007707 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007708 mbedtls_md_context_t sha256;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007709#endif
7710
7711 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007713 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007715
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007717 ? "client finished"
7718 : "server finished";
7719
7720#if defined(MBEDTLS_USE_PSA_CRYPTO)
7721 sha256_psa = psa_hash_operation_init();
7722
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls sha256"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007724
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 status = psa_hash_clone(&ssl->handshake->fin_sha256_psa, &sha256_psa);
7726 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007727 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007728 }
7729
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 status = psa_hash_finish(&sha256_psa, padbuf, sizeof(padbuf), &hash_size);
7731 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007732 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007733 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007734 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, 32);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007735#else
7736
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007737 mbedtls_md_init(&sha256);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007738
Gilles Peskine449bd832023-01-11 14:50:10 +01007739 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls sha256"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007740
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007741 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
7742 if (ret != 0) {
7743 goto exit;
7744 }
7745 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
7746 if (ret != 0) {
7747 goto exit;
7748 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007749
7750 /*
7751 * TLSv1.2:
7752 * hash = PRF( master, finished_label,
7753 * Hash( handshake ) )[0.11]
7754 */
7755
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007756 ret = mbedtls_md_finish(&sha256, padbuf);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007757 if (ret != 0) {
7758 goto exit;
7759 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007760#endif /* MBEDTLS_USE_PSA_CRYPTO */
7761
Manuel Pégourié-Gonnard0ac71c02023-02-24 12:13:55 +01007762 MBEDTLS_SSL_DEBUG_BUF(4, "finished sha256 output", padbuf, 32);
7763
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 ssl->handshake->tls_prf(session->master, 48, sender,
7765 padbuf, 32, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007766
Gilles Peskine449bd832023-01-11 14:50:10 +01007767 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007768
Gilles Peskine449bd832023-01-11 14:50:10 +01007769 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007770
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007772
7773exit:
7774#if defined(MBEDTLS_USE_PSA_CRYPTO)
7775 psa_hash_abort(&sha256_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05007776 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007777#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007778 mbedtls_md_free(&sha256);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007779 return ret;
7780#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007781}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007782#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007783
Jerry Yub7ba49e2022-02-17 14:25:53 +08007784
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007785#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007786static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007788{
7789 int len = 12;
7790 const char *sender;
7791 unsigned char padbuf[48];
7792#if defined(MBEDTLS_USE_PSA_CRYPTO)
7793 size_t hash_size;
7794 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
7795 psa_status_t status;
7796#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007797 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007798 mbedtls_md_context_t sha384;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007799#endif
7800
7801 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 if (!session) {
Jerry Yub7ba49e2022-02-17 14:25:53 +08007803 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007805
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007807 ? "client finished"
7808 : "server finished";
7809
7810#if defined(MBEDTLS_USE_PSA_CRYPTO)
7811 sha384_psa = psa_hash_operation_init();
7812
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls sha384"));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007814
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 status = psa_hash_clone(&ssl->handshake->fin_sha384_psa, &sha384_psa);
7816 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007817 goto exit;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007818 }
7819
Gilles Peskine449bd832023-01-11 14:50:10 +01007820 status = psa_hash_finish(&sha384_psa, padbuf, sizeof(padbuf), &hash_size);
7821 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007822 goto exit;
Jerry Yub7ba49e2022-02-17 14:25:53 +08007823 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007824 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, 48);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007825#else
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007826 mbedtls_md_init(&sha384);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007827
Gilles Peskine449bd832023-01-11 14:50:10 +01007828 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls sha384"));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007829
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007830 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007831 if (ret != 0) {
7832 goto exit;
7833 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007834 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007835 if (ret != 0) {
7836 goto exit;
7837 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007838
7839 /*
7840 * TLSv1.2:
7841 * hash = PRF( master, finished_label,
7842 * Hash( handshake ) )[0.11]
7843 */
7844
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007845 ret = mbedtls_md_finish(&sha384, padbuf);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007846 if (ret != 0) {
7847 goto exit;
7848 }
Jerry Yub7ba49e2022-02-17 14:25:53 +08007849#endif
7850
Manuel Pégourié-Gonnard0ac71c02023-02-24 12:13:55 +01007851 MBEDTLS_SSL_DEBUG_BUF(4, "finished sha384 output", padbuf, 48);
7852
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 ssl->handshake->tls_prf(session->master, 48, sender,
7854 padbuf, 48, buf, len);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007855
Gilles Peskine449bd832023-01-11 14:50:10 +01007856 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007857
Gilles Peskine449bd832023-01-11 14:50:10 +01007858 mbedtls_platform_zeroize(padbuf, sizeof(padbuf));
Jerry Yub7ba49e2022-02-17 14:25:53 +08007859
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007861
7862exit:
7863#if defined(MBEDTLS_USE_PSA_CRYPTO)
7864 psa_hash_abort(&sha384_psa);
Andrzej Kurekdaf5b562023-03-03 05:52:28 -05007865 return PSA_TO_MD_ERR(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007866#else
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01007867 mbedtls_md_free(&sha384);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007868 return ret;
7869#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yub7ba49e2022-02-17 14:25:53 +08007870}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007871#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007872
Gilles Peskine449bd832023-01-11 14:50:10 +01007873void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007874{
Gilles Peskine449bd832023-01-11 14:50:10 +01007875 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007876
7877 /*
7878 * Free our handshake params
7879 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 mbedtls_ssl_handshake_free(ssl);
7881 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007882 ssl->handshake = NULL;
7883
7884 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007885 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007886 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 if (ssl->transform) {
7888 mbedtls_ssl_transform_free(ssl->transform);
7889 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007890 }
7891 ssl->transform = ssl->transform_negotiate;
7892 ssl->transform_negotiate = NULL;
7893
Gilles Peskine449bd832023-01-11 14:50:10 +01007894 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007895}
7896
Gilles Peskine449bd832023-01-11 14:50:10 +01007897void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007898{
7899 int resume = ssl->handshake->resume;
7900
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007902
7903#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007904 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007905 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7906 ssl->renego_records_seen = 0;
7907 }
7908#endif
7909
7910 /*
7911 * Free the previous session and switch in the current one
7912 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007914#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7915 /* RFC 7366 3.1: keep the EtM state */
7916 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007917 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007918#endif
7919
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 mbedtls_ssl_session_free(ssl->session);
7921 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007922 }
7923 ssl->session = ssl->session_negotiate;
7924 ssl->session_negotiate = NULL;
7925
7926 /*
7927 * Add cache entry
7928 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007930 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 resume == 0) {
7932 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7933 ssl->session->id,
7934 ssl->session->id_len,
7935 ssl->session) != 0) {
7936 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7937 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007938 }
7939
7940#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7942 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007943 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007945
7946 /* Keep last flight around in case we need to resend it:
7947 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007948 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7949 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007950#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007952
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007953 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007954
Gilles Peskine449bd832023-01-11 14:50:10 +01007955 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007956}
7957
Gilles Peskine449bd832023-01-11 14:50:10 +01007958int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007959{
7960 int ret, hash_len;
7961
Gilles Peskine449bd832023-01-11 14:50:10 +01007962 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007963
Gilles Peskine449bd832023-01-11 14:50:10 +01007964 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007965
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007966 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7967 if (ret != 0) {
7968 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7969 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007970
7971 /*
7972 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7973 * may define some other value. Currently (early 2016), no defined
7974 * ciphersuite does this (and this is unlikely to change as activity has
7975 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7976 */
7977 hash_len = 12;
7978
7979#if defined(MBEDTLS_SSL_RENEGOTIATION)
7980 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007982#endif
7983
7984 ssl->out_msglen = 4 + hash_len;
7985 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7986 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7987
7988 /*
7989 * In case of session resuming, invert the client and server
7990 * ChangeCipherSpec messages order.
7991 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007992 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007993#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007995 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007996 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007997#endif
7998#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008000 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008002#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008004 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008006
8007 /*
8008 * Switch to our negotiated transform and session parameters for outbound
8009 * data.
8010 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008012
8013#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008015 unsigned char i;
8016
8017 /* Remember current epoch settings for resending */
8018 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8020 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008021
8022 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008024
8025
8026 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 for (i = 2; i > 0; i--) {
8028 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008029 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 }
8031 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008032
8033 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 if (i == 0) {
8035 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8036 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008037 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008039#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008040 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008041
8042 ssl->transform_out = ssl->transform_negotiate;
8043 ssl->session_out = ssl->session_negotiate;
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 mbedtls_ssl_send_flight_completed(ssl);
8048 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008049#endif
8050
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8052 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8053 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008054 }
8055
8056#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008057 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8058 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8059 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8060 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008061 }
8062#endif
8063
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008065
Gilles Peskine449bd832023-01-11 14:50:10 +01008066 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008067}
8068
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008069#define SSL_MAX_HASH_LEN 12
8070
Gilles Peskine449bd832023-01-11 14:50:10 +01008071int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008072{
8073 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8074 unsigned int hash_len = 12;
8075 unsigned char buf[SSL_MAX_HASH_LEN];
8076
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008078
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008079 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8080 if (ret != 0) {
8081 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8082 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008083
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8085 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008086 goto exit;
8087 }
8088
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8090 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8091 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8092 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008093 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8094 goto exit;
8095 }
8096
Gilles Peskine449bd832023-01-11 14:50:10 +01008097 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8098 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8099 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008100 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8101 goto exit;
8102 }
8103
Gilles Peskine449bd832023-01-11 14:50:10 +01008104 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8105 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8106 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8107 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008108 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8109 goto exit;
8110 }
8111
Gilles Peskine449bd832023-01-11 14:50:10 +01008112 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8113 buf, hash_len) != 0) {
8114 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8115 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8116 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008117 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8118 goto exit;
8119 }
8120
8121#if defined(MBEDTLS_SSL_RENEGOTIATION)
8122 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008123 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008124#endif
8125
Gilles Peskine449bd832023-01-11 14:50:10 +01008126 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008127#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008128 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008129 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008130 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008131#endif
8132#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008133 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008134 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008135 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008136#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008137 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008138 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008139 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008140
8141#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8143 mbedtls_ssl_recv_flight_completed(ssl);
8144 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008145#endif
8146
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008148
8149exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008150 mbedtls_platform_zeroize(buf, hash_len);
8151 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008152}
8153
Jerry Yu392112c2022-02-17 14:34:10 +08008154#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8155/*
8156 * Helper to get TLS 1.2 PRF from ciphersuite
8157 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8158 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008159static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008160{
Jerry Yu392112c2022-02-17 14:34:10 +08008161 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008162 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008163#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008164 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8165 return tls_prf_sha384;
8166 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008167#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008168#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008169 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008170 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8171 return tls_prf_sha256;
8172 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008173 }
8174#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008175#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8176 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008177 (void) ciphersuite_info;
8178#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008179
Gilles Peskine449bd832023-01-11 14:50:10 +01008180 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008181}
8182#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008183
Gilles Peskine449bd832023-01-11 14:50:10 +01008184static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008185{
8186 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008187#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 if (tls_prf == tls_prf_sha384) {
8189 return MBEDTLS_SSL_TLS_PRF_SHA384;
8190 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008191#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008192#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008193 if (tls_prf == tls_prf_sha256) {
8194 return MBEDTLS_SSL_TLS_PRF_SHA256;
8195 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008196#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008197 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008198}
8199
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008200/*
8201 * Populate a transform structure with session keys and all the other
8202 * necessary information.
8203 *
8204 * Parameters:
8205 * - [in/out]: transform: structure to populate
8206 * [in] must be just initialised with mbedtls_ssl_transform_init()
8207 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8208 * - [in] ciphersuite
8209 * - [in] master
8210 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008211 * - [in] tls_prf: pointer to PRF to use for key derivation
8212 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008213 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008214 * - [in] endpoint: client or server
8215 * - [in] ssl: used for:
8216 * - ssl->conf->{f,p}_export_keys
8217 * [in] optionally used for:
8218 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8219 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008220MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008221static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8222 int ciphersuite,
8223 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008224#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008225 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008226#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 ssl_tls_prf_t tls_prf,
8228 const unsigned char randbytes[64],
8229 mbedtls_ssl_protocol_version tls_version,
8230 unsigned endpoint,
8231 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008232{
8233 int ret = 0;
8234 unsigned char keyblk[256];
8235 unsigned char *key1;
8236 unsigned char *key2;
8237 unsigned char *mac_enc;
8238 unsigned char *mac_dec;
8239 size_t mac_key_len = 0;
8240 size_t iv_copy_len;
8241 size_t keylen;
8242 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008243 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008244#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008245 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008246 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008247#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008248
8249#if defined(MBEDTLS_USE_PSA_CRYPTO)
8250 psa_key_type_t key_type;
8251 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8252 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008253 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008254 size_t key_bits;
8255 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8256#endif
8257
8258#if !defined(MBEDTLS_DEBUG_C) && \
8259 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008260 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008261 ssl = NULL; /* make sure we don't use it except for these cases */
8262 (void) ssl;
8263 }
8264#endif
8265
8266 /*
8267 * Some data just needs copying into the structure
8268 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008269#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008270 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008271#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008272 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008273
8274#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008275 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008276#endif
8277
8278#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008280 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8281 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008282 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008283 }
8284#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8285
8286 /*
8287 * Get various info structures
8288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008289 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8290 if (ciphersuite_info == NULL) {
8291 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8292 ciphersuite));
8293 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008294 }
8295
Neil Armstrongab555e02022-04-04 11:07:59 +02008296 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008297#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008298 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008299#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008300 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008301
Gilles Peskine449bd832023-01-11 14:50:10 +01008302 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008303 transform->taglen =
8304 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008305 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008306
8307#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 if ((status = mbedtls_ssl_cipher_to_psa(ciphersuite_info->cipher,
8309 transform->taglen,
8310 &alg,
8311 &key_type,
8312 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008313 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008314 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008315 goto end;
8316 }
8317#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008318 cipher_info = mbedtls_cipher_info_from_type(ciphersuite_info->cipher);
8319 if (cipher_info == NULL) {
8320 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8321 ciphersuite_info->cipher));
8322 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008323 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008324#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008325
Neil Armstronge4512952022-03-08 09:08:22 +01008326#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 mac_alg = mbedtls_hash_info_psa_from_md(ciphersuite_info->mac);
8328 if (mac_alg == 0) {
8329 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_hash_info_psa_from_md for %u not found",
8330 (unsigned) ciphersuite_info->mac));
8331 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008332 }
8333#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008334 md_info = mbedtls_md_info_from_type(ciphersuite_info->mac);
8335 if (md_info == NULL) {
8336 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8337 (unsigned) ciphersuite_info->mac));
8338 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008339 }
Neil Armstronge4512952022-03-08 09:08:22 +01008340#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008341
8342#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8343 /* Copy own and peer's CID if the use of the CID
8344 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008345 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8346 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008347
8348 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008349 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8350 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8351 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008352
8353 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8355 ssl->handshake->peer_cid_len);
8356 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8357 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008358 }
8359#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8360
8361 /*
8362 * Compute key block using the PRF
8363 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008364 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8365 if (ret != 0) {
8366 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8367 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008368 }
8369
Gilles Peskine449bd832023-01-11 14:50:10 +01008370 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8371 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8372 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8373 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8374 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008375
8376 /*
8377 * Determine the appropriate key, IV and MAC length.
8378 */
8379
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008380#if defined(MBEDTLS_USE_PSA_CRYPTO)
8381 keylen = PSA_BITS_TO_BYTES(key_bits);
8382#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008383 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008384#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008385
8386#if defined(MBEDTLS_GCM_C) || \
8387 defined(MBEDTLS_CCM_C) || \
8388 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008389 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008390 size_t explicit_ivlen;
8391
8392 transform->maclen = 0;
8393 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008394
8395 /* All modes haves 96-bit IVs, but the length of the static parts vary
8396 * with mode and version:
8397 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8398 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8399 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8400 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8401 * sequence number).
8402 */
8403 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008404
8405 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008406#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008407 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008408#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008409 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8410 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008411#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008412
Gilles Peskine449bd832023-01-11 14:50:10 +01008413 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008414 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008415 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008416 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008417 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008418
8419 /* Minimum length of encrypted record */
8420 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8421 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008422 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008423#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8424#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008425 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008426 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008427 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008428#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008429 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008430#else
8431 size_t block_size = cipher_info->block_size;
8432#endif /* MBEDTLS_USE_PSA_CRYPTO */
8433
8434#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008435 /* Get MAC length */
8436 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8437#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008438 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008439 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8440 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8441 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008442 goto end;
8443 }
8444
8445 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008446 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008447#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008448 transform->maclen = mac_key_len;
8449
8450 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008451#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008453#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008454 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008455#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008456
8457 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008458 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008459 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008460 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008461 /*
8462 * GenericBlockCipher:
8463 * 1. if EtM is in use: one block plus MAC
8464 * otherwise: * first multiple of blocklen greater than maclen
8465 * 2. IV
8466 */
8467#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008469 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008470 + block_size;
8471 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008472#endif
8473 {
8474 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008475 + block_size
8476 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008477 }
8478
Gilles Peskine449bd832023-01-11 14:50:10 +01008479 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008480 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008481 } else {
8482 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008483 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8484 goto end;
8485 }
8486 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008487 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008488#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8489 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008490 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8491 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008492 }
8493
Gilles Peskine449bd832023-01-11 14:50:10 +01008494 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8495 (unsigned) keylen,
8496 (unsigned) transform->minlen,
8497 (unsigned) transform->ivlen,
8498 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008499
8500 /*
8501 * Finally setup the cipher contexts, IVs and MAC secrets.
8502 */
8503#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008505 key1 = keyblk + mac_key_len * 2;
8506 key2 = keyblk + mac_key_len * 2 + keylen;
8507
8508 mac_enc = keyblk;
8509 mac_dec = keyblk + mac_key_len;
8510
Gilles Peskine449bd832023-01-11 14:50:10 +01008511 iv_copy_len = (transform->fixed_ivlen) ?
8512 transform->fixed_ivlen : transform->ivlen;
8513 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8514 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8515 iv_copy_len);
8516 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008517#endif /* MBEDTLS_SSL_CLI_C */
8518#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008519 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008520 key1 = keyblk + mac_key_len * 2 + keylen;
8521 key2 = keyblk + mac_key_len * 2;
8522
8523 mac_enc = keyblk + mac_key_len;
8524 mac_dec = keyblk;
8525
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 iv_copy_len = (transform->fixed_ivlen) ?
8527 transform->fixed_ivlen : transform->ivlen;
8528 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8529 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8530 iv_copy_len);
8531 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008532#endif /* MBEDTLS_SSL_SRV_C */
8533 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008534 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008535 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8536 goto end;
8537 }
8538
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 if (ssl != NULL && ssl->f_export_keys != NULL) {
8540 ssl->f_export_keys(ssl->p_export_keys,
8541 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8542 master, 48,
8543 randbytes + 32,
8544 randbytes,
8545 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008546 }
8547
8548#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008549 transform->psa_alg = alg;
8550
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8552 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8553 psa_set_key_algorithm(&attributes, alg);
8554 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008555
Gilles Peskine449bd832023-01-11 14:50:10 +01008556 if ((status = psa_import_key(&attributes,
8557 key1,
8558 PSA_BITS_TO_BYTES(key_bits),
8559 &transform->psa_key_enc)) != PSA_SUCCESS) {
8560 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
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
Gilles Peskine449bd832023-01-11 14:50:10 +01008566 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008567
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 if ((status = psa_import_key(&attributes,
8569 key2,
8570 PSA_BITS_TO_BYTES(key_bits),
8571 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008572 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008573 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008574 goto end;
8575 }
8576 }
8577#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008578 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8579 cipher_info)) != 0) {
8580 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008581 goto end;
8582 }
8583
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8585 cipher_info)) != 0) {
8586 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008587 goto end;
8588 }
8589
Gilles Peskine449bd832023-01-11 14:50:10 +01008590 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8591 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8592 MBEDTLS_ENCRYPT)) != 0) {
8593 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008594 goto end;
8595 }
8596
Gilles Peskine449bd832023-01-11 14:50:10 +01008597 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8598 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8599 MBEDTLS_DECRYPT)) != 0) {
8600 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008601 goto end;
8602 }
8603
8604#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008605 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8606 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8607 MBEDTLS_PADDING_NONE)) != 0) {
8608 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008609 goto end;
8610 }
8611
Gilles Peskine449bd832023-01-11 14:50:10 +01008612 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8613 MBEDTLS_PADDING_NONE)) != 0) {
8614 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008615 goto end;
8616 }
8617 }
8618#endif /* MBEDTLS_CIPHER_MODE_CBC */
8619#endif /* MBEDTLS_USE_PSA_CRYPTO */
8620
Neil Armstrong29c0c042022-03-17 17:47:28 +01008621#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8622 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8623 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008624 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008625#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008626 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008627
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8629 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8630 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008631
Gilles Peskine449bd832023-01-11 14:50:10 +01008632 if ((status = psa_import_key(&attributes,
8633 mac_enc, mac_key_len,
8634 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008635 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008636 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008637 goto end;
8638 }
8639
Gilles Peskine449bd832023-01-11 14:50:10 +01008640 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8641 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008642#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008643 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008644#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008645 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008646 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008647 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8648 PSA_KEY_USAGE_VERIFY_HASH);
8649 } else {
8650 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8651 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008652
Gilles Peskine449bd832023-01-11 14:50:10 +01008653 if ((status = psa_import_key(&attributes,
8654 mac_dec, mac_key_len,
8655 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008656 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008657 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008658 goto end;
8659 }
8660#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008661 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8662 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008663 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008664 }
8665 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8666 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008667 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008668 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008669#endif /* MBEDTLS_USE_PSA_CRYPTO */
8670 }
8671#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8672
8673 ((void) mac_dec);
8674 ((void) mac_enc);
8675
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008676end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8678 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008679}
8680
Valerio Settia08b1a42022-11-17 15:10:02 +01008681#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8682 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008683int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008684 psa_pake_operation_t *pake_ctx,
8685 const unsigned char *buf,
8686 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008687{
8688 psa_status_t status;
8689 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008690 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008691 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8692 * At round two perform a single cycle
8693 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008694 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008695
Gilles Peskine449bd832023-01-11 14:50:10 +01008696 for (; remaining_steps > 0; remaining_steps--) {
8697 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008698 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008700 /* Length is stored at the first byte */
8701 size_t length = buf[input_offset];
8702 input_offset += 1;
8703
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008705 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8706 }
8707
Gilles Peskine449bd832023-01-11 14:50:10 +01008708 status = psa_pake_input(pake_ctx, step,
8709 buf + input_offset, length);
8710 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008711 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008712 }
8713
8714 input_offset += length;
8715 }
8716 }
8717
Gilles Peskine449bd832023-01-11 14:50:10 +01008718 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008719 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008720 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008721
Gilles Peskine449bd832023-01-11 14:50:10 +01008722 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008723}
8724
Valerio Setti6b3dab02022-11-17 17:14:54 +01008725int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008726 psa_pake_operation_t *pake_ctx,
8727 unsigned char *buf,
8728 size_t len, size_t *olen,
8729 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008730{
8731 psa_status_t status;
8732 size_t output_offset = 0;
8733 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008734 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008735 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8736 * At round two perform a single cycle
8737 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008738 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008739
Gilles Peskine449bd832023-01-11 14:50:10 +01008740 for (; remaining_steps > 0; remaining_steps--) {
8741 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8742 step <= PSA_PAKE_STEP_ZK_PROOF;
8743 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008744 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008745 * For each step, prepend 1 byte with the length of the data as
8746 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008747 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008748 status = psa_pake_output(pake_ctx, step,
8749 buf + output_offset + 1,
8750 len - output_offset - 1,
8751 &output_len);
8752 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008753 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008754 }
8755
Valerio Setti99d88c12022-11-22 16:03:43 +01008756 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008757
8758 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008759 }
8760 }
8761
8762 *olen = output_offset;
8763
Gilles Peskine449bd832023-01-11 14:50:10 +01008764 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008765}
Valerio Settia08b1a42022-11-17 15:10:02 +01008766#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8767
Jerry Yuee40f9d2022-02-17 14:55:16 +08008768#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008769int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8770 unsigned char *hash, size_t *hashlen,
8771 unsigned char *data, size_t data_len,
8772 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008773{
8774 psa_status_t status;
8775 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008776 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008777
Gilles Peskine449bd832023-01-11 14:50:10 +01008778 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008779
Gilles Peskine449bd832023-01-11 14:50:10 +01008780 if ((status = psa_hash_setup(&hash_operation,
8781 hash_alg)) != PSA_SUCCESS) {
8782 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008783 goto exit;
8784 }
8785
Gilles Peskine449bd832023-01-11 14:50:10 +01008786 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8787 64)) != PSA_SUCCESS) {
8788 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008789 goto exit;
8790 }
8791
Gilles Peskine449bd832023-01-11 14:50:10 +01008792 if ((status = psa_hash_update(&hash_operation,
8793 data, data_len)) != PSA_SUCCESS) {
8794 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008795 goto exit;
8796 }
8797
Gilles Peskine449bd832023-01-11 14:50:10 +01008798 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8799 hashlen)) != PSA_SUCCESS) {
8800 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8801 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008802 }
8803
8804exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008805 if (status != PSA_SUCCESS) {
8806 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8807 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8808 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008809 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008810 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008811 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8812 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008813 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008814 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008815 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008816 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008817 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008818 }
8819 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008820 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008821}
8822
8823#else
8824
Gilles Peskine449bd832023-01-11 14:50:10 +01008825int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8826 unsigned char *hash, size_t *hashlen,
8827 unsigned char *data, size_t data_len,
8828 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008829{
8830 int ret = 0;
8831 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008832 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8833 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008834
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008836
Gilles Peskine449bd832023-01-11 14:50:10 +01008837 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008838
8839 /*
8840 * digitally-signed struct {
8841 * opaque client_random[32];
8842 * opaque server_random[32];
8843 * ServerDHParams params;
8844 * };
8845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008846 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8847 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008848 goto exit;
8849 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008850 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8851 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008852 goto exit;
8853 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008854 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8855 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008856 goto exit;
8857 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008858 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8859 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008860 goto exit;
8861 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008862 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8863 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008864 goto exit;
8865 }
8866
8867exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008868 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008869
Gilles Peskine449bd832023-01-11 14:50:10 +01008870 if (ret != 0) {
8871 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8872 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8873 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008874
Gilles Peskine449bd832023-01-11 14:50:10 +01008875 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008876}
8877#endif /* MBEDTLS_USE_PSA_CRYPTO */
8878
Jerry Yud9d91da2022-02-17 14:57:06 +08008879#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8880
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008881/* Find the preferred hash for a given signature algorithm. */
8882unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008883 mbedtls_ssl_context *ssl,
8884 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008885{
Gabor Mezei078e8032022-04-27 21:17:56 +02008886 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008887 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008888
Gilles Peskine449bd832023-01-11 14:50:10 +01008889 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8890 return MBEDTLS_SSL_HASH_NONE;
8891 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008892
Gilles Peskine449bd832023-01-11 14:50:10 +01008893 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008894 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008895 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8896 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008897 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008898 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8899 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008900
Gilles Peskine449bd832023-01-11 14:50:10 +01008901 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008902#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008903 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008904 psa_algorithm_t psa_hash_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +01008905 mbedtls_hash_info_psa_from_md(hash_alg_received);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008906
Gilles Peskine449bd832023-01-11 14:50:10 +01008907 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8908 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8909 PSA_ALG_ECDSA(psa_hash_alg),
8910 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008911 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008912 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008913
Gilles Peskine449bd832023-01-11 14:50:10 +01008914 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8915 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8916 PSA_ALG_RSA_PKCS1V15_SIGN(
8917 psa_hash_alg),
8918 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008919 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008920 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008921 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008922#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008923
Gilles Peskine449bd832023-01-11 14:50:10 +01008924 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008925 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008926 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008927
Gilles Peskine449bd832023-01-11 14:50:10 +01008928 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008929}
8930
8931#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8932
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008933/* Serialization of TLS 1.2 sessions:
8934 *
8935 * struct {
8936 * uint64 start_time;
8937 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008938 * uint8 session_id_len; // at most 32
8939 * opaque session_id[32];
8940 * opaque master[48]; // fixed length in the standard
8941 * uint32 verify_result;
8942 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8943 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8944 * uint32 ticket_lifetime;
8945 * uint8 mfl_code; // up to 255 according to standard
8946 * uint8 encrypt_then_mac; // 0 or 1
8947 * } serialized_session_tls12;
8948 *
8949 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008950static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8951 unsigned char *buf,
8952 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008953{
8954 unsigned char *p = buf;
8955 size_t used = 0;
8956
8957#if defined(MBEDTLS_HAVE_TIME)
8958 uint64_t start;
8959#endif
8960#if defined(MBEDTLS_X509_CRT_PARSE_C)
8961#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8962 size_t cert_len;
8963#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8964#endif /* MBEDTLS_X509_CRT_PARSE_C */
8965
8966 /*
8967 * Time
8968 */
8969#if defined(MBEDTLS_HAVE_TIME)
8970 used += 8;
8971
Gilles Peskine449bd832023-01-11 14:50:10 +01008972 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008973 start = (uint64_t) session->start;
8974
Gilles Peskine449bd832023-01-11 14:50:10 +01008975 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008976 p += 8;
8977 }
8978#endif /* MBEDTLS_HAVE_TIME */
8979
8980 /*
8981 * Basic mandatory fields
8982 */
8983 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008984 + 1 /* id_len */
8985 + sizeof(session->id)
8986 + sizeof(session->master)
8987 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008988
Gilles Peskine449bd832023-01-11 14:50:10 +01008989 if (used <= buf_len) {
8990 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008991 p += 2;
8992
Gilles Peskine449bd832023-01-11 14:50:10 +01008993 *p++ = MBEDTLS_BYTE_0(session->id_len);
8994 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008995 p += 32;
8996
Gilles Peskine449bd832023-01-11 14:50:10 +01008997 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008998 p += 48;
8999
Gilles Peskine449bd832023-01-11 14:50:10 +01009000 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009001 p += 4;
9002 }
9003
9004 /*
9005 * Peer's end-entity certificate
9006 */
9007#if defined(MBEDTLS_X509_CRT_PARSE_C)
9008#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01009009 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009010 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01009011 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009012 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009013 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009014
9015 used += 3 + cert_len;
9016
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 if (used <= buf_len) {
9018 *p++ = MBEDTLS_BYTE_2(cert_len);
9019 *p++ = MBEDTLS_BYTE_1(cert_len);
9020 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009021
Gilles Peskine449bd832023-01-11 14:50:10 +01009022 if (session->peer_cert != NULL) {
9023 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009024 p += cert_len;
9025 }
9026 }
9027#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01009028 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009029 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009030 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009031 *p++ = (unsigned char) session->peer_cert_digest_type;
9032 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009033 memcpy(p, session->peer_cert_digest,
9034 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009035 p += session->peer_cert_digest_len;
9036 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009037 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009038 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009039 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009040 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9041 *p++ = 0;
9042 }
9043 }
9044#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9045#endif /* MBEDTLS_X509_CRT_PARSE_C */
9046
9047 /*
9048 * Session ticket if any, plus associated data
9049 */
9050#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9051 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9052
Gilles Peskine449bd832023-01-11 14:50:10 +01009053 if (used <= buf_len) {
9054 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9055 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9056 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009057
Gilles Peskine449bd832023-01-11 14:50:10 +01009058 if (session->ticket != NULL) {
9059 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009060 p += session->ticket_len;
9061 }
9062
Gilles Peskine449bd832023-01-11 14:50:10 +01009063 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009064 p += 4;
9065 }
9066#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9067
9068 /*
9069 * Misc extension-related info
9070 */
9071#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9072 used += 1;
9073
Gilles Peskine449bd832023-01-11 14:50:10 +01009074 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009075 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009076 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009077#endif
9078
9079#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9080 used += 1;
9081
Gilles Peskine449bd832023-01-11 14:50:10 +01009082 if (used <= buf_len) {
9083 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9084 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009085#endif
9086
Gilles Peskine449bd832023-01-11 14:50:10 +01009087 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009088}
9089
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009090MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009091static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9092 const unsigned char *buf,
9093 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009094{
9095#if defined(MBEDTLS_HAVE_TIME)
9096 uint64_t start;
9097#endif
9098#if defined(MBEDTLS_X509_CRT_PARSE_C)
9099#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9100 size_t cert_len;
9101#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9102#endif /* MBEDTLS_X509_CRT_PARSE_C */
9103
9104 const unsigned char *p = buf;
9105 const unsigned char * const end = buf + len;
9106
9107 /*
9108 * Time
9109 */
9110#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009111 if (8 > (size_t) (end - p)) {
9112 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9113 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009114
Gilles Peskine449bd832023-01-11 14:50:10 +01009115 start = ((uint64_t) p[0] << 56) |
9116 ((uint64_t) p[1] << 48) |
9117 ((uint64_t) p[2] << 40) |
9118 ((uint64_t) p[3] << 32) |
9119 ((uint64_t) p[4] << 24) |
9120 ((uint64_t) p[5] << 16) |
9121 ((uint64_t) p[6] << 8) |
9122 ((uint64_t) p[7]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009123 p += 8;
9124
9125 session->start = (time_t) start;
9126#endif /* MBEDTLS_HAVE_TIME */
9127
9128 /*
9129 * Basic mandatory fields
9130 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009131 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9132 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9133 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009134
Gilles Peskine449bd832023-01-11 14:50:10 +01009135 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009136 p += 2;
9137
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009138 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009139 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009140 p += 32;
9141
Gilles Peskine449bd832023-01-11 14:50:10 +01009142 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009143 p += 48;
9144
Gilles Peskine449bd832023-01-11 14:50:10 +01009145 session->verify_result = ((uint32_t) p[0] << 24) |
9146 ((uint32_t) p[1] << 16) |
9147 ((uint32_t) p[2] << 8) |
9148 ((uint32_t) p[3]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009149 p += 4;
9150
9151 /* Immediately clear invalid pointer values that have been read, in case
9152 * we exit early before we replaced them with valid ones. */
9153#if defined(MBEDTLS_X509_CRT_PARSE_C)
9154#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9155 session->peer_cert = NULL;
9156#else
9157 session->peer_cert_digest = NULL;
9158#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9159#endif /* MBEDTLS_X509_CRT_PARSE_C */
9160#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9161 session->ticket = NULL;
9162#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9163
9164 /*
9165 * Peer certificate
9166 */
9167#if defined(MBEDTLS_X509_CRT_PARSE_C)
9168#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9169 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009170 if (3 > (size_t) (end - p)) {
9171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9172 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009173
Gilles Peskine449bd832023-01-11 14:50:10 +01009174 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009175 p += 3;
9176
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009178 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9179
Gilles Peskine449bd832023-01-11 14:50:10 +01009180 if (cert_len > (size_t) (end - p)) {
9181 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9182 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009183
Gilles Peskine449bd832023-01-11 14:50:10 +01009184 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009185
Gilles Peskine449bd832023-01-11 14:50:10 +01009186 if (session->peer_cert == NULL) {
9187 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9188 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009189
Gilles Peskine449bd832023-01-11 14:50:10 +01009190 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009191
Gilles Peskine449bd832023-01-11 14:50:10 +01009192 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9193 p, cert_len)) != 0) {
9194 mbedtls_x509_crt_free(session->peer_cert);
9195 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009196 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009197 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009198 }
9199
9200 p += cert_len;
9201 }
9202#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9203 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009204 if (2 > (size_t) (end - p)) {
9205 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9206 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009207
9208 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9209 session->peer_cert_digest_len = (size_t) *p++;
9210
Gilles Peskine449bd832023-01-11 14:50:10 +01009211 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009212 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009213 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9214 if (md_info == NULL) {
9215 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9216 }
9217 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9218 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9219 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009220
Gilles Peskine449bd832023-01-11 14:50:10 +01009221 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9222 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9223 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009224
9225 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009226 mbedtls_calloc(1, session->peer_cert_digest_len);
9227 if (session->peer_cert_digest == NULL) {
9228 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9229 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009230
Gilles Peskine449bd832023-01-11 14:50:10 +01009231 memcpy(session->peer_cert_digest, p,
9232 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009233 p += session->peer_cert_digest_len;
9234 }
9235#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9236#endif /* MBEDTLS_X509_CRT_PARSE_C */
9237
9238 /*
9239 * Session ticket and associated data
9240 */
9241#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009242 if (3 > (size_t) (end - p)) {
9243 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9244 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009245
Gilles Peskine449bd832023-01-11 14:50:10 +01009246 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009247 p += 3;
9248
Gilles Peskine449bd832023-01-11 14:50:10 +01009249 if (session->ticket_len != 0) {
9250 if (session->ticket_len > (size_t) (end - p)) {
9251 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9252 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009253
Gilles Peskine449bd832023-01-11 14:50:10 +01009254 session->ticket = mbedtls_calloc(1, session->ticket_len);
9255 if (session->ticket == NULL) {
9256 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9257 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009258
Gilles Peskine449bd832023-01-11 14:50:10 +01009259 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009260 p += session->ticket_len;
9261 }
9262
Gilles Peskine449bd832023-01-11 14:50:10 +01009263 if (4 > (size_t) (end - p)) {
9264 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9265 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009266
Gilles Peskine449bd832023-01-11 14:50:10 +01009267 session->ticket_lifetime = ((uint32_t) p[0] << 24) |
9268 ((uint32_t) p[1] << 16) |
9269 ((uint32_t) p[2] << 8) |
9270 ((uint32_t) p[3]);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009271 p += 4;
9272#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9273
9274 /*
9275 * Misc extension-related info
9276 */
9277#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009278 if (1 > (size_t) (end - p)) {
9279 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9280 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009281
9282 session->mfl_code = *p++;
9283#endif
9284
9285#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009286 if (1 > (size_t) (end - p)) {
9287 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9288 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009289
9290 session->encrypt_then_mac = *p++;
9291#endif
9292
9293 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009294 if (p != end) {
9295 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9296 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009297
Gilles Peskine449bd832023-01-11 14:50:10 +01009298 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009299}
Jerry Yudc7bd172022-02-17 13:44:15 +08009300#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9301
XiaokangQian75d40ef2022-04-20 11:05:24 +00009302int mbedtls_ssl_validate_ciphersuite(
9303 const mbedtls_ssl_context *ssl,
9304 const mbedtls_ssl_ciphersuite_t *suite_info,
9305 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009306 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009307{
9308 (void) ssl;
9309
Gilles Peskine449bd832023-01-11 14:50:10 +01009310 if (suite_info == NULL) {
9311 return -1;
9312 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009313
Gilles Peskine449bd832023-01-11 14:50:10 +01009314 if ((suite_info->min_tls_version > max_tls_version) ||
9315 (suite_info->max_tls_version < min_tls_version)) {
9316 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009317 }
9318
XiaokangQian060d8672022-04-21 09:24:56 +00009319#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009320#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009321#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009322 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9323 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009324#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009325 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9326 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009327#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009328 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009329 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009330 }
9331#endif
9332
9333 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9334#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009335 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9336 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9337 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009338 }
9339#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9340#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9341
Gilles Peskine449bd832023-01-11 14:50:10 +01009342 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009343}
9344
Ronald Crone68ab4f2022-10-05 12:46:29 +02009345#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009346/*
9347 * Function for writing a signature algorithm extension.
9348 *
9349 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9350 * value (TLS 1.3 RFC8446):
9351 * enum {
9352 * ....
9353 * ecdsa_secp256r1_sha256( 0x0403 ),
9354 * ecdsa_secp384r1_sha384( 0x0503 ),
9355 * ecdsa_secp521r1_sha512( 0x0603 ),
9356 * ....
9357 * } SignatureScheme;
9358 *
9359 * struct {
9360 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9361 * } SignatureSchemeList;
9362 *
9363 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9364 * value (TLS 1.2 RFC5246):
9365 * enum {
9366 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9367 * sha512(6), (255)
9368 * } HashAlgorithm;
9369 *
9370 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9371 * SignatureAlgorithm;
9372 *
9373 * struct {
9374 * HashAlgorithm hash;
9375 * SignatureAlgorithm signature;
9376 * } SignatureAndHashAlgorithm;
9377 *
9378 * SignatureAndHashAlgorithm
9379 * supported_signature_algorithms<2..2^16-2>;
9380 *
9381 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9382 * generalization of the TLS 1.2 signature algorithm extension.
9383 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9384 * `SignatureScheme` field of TLS 1.3
9385 *
9386 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009387int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9388 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009389{
9390 unsigned char *p = buf;
9391 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9392 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9393
9394 *out_len = 0;
9395
Gilles Peskine449bd832023-01-11 14:50:10 +01009396 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009397
9398 /* Check if we have space for header and length field:
9399 * - extension_type (2 bytes)
9400 * - extension_data_length (2 bytes)
9401 * - supported_signature_algorithms_length (2 bytes)
9402 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009403 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009404 p += 6;
9405
9406 /*
9407 * Write supported_signature_algorithms
9408 */
9409 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009410 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9411 if (sig_alg == NULL) {
9412 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9413 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009414
Gilles Peskine449bd832023-01-11 14:50:10 +01009415 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9416 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9417 *sig_alg,
9418 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9419 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009420 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009421 }
9422 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9423 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009424 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009425 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9426 *sig_alg,
9427 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009428 }
9429
9430 /* Length of supported_signature_algorithms */
9431 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009432 if (supported_sig_alg_len == 0) {
9433 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9434 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009435 }
9436
Gilles Peskine449bd832023-01-11 14:50:10 +01009437 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9438 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9439 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009440
XiaokangQianeaf36512022-04-24 09:07:44 +00009441 *out_len = p - buf;
9442
9443#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009444 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009445#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009446
Gilles Peskine449bd832023-01-11 14:50:10 +01009447 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009448}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009449#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009450
XiaokangQian40a35232022-05-07 09:02:40 +00009451#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009452/*
9453 * mbedtls_ssl_parse_server_name_ext
9454 *
9455 * Structure of server_name extension:
9456 *
9457 * enum {
9458 * host_name(0), (255)
9459 * } NameType;
9460 * opaque HostName<1..2^16-1>;
9461 *
9462 * struct {
9463 * NameType name_type;
9464 * select (name_type) {
9465 * case host_name: HostName;
9466 * } name;
9467 * } ServerName;
9468 * struct {
9469 * ServerName server_name_list<1..2^16-1>
9470 * } ServerNameList;
9471 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009472MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009473int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9474 const unsigned char *buf,
9475 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009476{
9477 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9478 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009479 size_t server_name_list_len, hostname_len;
9480 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009481
Gilles Peskine449bd832023-01-11 14:50:10 +01009482 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009483
Gilles Peskine449bd832023-01-11 14:50:10 +01009484 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9485 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009486 p += 2;
9487
Gilles Peskine449bd832023-01-11 14:50:10 +01009488 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009489 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009490 while (p < server_name_list_end) {
9491 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9492 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9493 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9494 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009495
Gilles Peskine449bd832023-01-11 14:50:10 +01009496 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009497 /* sni_name is intended to be used only during the parsing of the
9498 * ClientHello message (it is reset to NULL before the end of
9499 * the message parsing). Thus it is ok to just point to the
9500 * reception buffer and not make a copy of it.
9501 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009502 ssl->handshake->sni_name = p + 3;
9503 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009504 if (ssl->conf->f_sni == NULL) {
9505 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009506 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009507 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9508 ssl, p + 3, hostname_len);
9509 if (ret != 0) {
9510 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9511 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9512 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9513 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9514 }
9515 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009516 }
9517
9518 p += hostname_len + 3;
9519 }
9520
Gilles Peskine449bd832023-01-11 14:50:10 +01009521 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009522}
9523#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9524
XiaokangQianacb39922022-06-17 10:18:48 +00009525#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009526MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009527int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9528 const unsigned char *buf,
9529 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009530{
9531 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009532 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009533 const unsigned char *protocol_name_list;
9534 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009535 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009536
9537 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009538 if (ssl->conf->alpn_list == NULL) {
9539 return 0;
9540 }
XiaokangQianacb39922022-06-17 10:18:48 +00009541
9542 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009543 * RFC7301, section 3.1
9544 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009545 *
XiaokangQianc7403452022-06-23 03:24:12 +00009546 * struct {
9547 * ProtocolName protocol_name_list<2..2^16-1>
9548 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009549 */
9550
XiaokangQianc7403452022-06-23 03:24:12 +00009551 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009552 * protocol_name_list_len 2 bytes
9553 * protocol_name_len 1 bytes
9554 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009555 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009556 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009557
Gilles Peskine449bd832023-01-11 14:50:10 +01009558 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009559 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009560 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009561 protocol_name_list = p;
9562 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009563
9564 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009565 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009566 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009567 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9568 protocol_name_len);
9569 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009570 MBEDTLS_SSL_PEND_FATAL_ALERT(
9571 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009572 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9573 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009574 }
9575
9576 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009577 }
9578
9579 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009580 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9581 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009582 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009583 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009584 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009585 if (protocol_name_len == alpn_len &&
9586 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009587 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009588 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009589 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009590
9591 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009592 }
9593 }
9594
XiaokangQian95d5f542022-06-24 02:29:26 +00009595 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009596 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009597 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9598 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9599 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009600}
9601
Gilles Peskine449bd832023-01-11 14:50:10 +01009602int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9603 unsigned char *buf,
9604 unsigned char *end,
9605 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009606{
9607 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009608 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009609 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009610
Gilles Peskine449bd832023-01-11 14:50:10 +01009611 if (ssl->alpn_chosen == NULL) {
9612 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009613 }
9614
Gilles Peskine449bd832023-01-11 14:50:10 +01009615 protocol_name_len = strlen(ssl->alpn_chosen);
9616 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009617
Gilles Peskine449bd832023-01-11 14:50:10 +01009618 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009619 /*
9620 * 0 . 1 ext identifier
9621 * 2 . 3 ext length
9622 * 4 . 5 protocol list length
9623 * 6 . 6 protocol name length
9624 * 7 . 7+n protocol name
9625 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009626 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009627
XiaokangQian95d5f542022-06-24 02:29:26 +00009628 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009629
Gilles Peskine449bd832023-01-11 14:50:10 +01009630 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9631 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009632 /* Note: the length of the chosen protocol has been checked to be less
9633 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9634 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009635 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009636
Gilles Peskine449bd832023-01-11 14:50:10 +01009637 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009638
9639#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009640 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009641#endif
9642
Gilles Peskine449bd832023-01-11 14:50:10 +01009643 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009644}
9645#endif /* MBEDTLS_SSL_ALPN */
9646
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009647#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009648 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009649 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009650 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009651int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9652 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009653{
9654 /* Initialize to suppress unnecessary compiler warning */
9655 size_t hostname_len = 0;
9656
9657 /* Check if new hostname is valid before
9658 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009659 if (hostname != NULL) {
9660 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009661
Gilles Peskine449bd832023-01-11 14:50:10 +01009662 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9663 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9664 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009665 }
9666
9667 /* Now it's clear that we will overwrite the old hostname,
9668 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009669 if (session->hostname != NULL) {
9670 mbedtls_platform_zeroize(session->hostname,
9671 strlen(session->hostname));
9672 mbedtls_free(session->hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009673 }
9674
9675 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009676 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009677 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009678 } else {
9679 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9680 if (session->hostname == NULL) {
9681 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9682 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009683
Gilles Peskine449bd832023-01-11 14:50:10 +01009684 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009685 }
9686
Gilles Peskine449bd832023-01-11 14:50:10 +01009687 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009688}
Xiaokang Qian03409292022-10-12 02:49:52 +00009689#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9690 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009691 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009692 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009693
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009694#endif /* MBEDTLS_SSL_TLS_C */